@alma-cdk/project 2.0.0 → 2.0.2

package/.jsii

@@ -9,7 +9,9 @@
   },
   "bundled": {
     "change-case": "^4.1.2",
-    "nunjucks": "^3.2.4"
+    "nunjucks": "^3.2.4",
+    "semver": "7",
+    "zod": "4"
   },
   "dependencies": {
     "aws-cdk-lib": "^2.220.0",
@@ -4086,7 +4088,7 @@
     "stability": "stable"
   },
   "homepage": "https://github.com/alma-cdk/project.git",
-  "jsiiVersion": "5.8.27 (build aebddcd)",
+  "jsiiVersion": "5.9.26 (build f85d3df)",
   "keywords": [
     "aws",
     "aws-cdk",
@@ -6752,6 +6754,6 @@
       "symbolId": "src/name/name-url:UrlName"
     }
   },
-  "version": "2.0.0",
-  "fingerprint": "rlB38JrVkt+f5KSI6kyN1tIHcBkEUqGZFspvi4npr8E="
+  "version": "2.0.2",
+  "fingerprint": "eu/OC7My4UaxAlEjNQXhNVUajTpejuZzEA0lqb8NU+k="
 }

package/AlmaCdkConstructLibrary/AlmaCdkConstructLibrary.ts

@@ -0,0 +1,115 @@
+import { awscdk, javascript } from "projen";
+import { SonarCloudReportWorkflow } from "./SonarCloudReportWorkflow";
+import { NodeConfig } from "./NodeConfig";
+import { UpdateSnapshot } from "projen/lib/javascript";
+import {
+  almaCdkConstructLibraryOptionsSchema,
+  type AlmaCdkConstructLibraryOptions,
+} from "./schemas/almaCdkConstructLibraryOptions";
+import { parseScopedPackageName } from "./schemas/name";
+
+export type { AlmaCdkConstructLibraryOptions } from "./schemas/almaCdkConstructLibraryOptions";
+
+const CDK_VERSION = "2.220.0";
+const CONSTRUCTS_VERSION = "10.3.0";
+const JSII_VERSION = "~5.9.0";
+const JEST_VERSION = "^30";
+
+export class AlmaCdkConstructLibrary extends awscdk.AwsCdkConstructLibrary {
+  public readonly workflowNodeVersion: string;
+
+  constructor(options: AlmaCdkConstructLibraryOptions) {
+    const validatedOptions =
+      almaCdkConstructLibraryOptionsSchema.parse(options);
+
+    const { scope: packageScope, packageName } = parseScopedPackageName(
+      validatedOptions.name,
+    );
+
+    const opts: awscdk.AwsCdkConstructLibraryOptions = {
+      ...validatedOptions,
+      // Package manager & projen
+      projenCommand: "pnpm exec projen",
+      authorOrganization: true,
+      defaultReleaseBranch: "main",
+      packageManager: javascript.NodePackageManager.PNPM,
+      npmAccess: javascript.NpmAccess.PUBLIC,
+      npmTrustedPublishing: true,
+      projenrcTs: true,
+      jsiiVersion: JSII_VERSION,
+      keywords: ["cdk", "aws-cdk", "awscdk", "aws"],
+      jestOptions: {
+        jestVersion: JEST_VERSION,
+        updateSnapshot: UpdateSnapshot.NEVER,
+      },
+      // Code quality (Prettier)
+      prettier: true,
+      prettierOptions: {
+        ignoreFileOptions: {
+          ignorePatterns: [
+            ".github/**/*",
+            ".projen/**/*",
+            ".vscode/**/*",
+            "coverage/**/*",
+            "dist/**/*",
+            "/*.*",
+            "!.projenrc.ts",
+          ],
+        },
+      },
+      // Publishing
+      publishToPypi: {
+        distName: `${packageScope}.${packageName}`,
+        module: `${packageScope.replace("-", "_")}.${packageName.replace("-", "_")}`,
+        trustedPublishing: true,
+      },
+      publishToGo: {
+        moduleName: `${validatedOptions.repositoryUrl.replace("https://", "").replace(".git", "")}-go`,
+      },
+      // CDK
+      cdkVersion: CDK_VERSION,
+      constructsVersion: CONSTRUCTS_VERSION,
+      // Git & dev
+      gitignore: [
+        ".DS_Store",
+        "/examples/**/cdk.context.json",
+        "/examples/**/node_modules",
+        "/examples/**/cdk.out",
+        "/examples/**/.git",
+        "TODO.md",
+        ".scannerwork/",
+        "**/*.drawio.bkp",
+        "**/*.afdesign~lock~",
+      ],
+      tsconfigDev: {
+        include: ["AlmaCdkConstructLibrary/**/*.ts"],
+      },
+    };
+
+    super(opts);
+
+    // Schema default ensures this is set
+    this.workflowNodeVersion = validatedOptions.workflowNodeVersion!;
+
+    this.addDevDeps("typescript@^5.9"); // Defaults to very old typescript@4.9
+    this.addDevDeps("@types/semver@^7");
+    this.addDevDeps("json-schema-to-typescript@^15");
+
+    this.addBundledDeps("zod@4");
+    this.addBundledDeps("semver@7");
+
+    this.addTask("format", {
+      exec: "prettier --write .",
+    });
+
+    this.addTask("generate:pnpm-workspace-types", {
+      description:
+        "Download pnpm-workspace JSON schema and generate pnpm-workspace-schema.d.ts",
+      exec: "ts-node scripts/generate-pnpm-workspace-types.ts",
+    });
+
+    new SonarCloudReportWorkflow(this);
+
+    new NodeConfig(this);
+  }
+}

