@rocketleap/rocketleap-projen 0.0.11 → 0.0.12

package/.jsii

@@ -95,7 +95,7 @@
   },
   "name": "@rocketleap/rocketleap-projen",
   "readme": {
-    "markdown": "# replace this\n"
+    "markdown": "# rocketleap-projen\n\nThis project provides projen templates to quickly set up CDK projects in the Rocketleap platform.\nIt automatically tracks the `building-blocks-cdk` making it easy to stay up to date.\n\n## Features\n\n- Pre-configured AWS CDK TypeScript project setup\n- Automatic dependency management for `building-blocks-cdk`\n- Standardized ESLint, Prettier, and Git configuration\n- Yarn Berry (v4) with private registry support\n- Pre-commit hooks for code quality\n\n## How to adopt\n\n### New project\n\nRun `projen new` to create a new project:\n\n```shell\nnpx projen new --from @rocketleap/rocketleap-projen --company \"<company>\" --project \"<project>\"\n```\n\n### Existing project\n\nExisting projects can adopt the projen templates and get managed by `projen`.\n\n1. Install the `rocketleap-projen` library and peer dependencies:\n\n   ```shell\n   yarn add -D @rocketleap/rocketleap-projen projen\n   ```\n\n2. Create or replace the `.projenrc.ts` file using the appropriate project type:\n\n   ```typescript\n   import { PlatformCdkProject } from '@rocketleap/rocketleap-projen';\n\n   const project = new PlatformCdkProject({\n     company: '<company>',\n     project: '<project>',\n   });\n\n   project.synth();\n   ```\n\n3. Run projen to generate the project configuration:\n\n   ```shell\n   npx ts-node .projenrc.ts\n   ```\n\n## Project Types\n\n### PlatformCdkProject\n\nUse for **platform infrastructure** code (e.g., root-cdk, vpc-cdk, iam-cdk, security-cdk).\n\n- Includes the Norberhuis Onderneming B.V. IaC License\n- For code that is part of the licensed platform\n\n```typescript\nimport { PlatformCdkProject } from '@rocketleap/rocketleap-projen';\n\nconst project = new PlatformCdkProject({\n  company: 'rocketleap',\n  project: 'root-cdk',\n});\n\nproject.synth();\n```\n\n### WorkloadCdkProject\n\nUse for **customer workload** code that runs on the platform.\n\n- Does NOT include the platform license\n- For customer-specific application infrastructure\n\n```typescript\nimport { WorkloadCdkProject } from '@rocketleap/rocketleap-projen';\n\nconst project = new WorkloadCdkProject({\n  company: 'acme',\n  project: 'my-app-cdk',\n});\n\nproject.synth();\n```\n\n### RocketleapCdkProject (Base)\n\nThe base class used by both project types. Can be used directly if you need custom license handling.\n\n## Options\n\n| Option                  | Required | Default     | Description                                     |\n| ----------------------- | -------- | ----------- | ----------------------------------------------- |\n| `company`               | Yes      | -           | The company identifier used for package scoping |\n| `project`               | Yes      | -           | The project name                                |\n| `cdkVersion`            | No       | `'2.232.1'` | The AWS CDK version to use                      |\n| `constructVersion`      | No       | `'10.4.4'`  | The constructs library version                  |\n| `buildingBlocksVersion` | No       | `'0.104.1'` | The Rocketleap building blocks CDK version      |\n"
   },
   "repository": {
     "type": "git",
@@ -145,40 +145,6 @@
     }
   },
   "types": {
-    "@rocketleap/rocketleap-projen.RocketleapCdkProject": {
-      "assembly": "@rocketleap/rocketleap-projen",
-      "base": "projen.awscdk.AwsCdkTypeScriptApp",
-      "docs": {
-        "remarks": "This project type generates a fully configured AWS CDK TypeScript application\nwith Rocketleap's standard configuration including ESLint, Prettier, Yarn Berry,\nand pre-commit hooks.",
-        "stability": "stable",
-        "summary": "A projen project for Rocketleap CDK projects."
-      },
-      "fqn": "@rocketleap/rocketleap-projen.RocketleapCdkProject",
-      "initializer": {
-        "docs": {
-          "stability": "stable"
-        },
-        "locationInModule": {
-          "filename": "src/cdk-project.ts",
-          "line": 21
-        },
-        "parameters": [
-          {
-            "name": "options",
-            "type": {
-              "fqn": "@rocketleap/rocketleap-projen.RocketleapCdkProjectOptions"
-            }
-          }
-        ]
-      },
-      "kind": "class",
-      "locationInModule": {
-        "filename": "src/cdk-project.ts",
-        "line": 20
-      },
-      "name": "RocketleapCdkProject",
-      "symbolId": "src/cdk-project:RocketleapCdkProject"
-    },
     "@rocketleap/rocketleap-projen.RocketleapCdkProjectOptions": {
       "assembly": "@rocketleap/rocketleap-projen",
       "datatype": true,
@@ -3626,8 +3592,182 @@
         }
       ],
       "symbolId": "src/cdk-project-options.generated:RocketleapCdkProjectOptions"
