feat: initial implementation of cdk-specific project types (#1)

* feat: initial implementation of cdk-specific project types

* update projen

* move all cdklabs related things into cdklabs.ts

* syling changes

* snapshots

Author: kaizencc

.projen/deps.json

@@ -1,14 +1,12 @@
-const { cdk } = require("projen");
+const { cdk } = require('projen');
 const project = new cdk.JsiiProject({
-  author: "AWS",
-  authorAddress: "[email protected]",
-  defaultReleaseBranch: "main",
-  name: "cdklabs-projen-project-types",
-  repositoryUrl: "https://github.com/cdklabs/cdklabs-projen-project-types.git",
-
-  // deps: [],                /* Runtime dependencies of this module. */
-  // description: undefined,  /* The description is just a string that helps people understand the purpose of the package. */
-  // devDeps: [],             /* Build dependencies for this module. */
-  // packageName: undefined,  /* The "name" in package.json. */
+  author: 'AWS',
+  authorAddress: '[email protected]',
+  defaultReleaseBranch: 'main',
+  name: 'cdklabs-projen-project-types',
+  repositoryUrl: 'https://github.com/cdklabs/cdklabs-projen-project-types.git',
+  deps: ['projen'],
+  bundledDeps: ['yaml'],
+  peerDeps: ['projen'],
 });
 project.synth();

.projenrc.js

@@ -0,0 +1,88 @@
+import { awscdk, typescript } from 'projen';
+import { Stability } from 'projen/lib/cdk';
+import { Private } from './private';
+
+export interface CdkConstructLibraryOptions extends awscdk.AwsCdkConstructLibraryOptions {
+  /**
+   * Whether or not this package is private. Setting this variable
+   * to true means that your project is created with sane defaults
+   * for private repositories.
+   *
+   * @default true
+   */
+  readonly private?: boolean;
+}
+
+/**
+ * Create a Cdk Construct Library Project
+ *
+ * @pjid cdk-construct-lib
+ */
+export class CdkConstructLibrary extends awscdk.AwsCdkConstructLibrary {
+  private static stabilityRequirements(options: CdkConstructLibraryOptions): string[] {
+    const errors: string[] = [];
+    if (!options.publishToPypi) {
+      errors.push('Publishing Error: project not configured to publish to Python');
+    }
+    if (!options.publishToMaven) {
+      errors.push('Publishing Error: project not configured to publish to Maven');
+    }
+    if (!options.publishToNuget) {
+      errors.push('Publishing Error: project not configured to publish to Nuget');
+    }
+    if (!options.publishToGo) {
+      errors.push('Publishing Error: project not configured to publish to Go');
+    }
+    return errors;
+  }
+
+  public readonly private: boolean;
+
+  constructor(options: CdkConstructLibraryOptions) {
+    if (options.stability === Stability.STABLE) {
+      const errors = CdkConstructLibrary.stabilityRequirements(options);
+      if (errors.length > 0) {
+        throw new Error(`The project does not pass stability requirements due to the following errors:\n  ${errors.join('\n  ')}`);
+      }
+    }
+
+    super({
+      stability: Stability.EXPERIMENTAL,
+      ...options,
+    });
+
+    this.private = options.private ?? true;
+
+    if (this.private) {
+      new Private(this);
+    }
+  }
+}
+
+export interface CdkTypeScriptProjectOptions extends typescript.TypeScriptProjectOptions {
+  /**
+   * Whether or not this module is private. Setting this variable
+   * to true means that your project is created with sane defaults
+   * for private repositories.
+   *
+   * @default true
+   */
+  readonly private?: boolean;
+}
+
+/**
+ * Create a Cdk TypeScript Project
+ *
+ * @pjid cdk-ts-proj
+ */
+export class CdkTypeScriptProject extends typescript.TypeScriptProject {
+  public readonly private: boolean;
+
+  constructor(options: CdkTypeScriptProjectOptions) {
+    super(options);
+    this.private = options.private ?? true;
+    if (this.private) {
+      new Private(this);
+    }
+  }
+}

API.md

@@ -0,0 +1,65 @@
+import { UpdateSnapshot } from 'projen/lib/javascript';
+import {
+  CdkConstructLibrary,
+  CdkConstructLibraryOptions,
+  CdkTypeScriptProject,
+  CdkTypeScriptProjectOptions,
+} from './cdk';
+
+// override these properties no matter what values are given client-side
+const cdklabsForcedProps = {
+  author: 'Amazon Web Services',
+  authorName: 'Amazon Web Services',
+  authorAddress: '[email protected]',
+  authorEmail: '[email protected]',
+  authorOrganization: true,
+};
+
+const cdklabsDefaultProps = {
+  autoApproveUpgrades: true,
+  autoApproveOptions: {
+    allowedUsernames: ['cdklabs-automation'],
+    secret: 'GITHUB_TOKEN',
+  },
+  minNodeVersion: '14.17.0',
+  jestOptions: {
+    updateSnapshot: UpdateSnapshot.NEVER,
+  },
+  defaultReleaseBranch: 'main',
+};
+
+export interface CdklabsConstructLibraryOptions extends CdkConstructLibraryOptions {
+}
+
+/**
+ * Create a Cdklabs Construct Library Project
+ *
+ * @pjid cdklabs-construct-lib
+ */
+export class CdklabsConstructLibrary extends CdkConstructLibrary {
+  constructor(options: CdklabsConstructLibraryOptions) {
+    super({
+      ...cdklabsDefaultProps,
+      ...options,
+      ...cdklabsForcedProps,
+    });
+  }
+}
+
+export interface CdklabsTypeScriptProjectOptions extends CdkTypeScriptProjectOptions {
+}
+
+/**
+ * Create a Cdklabs TypeScript Project
+ *
+ * @pjid cdklabs-ts-proj
+ */
+export class CdklabsTypeScriptProject extends CdkTypeScriptProject {
+  constructor(options: CdklabsTypeScriptProjectOptions) {
+    super({
+      ...cdklabsDefaultProps,
+      ...options,
+      ...cdklabsForcedProps,
+    });
+  }
+}

package.json

@@ -1,5 +1,2 @@
-export class Hello {
-  public sayHello() {
-    return 'hello, world!';
-  }
-}
+export * from './cdk';
+export * from './cdklabs';

src/cdk.ts

@@ -0,0 +1,25 @@
+import { Component } from 'projen';
+import { TypeScriptProject } from 'projen/lib/typescript';
+
+/**
+ * The Private component is a one-stop shop for all things
+ * related to configuring a private repository. Instead of
+ * ensuring that the project options are configured in a
+ * "private" way, this component ensures that the output
+ * enforces all our rules for private repositories regardless
+ * of input.
+ */
+export class Private extends Component {
+  constructor(project: TypeScriptProject) {
+    super(project);
+
+    // mark private: true in package.json
+    project.addFields({ private: true });
+
+    // private repositories cannot have mergify configured.
+    project.tryRemoveFile('.mergify.yml');
+
+    // no need for npmignore file
+    project.tryRemoveFile('.npmignore');
+  }
+}