package/AlmaCdkConstructLibrary/NodeConfig.ts

@@ -0,0 +1,35 @@
+import { TextFile, awscdk, YamlFile } from "projen";
+import { Duration } from "aws-cdk-lib";
+import { PnpmWorkspaceSpecification } from "./pnpm-workspace-schema";
+
+export interface NodeConfigOptions {
+  workflowNodeVersion: string;
+}
+
+export class NodeConfig {
+  /**
+   * @param project - The CDK construct library project; must expose `workflowNodeVersion` (e.g. AlmaCdkConstructLibrary).
+   */
+  constructor(project: awscdk.AwsCdkConstructLibrary & NodeConfigOptions) {
+    new TextFile(project, ".nvmrc", {
+      lines: [project.workflowNodeVersion],
+    });
+
+    new YamlFile(project, "pnpm-workspace.yaml", {
+      obj: {
+        minimumReleaseAge: Duration.days(3).toMinutes(),
+        trustPolicy: "no-downgrade",
+        trustPolicyIgnoreAfter: Duration.days(14).toMinutes(),
+        trustPolicyExclude: ["jsii@5.9.26"],
+        nodeLinker: "hoisted", // required for bundled deps
+        resolutionMode: "highest",
+        strictDepBuilds: true,
+        onlyBuiltDependencies: ["unrs-resolver"],  // allow unrs-resolver build scripts
+        blockExoticSubdeps: true,
+        overrides: {
+          "ajv@^8": "^8.18.0",
+        },
+      } as PnpmWorkspaceSpecification,
+    });
+  }
+}

package/AlmaCdkConstructLibrary/SonarCloudReportWorkflow.ts

@@ -0,0 +1,64 @@
+import { awscdk, TextFile } from "projen";
+import { WorkflowSteps } from "projen/lib/github";
+import { JobPermission } from "projen/lib/github/workflows-model";
+
+export class SonarCloudReportWorkflow {
+  constructor(project: awscdk.AwsCdkConstructLibrary) {
+    const sonarCloudReportWorkflow =
+      project.github?.addWorkflow("sonarcloud-report");
+
+    sonarCloudReportWorkflow?.on({
+      push: { branches: ["main", "beta"] },
+      pullRequest: {
+        types: ["opened", "synchronize", "reopened"],
+      },
+    });
+
+    sonarCloudReportWorkflow?.addJob("sonarcloud-report", {
+      runsOn: ["ubuntu-latest"],
+      permissions: {
+        contents: JobPermission.READ,
+      },
+      steps: [
+        WorkflowSteps.checkout({
+          with: {
+            fetchDepth: 0,
+          },
+        }),
+        ...project.renderWorkflowSetup(),
+        {
+          name: "Run tests",
+          run: "pnpm run test",
+        },
+        {
+          name: "SonarCloud Scan",
+          uses: "SonarSource/sonarqube-scan-action@v7",
+          env: {
+            GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}",
+            SONAR_TOKEN: "${{ secrets.SONAR_TOKEN }}",
+          },
+        },
+      ],
+    });
+
+    /**
+     * Sonarcloud properties file
+     */
+    new TextFile(project, "sonar-project.properties", {
+      lines: [
+        "sonar.host.url=https://sonarcloud.io",
+        `sonar.projectKey=${project.name.replace("@", "").replace("/", "_")}`,
+        `sonar.organization=${project.name.replace("@", "").split("/")[0]}`,
+        "sonar.javascript.lcov.reportPaths=./coverage/lcov.info",
+        "sonar.sources=./src",
+        "sonar.tests=./test",
+        "sonar.test.inclusions=**/*.test.*",
+        "sonar.issue.ignore.multicriteria=e1,e2",
+        "sonar.issue.ignore.multicriteria.e1.ruleKey=typescript:S1874",
+        "sonar.issue.ignore.multicriteria.e1.resourceKey=src/smartstack/tags/*.ts",
+        "sonar.issue.ignore.multicriteria.e2.ruleKey=typescript:S1874",
+        "sonar.issue.ignore.multicriteria.e2.resourceKey=src/project/deprecation-warnings.ts",
+      ],
+    });
+  }
+}

package/AlmaCdkConstructLibrary/index.ts

@@ -0,0 +1,4 @@
+export {
+  AlmaCdkConstructLibrary,
+  type AlmaCdkConstructLibraryOptions,
+} from "./AlmaCdkConstructLibrary";