+    },
+    "@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject": {
+      "assembly": "@rocketleap/rocketleap-projen",
+      "base": "projen.awscdk.AwsCdkTypeScriptApp",
+      "docs": {
+        "remarks": "This is for platform infrastructure code (e.g., root-cdk, vpc-cdk, iam-cdk).\nIncludes the Norberhuis Onderneming B.V. license.",
+        "stability": "stable",
+        "summary": "Projen project for Rocketleap Platform CDK projects."
+      },
+      "fqn": "@rocketleap/rocketleap-projen.RocketleapPlatformCdkProject",
+      "initializer": {
+        "docs": {
+          "stability": "stable"
+        },
+        "locationInModule": {
+          "filename": "src/cdk-project.ts",
+          "line": 116
+        },
+        "parameters": [
+          {
+            "name": "options",
+            "type": {
+              "fqn": "@rocketleap/rocketleap-projen.RocketleapCdkProjectOptions"
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/cdk-project.ts",
+        "line": 115
+      },
+      "methods": [
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "locationInModule": {
+            "filename": "src/cdk-project.ts",
+            "line": 89
+          },
+          "name": "generateSampleProjenrc",
+          "parameters": [
+            {
+              "name": "projectClass",
+              "type": {
+                "primitive": "string"
+              }
+            }
+          ],
+          "protected": true
+        }
+      ],
+      "name": "RocketleapPlatformCdkProject",
+      "properties": [
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/cdk-project.ts",
+            "line": 24
+          },
+          "name": "company",
+          "protected": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/cdk-project.ts",
+            "line": 25
+          },
+          "name": "projectName",
+          "protected": true,
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "src/cdk-project:RocketleapPlatformCdkProject"
+    },
+    "@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject": {
+      "assembly": "@rocketleap/rocketleap-projen",
+      "base": "projen.awscdk.AwsCdkTypeScriptApp",
+      "docs": {
+        "remarks": "This is for customer-specific workload code that runs on the platform.\nDoes NOT include the platform license.",
+        "stability": "stable",
+        "summary": "Projen project for customer workload CDK projects."
+      },
+      "fqn": "@rocketleap/rocketleap-projen.RocketleapWorkloadCdkProject",
+      "initializer": {
+        "docs": {
+          "stability": "stable"
+        },
+        "locationInModule": {
+          "filename": "src/cdk-project.ts",
+          "line": 158
+        },
+        "parameters": [
+          {
+            "name": "options",
+            "type": {
+              "fqn": "@rocketleap/rocketleap-projen.RocketleapCdkProjectOptions"
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/cdk-project.ts",
+        "line": 157
+      },
+      "methods": [
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "locationInModule": {
+            "filename": "src/cdk-project.ts",
+            "line": 89
+          },
+          "name": "generateSampleProjenrc",
+          "parameters": [
+            {
+              "name": "projectClass",
+              "type": {
+                "primitive": "string"
+              }
+            }
+          ],
+          "protected": true
+        }
+      ],
+      "name": "RocketleapWorkloadCdkProject",
+      "properties": [
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/cdk-project.ts",
+            "line": 24
+          },
+          "name": "company",
+          "protected": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/cdk-project.ts",
+            "line": 25
+          },
+          "name": "projectName",
+          "protected": true,
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "src/cdk-project:RocketleapWorkloadCdkProject"
     }
   },
-  "version": "0.0.11",
-  "fingerprint": "Pzp9/fvnACh2szDiiSDcpzYQI3yB0eiGkia7mDEP5Uc="
+  "version": "0.0.12",
+  "fingerprint": "PWSKReixtxbTLOCLy6M6ES/RU4Pv+0nTJ3N9csD1AQI="
 }

package/.pre-commit-config.yaml

@@ -1,28 +1,7 @@
 repos:
   - repo: local
     hooks:
-      - id: yarn-eslint
-        name: ESLint
-        entry: sh -c "CI=true yarn eslint --max-warnings=0 ."
+      - id: release
+        name: Release
+        entry: sh -c "npx projen release"
         language: system
-        pass_filenames: false
-      - id: yarn-prettier
-        name: Prettier
-        entry: sh -c "CI=true yarn prettier --check ."
-        language: system
-        pass_filenames: false
-      - id: yarn-compile
-        name: Compile
-        entry: sh -c "CI=true yarn compile"
-        language: system
-        pass_filenames: false
-      - id: yarn-test
-        name: Test
-        entry: sh -c "CI=true yarn test"
-        language: system
-        pass_filenames: false
-      - id: yarn-package
-        name: Package
-        entry: sh -c "CI=true yarn package"
-        language: system
-        pass_filenames: false