forked from aws/aws-cdk
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor: L2 constructs should not use the "Token" type (awslint:prop…
…s-no-tokens) (aws#2542) Adds a new awslint:props-no-tokens rule which validates that props do not use the "Token" type. This is in accordance with the new AWS Construct Library guidelines. Fixes aws#2434
- Loading branch information
Showing
6 changed files
with
181 additions
and
81 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,129 @@ | ||
| import reflect = require("jsii-reflect"); | ||
| import { TypeSystem } from "jsii-reflect"; | ||
| import { getDocTag } from "./util"; | ||
|
|
||
| const CORE_MODULE = "@aws-cdk/cdk"; | ||
| enum CoreTypesFqn { | ||
| CfnResource = "@aws-cdk/cdk.CfnResource", | ||
| Construct = "@aws-cdk/cdk.Construct", | ||
| ConstructInterface = "@aws-cdk/cdk.IConstruct", | ||
| Resource = "@aws-cdk/cdk.Resource", | ||
| ResourceInterface = "@aws-cdk/cdk.IResource", | ||
| Token = "@aws-cdk/cdk.Token" | ||
| } | ||
|
|
||
| export class CoreTypes { | ||
|
|
||
| /** | ||
| * @returns true if assembly has the Core module | ||
| */ | ||
| public static hasCoreModule(assembly: reflect.Assembly) { | ||
| return (!assembly.system.assemblies.find(a => a.name === CORE_MODULE)); | ||
| } | ||
| /** | ||
| * @returns true if `classType` represents an L1 Cfn Resource | ||
| */ | ||
| public static isCfnResource(c: reflect.ClassType) { | ||
| if (!c.system.includesAssembly(CORE_MODULE)) { | ||
| return false; | ||
| } | ||
|
|
||
| // skip CfnResource itself | ||
| if (c.fqn === CoreTypesFqn.CfnResource) { | ||
| return false; | ||
| } | ||
|
|
||
| if (!this.isConstructClass(c)) { | ||
| return false; | ||
| } | ||
|
|
||
| const cfnResourceClass = c.system.findFqn(CoreTypesFqn.CfnResource); | ||
| if (!c.extends(cfnResourceClass)) { | ||
| return false; | ||
| } | ||
|
|
||
| if (!c.name.startsWith("Cfn")) { | ||
| return false; | ||
| } | ||
|
|
||
| return true; | ||
| } | ||
|
|
||
| /** | ||
| * @returns true if `classType` represents a Construct | ||
| */ | ||
| public static isConstructClass(c: reflect.ClassType) { | ||
| if (!c.system.includesAssembly(CORE_MODULE)) { | ||
| return false; | ||
| } | ||
|
|
||
| if (!c.isClassType()) { | ||
| return false; | ||
| } | ||
|
|
||
| if (c.abstract) { | ||
| return false; | ||
| } | ||
|
|
||
| return c.extends(c.system.findFqn(CoreTypesFqn.Construct)); | ||
| } | ||
|
|
||
| /** | ||
| * @returns true if `classType` represents an AWS resource (i.e. extends `cdk.Resource`). | ||
| */ | ||
| public static isResourceClass(classType: reflect.ClassType) { | ||
| const baseResource = classType.system.findClass(CoreTypesFqn.Resource); | ||
| return classType.extends(baseResource) || getDocTag(classType, "resource"); | ||
| } | ||
|
|
||
| /** | ||
| * @returns `classType` for the core type Construct | ||
| */ | ||
| public get constructClass() { | ||
| return this.sys.findClass(CoreTypesFqn.Construct); | ||
| } | ||
|
|
||
| /** | ||
| * @returns `interfacetype` for the core type Construct | ||
| */ | ||
| public get constructInterface() { | ||
| return this.sys.findInterface(CoreTypesFqn.ConstructInterface); | ||
| } | ||
|
|
||
| /** | ||
| * @returns `classType` for the core type Construct | ||
| */ | ||
| public get resourceClass() { | ||
| return this.sys.findClass(CoreTypesFqn.Resource); | ||
| } | ||
|
|
||
| /** | ||
| * @returns `interfaceType` for the core type Resource | ||
| */ | ||
| public get resourceInterface() { | ||
| return this.sys.findInterface(CoreTypesFqn.ResourceInterface); | ||
| } | ||
|
|
||
| /** | ||
| * @returns `classType` for the core type Token | ||
| */ | ||
| public get tokenClass() { | ||
| return this.sys.findClass(CoreTypesFqn.Token); | ||
| } | ||
|
|
||
| private readonly sys: TypeSystem; | ||
|
|
||
| constructor(sys: reflect.TypeSystem) { | ||
| this.sys = sys; | ||
| if (!sys.includesAssembly(CORE_MODULE)) { | ||
| // disable-all-checks | ||
| return; | ||
| } | ||
|
|
||
| for (const fqn of Object.values(CoreTypesFqn)) { | ||
| if (!this.sys.tryFindFqn(fqn)) { | ||
| throw new Error(`core FQN type not found: ${fqn}`); | ||
| } | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.