@jttc/projen-project-types 1.0.0-beta.4 → 1.0.0-beta.6

package/.cz-config.js

@@ -31,6 +31,7 @@ module.exports = {
     { name: 'cdk-app' },
     { name: 'cdk8s-component' },
     { name: 'cdk8s-library' },
+    { name: 'cdk8s-app' },
   ],
 
   usePreparedCommit: true, // to re-use commit from ./.git/COMMIT_EDITMSG

package/.jsii

@@ -95,7 +95,7 @@
   },
   "name": "@jttc/projen-project-types",
   "readme": {
-    "markdown": "# 🏗️ Projen Project Types\n\n> **Opinionated project templates for [projen.io](https://projen.io) that accelerate development with best practices built-in**\n\n[![npm version](https://img.shields.io/npm/v/@jttc/projen-project-types)](https://www.npmjs.com/package/@jttc/projen-project-types)\n[![License: Apache-2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n[![Documentation](https://img.shields.io/badge/docs-mkdocs-blue)](https://jumptothecloud.github.io/projen-project-types/)\n[![GitHub](https://img.shields.io/github/stars/JumpToTheCloud/projen-project-types?style=social)](https://github.com/JumpToTheCloud/projen-project-types)\n\n## ✨ What is this?\n\nThis package provides **ready-to-use project templates** that extend [projen](https://projen.io) with opinionated configurations, saving you hours of setup time while ensuring consistency and best practices across your projects.\n\nInstead of manually configuring Prettier, ESLint, VSCode settings, CI/CD pipelines, and other tools for every project, these templates give you everything pre-configured and battle-tested.\n\n## 🚀 Quick Start\n\n```bash\n# Create a CDK construct library\nnpx projen new --from @jttc/projen-project-types cdk-library\n\n# Create a CDK application\nnpx projen new --from @jttc/projen-project-types cdk-app\n\n# Create a CDK8s construct library with Kubernetes support\nnpx projen new --from @jttc/projen-project-types cdk8s-library\n```\n\n## 📦 Available Project Types\n\n| Project Type | Description | Best For |\n|--------------|-------------|----------|\n| **[CDK Library](https://jumptothecloud.github.io/projen-project-types/project-types/cdk-library/)** | AWS CDK construct libraries | Creating reusable AWS infrastructure components |\n| **[CDK App](https://jumptothecloud.github.io/projen-project-types/project-types/cdk-app/)** | AWS CDK applications | Building and deploying AWS infrastructure |\n| **[CDK8s Library](https://jumptothecloud.github.io/projen-project-types/project-types/cdk8s-library/)** | CDK8s libraries with Kubernetes | Creating reusable Kubernetes constructs |\n\n## 🧩 Available Components\n\n| Component | Description | Documentation |\n|-----------|-------------|---------------|\n| **[CDK8s Component](https://jumptothecloud.github.io/projen-project-types/components/cdk8s/)** | Kubernetes manifest generation with TypeScript | Add to any project type |\n\n## ⚡ What You Get Out of the Box\n\nEvery project template includes:\n\n- 🎨 **[Prettier](https://jumptothecloud.github.io/projen-project-types/default-configurations/#prettier-configuration)** - Consistent code formatting\n- 🔧 **[VSCode Setup](https://jumptothecloud.github.io/projen-project-types/default-configurations/#vscode-configuration)** - Optimized editor experience with recommended extensions\n- 📝 **TypeScript** - Best practices and configurations\n- 🧪 **Jest Testing** - Ready-to-use testing framework\n- 🚢 **CI/CD Pipelines** - GitHub Actions workflows\n- 📚 **Documentation** - Auto-generated API docs\n- 🔒 **Security** - Dependabot and security scanning\n\n## 💡 Example Usage\n\n### CDK Library with Custom Configuration\n\n```typescript\n// .projenrc.ts\nimport { CdkLibrary } from '@jttc/projen-project-types';\n\nconst project = new CdkLibrary({\n  name: 'my-awesome-constructs',\n  author: 'Your Name',\n  authorAddress: 'your@email.com',\n  repositoryUrl: 'https://github.com/yourusername/my-awesome-constructs.git',\n  cdkVersion: '2.1.0',\n  defaultReleaseBranch: 'main',\n\n  // Customize as needed\n  prettier: true,\n  vscode: true,\n});\n\nproject.synth();\n```\n\n### CDK8s Library with Kubernetes Support\n\n```typescript\n// .projenrc.ts\nimport { Cdk8sLibrary, K8sVersion } from '@jttc/projen-project-types';\n\nconst project = new Cdk8sLibrary({\n  name: 'my-k8s-constructs',\n  author: 'Your Name',\n  authorAddress: 'your@email.com',\n  repositoryUrl: 'https://github.com/yourusername/my-k8s-constructs.git',\n  cdkVersion: '2.1.0',\n  defaultReleaseBranch: 'main',\n\n  // CDK8s specific options\n  k8sVersion: K8sVersion.V1_31,\n  appPath: 'src/k8s',\n  imports: ['cert-manager@v1.13.0'],\n});\n\nproject.synth();\n```\n\n## 🏗️ Architecture\n\n```\nprojen-project-types/\n├── 📁 Project Types/          # Complete project templates\n│   ├── CDK Library           # AWS CDK construct libraries\n│   ├── CDK App              # AWS CDK applications\n│   └── CDK8s Library        # Kubernetes + CDK8s libraries\n├── 🧩 Components/            # Reusable functionality\n│   └── CDK8s Component      # Kubernetes manifest generation\n└── ⚙️  Common Config/        # Shared configurations\n    ├── Prettier             # Code formatting\n    ├── VSCode              # Editor setup\n    └── TypeScript          # Language configuration\n```\n\n## 📚 Documentation\n\nComprehensive documentation is available at: **[jumptothecloud.github.io/projen-project-types](https://jumptothecloud.github.io/projen-project-types/)**\n\n- **[Getting Started Guide](https://jumptothecloud.github.io/projen-project-types/)**\n- **[Project Types](https://jumptothecloud.github.io/projen-project-types/project-types/cdk-library/)**\n- **[Components](https://jumptothecloud.github.io/projen-project-types/components/cdk8s/)**\n- **[Default Configurations](https://jumptothecloud.github.io/projen-project-types/default-configurations/)**\n\n## 🛠️ Development\n\n### Prerequisites\n\n- **Node.js** (v18+)\n- **Yarn** package manager\n- **Python 3** (for documentation)\n\n### Setup\n\n```bash\n# Clone the repository\ngit clone https://github.com/JumpToTheCloud/projen-project-types.git\ncd projen-project-types\n\n# Install dependencies\nyarn install\n\n# Run tests\nyarn test\n\n# Build the project\nyarn build\n```\n\n### Documentation Development\n\n```bash\n# Install documentation dependencies\npip3 install mkdocs mkdocs-material mike\n\n# Serve documentation locally with hot reload\nyarn docs:serve\n\n# Build documentation\nyarn docs:build\n```\n\nThe documentation will be available at `http://localhost:8099` when using the serve command.\n\n## 🗺️ Roadmap\n\nPlanned features and project types:\n\n- **Next.js Projects** - Full-stack TypeScript applications\n- **Node.js APIs** - REST and GraphQL API templates\n- **React Libraries** - Component library templates\n- **Terraform Modules** - Infrastructure as Code templates\n- **Docker Components** - Containerization support\n- **Serverless Functions** - AWS Lambda and other FaaS templates\n\n## 🤝 Contributing\n\nWe welcome contributions! Here's how to get started:\n\n1. **Fork the repository**\n2. **Create a feature branch**: `git checkout -b feature/amazing-feature`\n3. **Make your changes** and add tests\n4. **Run tests**: `yarn test`\n5. **Update documentation** if needed\n6. **Commit your changes**: `git commit -m 'Add amazing feature'`\n7. **Push to the branch**: `git push origin feature/amazing-feature`\n8. **Open a Pull Request**\n\n### Contribution Guidelines\n\n- All new features should include tests\n- Documentation should be updated for new project types or components\n- Follow the existing code style and patterns\n- Ensure all CI checks pass\n\n## ❓ Support\n\n- **Documentation**: [jumptothecloud.github.io/projen-project-types](https://jumptothecloud.github.io/projen-project-types/)\n- **Issues**: [GitHub Issues](https://github.com/JumpToTheCloud/projen-project-types/issues)\n- **Discussions**: [GitHub Discussions](https://github.com/JumpToTheCloud/projen-project-types/discussions)\n\n## 📄 License\n\nThis project is licensed under the **Apache 2.0 License** - see the [LICENSE](LICENSE) file for details.\n\n## 🌟 Credits\n\nBuilt with ❤️ by the [JumpToTheCloud](https://github.com/JumpToTheCloud) team.\n\nSpecial thanks to the [projen](https://projen.io) community for creating such an amazing tool for project configuration management."
+    "markdown": "# 🏗️ Projen Project Types\n\n> **Opinionated project templates for [projen.io](https://projen.io) that accelerate development with best practices built-in**\n\n[![npm version](https://img.shields.io/npm/v/@jttc/projen-project-types)](https://www.npmjs.com/package/@jttc/projen-project-types)\n[![License: Apache-2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n[![Documentation](https://img.shields.io/badge/docs-mkdocs-blue)](https://jumptothecloud.github.io/projen-project-types/)\n[![GitHub](https://img.shields.io/github/stars/JumpToTheCloud/projen-project-types?style=social)](https://github.com/JumpToTheCloud/projen-project-types)\n\n## ✨ What is this?\n\nThis package provides **ready-to-use project templates** that extend [projen](https://projen.io) with opinionated configurations, saving you hours of setup time while ensuring consistency and best practices across your projects.\n\nInstead of manually configuring Prettier, ESLint, VSCode settings, CI/CD pipelines, and other tools for every project, these templates give you everything pre-configured and battle-tested.\n\n## 🚀 Quick Start\n\n```bash\n# Create a CDK construct library\nnpx projen new --from @jttc/projen-project-types cdk-library\n\n# Create a CDK application\nnpx projen new --from @jttc/projen-project-types cdk-app\n\n# Create a CDK8s construct library with Kubernetes support\nnpx projen new --from @jttc/projen-project-types cdk8s-library\n\n# Create a CDK8s application with Kubernetes support\nnpx projen new --from @jttc/projen-project-types cdk8s-app\n```\n\n## 📦 Available Project Types\n\n| Project Type | Description | Best For |\n|--------------|-------------|----------|\n| **[CDK Library](https://jumptothecloud.github.io/projen-project-types/project-types/cdk-library/)** | AWS CDK construct libraries | Creating reusable AWS infrastructure components |\n| **[CDK App](https://jumptothecloud.github.io/projen-project-types/project-types/cdk-app/)** | AWS CDK applications | Building and deploying AWS infrastructure |\n| **[CDK8s Library](https://jumptothecloud.github.io/projen-project-types/project-types/cdk8s-library/)** | CDK8s libraries with Kubernetes | Creating reusable Kubernetes constructs |\n| **[CDK8s App](https://jumptothecloud.github.io/projen-project-types/project-types/cdk8s-app/)** | CDK8s applications with Kubernetes | Building and deploying Kubernetes applications |\n\n## 🧩 Available Components\n\n| Component | Description | Documentation |\n|-----------|-------------|---------------|\n| **[CDK8s Component](https://jumptothecloud.github.io/projen-project-types/components/cdk8s/)** | Kubernetes manifest generation with TypeScript | Add to any project type |\n\n## ⚡ What You Get Out of the Box\n\nEvery project template includes:\n\n- 🎨 **[Prettier](https://jumptothecloud.github.io/projen-project-types/default-configurations/#prettier-configuration)** - Consistent code formatting\n- 🔧 **[VSCode Setup](https://jumptothecloud.github.io/projen-project-types/default-configurations/#vscode-configuration)** - Optimized editor experience with recommended extensions\n- 📝 **TypeScript** - Best practices and configurations\n- 🧪 **Jest Testing** - Ready-to-use testing framework\n- 🚢 **CI/CD Pipelines** - GitHub Actions workflows\n- 📚 **Documentation** - Auto-generated API docs\n- 🔒 **Security** - Dependabot and security scanning\n\n## 💡 Example Usage\n\n### CDK Library with Custom Configuration\n\n```typescript\n// .projenrc.ts\nimport { CdkLibrary } from '@jttc/projen-project-types';\n\nconst project = new CdkLibrary({\n  name: 'my-awesome-constructs',\n  author: 'Your Name',\n  authorAddress: 'your@email.com',\n  repositoryUrl: 'https://github.com/yourusername/my-awesome-constructs.git',\n  cdkVersion: '2.1.0',\n  defaultReleaseBranch: 'main',\n\n  // Customize as needed\n  prettier: true,\n  vscode: true,\n});\n\nproject.synth();\n```\n\n### CDK8s Library with Kubernetes Support\n\n```typescript\n// .projenrc.ts\nimport { Cdk8sLibrary, K8sVersion } from '@jttc/projen-project-types';\n\nconst project = new Cdk8sLibrary({\n  name: 'my-k8s-constructs',\n  author: 'Your Name',\n  authorAddress: 'your@email.com',\n  repositoryUrl: 'https://github.com/yourusername/my-k8s-constructs.git',\n  cdkVersion: '2.1.0',\n  defaultReleaseBranch: 'main',\n\n  // CDK8s specific options\n  k8sVersion: K8sVersion.V1_31,\n  appPath: 'src/k8s',\n  imports: ['cert-manager@v1.13.0'],\n});\n\nproject.synth();\n```\n\n## 🏗️ Architecture\n\n```\nprojen-project-types/\n├── 📁 Project Types/          # Complete project templates\n│   ├── CDK Library           # AWS CDK construct libraries\n│   ├── CDK App              # AWS CDK applications\n│   └── CDK8s Library        # Kubernetes + CDK8s libraries\n├── 🧩 Components/            # Reusable functionality\n│   └── CDK8s Component      # Kubernetes manifest generation\n└── ⚙️  Common Config/        # Shared configurations\n    ├── Prettier             # Code formatting\n    ├── VSCode              # Editor setup\n    └── TypeScript          # Language configuration\n```\n\n## 📚 Documentation\n\nComprehensive documentation is available at: **[jumptothecloud.github.io/projen-project-types](https://jumptothecloud.github.io/projen-project-types/)**\n\n- **[Getting Started Guide](https://jumptothecloud.github.io/projen-project-types/)**\n- **[Project Types](https://jumptothecloud.github.io/projen-project-types/project-types/cdk-library/)**\n- **[Components](https://jumptothecloud.github.io/projen-project-types/components/cdk8s/)**\n- **[Default Configurations](https://jumptothecloud.github.io/projen-project-types/default-configurations/)**\n\n## 🛠️ Development\n\n### Prerequisites\n\n- **Node.js** (v18+)\n- **Yarn** package manager\n- **Python 3** (for documentation)\n\n### Setup\n\n```bash\n# Clone the repository\ngit clone https://github.com/JumpToTheCloud/projen-project-types.git\ncd projen-project-types\n\n# Install dependencies\nyarn install\n\n# Run tests\nyarn test\n\n# Build the project\nyarn build\n```\n\n### Documentation Development\n\n```bash\n# Install documentation dependencies\npip3 install mkdocs mkdocs-material mike\n\n# Serve documentation locally with hot reload\nyarn docs:serve\n\n# Build documentation\nyarn docs:build\n```\n\nThe documentation will be available at `http://localhost:8099` when using the serve command.\n\n## 🗺️ Roadmap\n\nPlanned features and project types:\n\n- **Next.js Projects** - Full-stack TypeScript applications\n- **Node.js APIs** - REST and GraphQL API templates\n- **React Libraries** - Component library templates\n- **Terraform Modules** - Infrastructure as Code templates\n- **Docker Components** - Containerization support\n- **Serverless Functions** - AWS Lambda and other FaaS templates\n\n## 🤝 Contributing\n\nWe welcome contributions! Here's how to get started:\n\n1. **Fork the repository**\n2. **Create a feature branch**: `git checkout -b feature/amazing-feature`\n3. **Make your changes** and add tests\n4. **Run tests**: `yarn test`\n5. **Update documentation** if needed\n6. **Commit your changes**: `git commit -m 'Add amazing feature'`\n7. **Push to the branch**: `git push origin feature/amazing-feature`\n8. **Open a Pull Request**\n\n### Contribution Guidelines\n\n- All new features should include tests\n- Documentation should be updated for new project types or components\n- Follow the existing code style and patterns\n- Ensure all CI checks pass\n\n## ❓ Support\n\n- **Documentation**: [jumptothecloud.github.io/projen-project-types](https://jumptothecloud.github.io/projen-project-types/)\n- **Issues**: [GitHub Issues](https://github.com/JumpToTheCloud/projen-project-types/issues)\n- **Discussions**: [GitHub Discussions](https://github.com/JumpToTheCloud/projen-project-types/discussions)\n\n## 📄 License\n\nThis project is licensed under the **Apache 2.0 License** - see the [LICENSE](LICENSE) file for details.\n\n## 🌟 Credits\n\nBuilt with ❤️ by the [JumpToTheCloud](https://github.com/JumpToTheCloud) team.\n\nSpecial thanks to the [projen](https://projen.io) community for creating such an amazing tool for project configuration management."
   },
   "repository": {
     "type": "git",
@@ -108,6 +108,73 @@
     }
   },
   "types": {
+    "@jttc/projen-project-types.Cdk8App": {
+      "assembly": "@jttc/projen-project-types",
+      "base": "projen.typescript.TypeScriptProject",
+      "docs": {
+        "custom": {
+          "pjid": "cdk8s-app"
+        },
+        "stability": "stable",
+        "summary": "CDK8s Application Project."
+      },
+      "fqn": "@jttc/projen-project-types.Cdk8App",
+      "initializer": {
+        "docs": {
+          "stability": "stable"
+        },
+        "locationInModule": {
+          "filename": "src/cdk/cdk8s-app-project.ts",
+          "line": 14
+        },
+        "parameters": [
+          {
+            "name": "options",
+            "type": {
+              "fqn": "@jttc/projen-project-types.Cdk8sAppOptions"
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/cdk/cdk8s-app-project.ts",
+        "line": 11
+      },
+      "methods": [
+        {
+          "docs": {
+            "remarks": "Order is *not* guaranteed.",
+            "stability": "stable",
+            "summary": "Called after all components are synthesized."
+          },
+          "locationInModule": {
+            "filename": "src/cdk/cdk8s-app-project.ts",
+            "line": 41
+          },
+          "name": "postSynthesize",
+          "overrides": "projen.Project"
+        }
+      ],
+      "name": "Cdk8App",
+      "properties": [
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/cdk/cdk8s-app-project.ts",
+            "line": 12
+          },
+          "name": "cdk8s",
+          "type": {
+            "fqn": "@jttc/projen-project-types.Cdk8sComponent"
+          }
+        }
+      ],
+      "symbolId": "src/cdk/cdk8s-app-project:Cdk8App"
+    },
     "@jttc/projen-project-types.Cdk8sAppOptions": {
       "assembly": "@jttc/projen-project-types",
       "datatype": true,
@@ -117,12 +184,12 @@
       "fqn": "@jttc/projen-project-types.Cdk8sAppOptions",
       "interfaces": [
         "@jttc/projen-project-types.Cdk8sBaseOptions",
-        "projen.awscdk.AwsCdkTypeScriptAppOptions"
+        "projen.typescript.TypeScriptProjectOptions"
       ],
       "kind": "interface",
       "locationInModule": {
         "filename": "src/components/cdk8s/interfaces/Cdk8s.ts",
-        "line": 48
+        "line": 46
       },
       "name": "Cdk8sAppOptions",
       "symbolId": "src/components/cdk8s/interfaces/Cdk8s:Cdk8sAppOptions"
@@ -137,7 +204,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/components/cdk8s/interfaces/Cdk8s.ts",
-        "line": 14
+        "line": 12
       },
       "name": "Cdk8sBaseOptions",
       "properties": [
@@ -151,7 +218,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/components/cdk8s/interfaces/Cdk8s.ts",
-            "line": 26
+            "line": 24
           },
           "name": "appFile",
           "optional": true,
@@ -169,7 +236,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/components/cdk8s/interfaces/Cdk8s.ts",
-            "line": 20
+            "line": 18
           },
           "name": "appPath",
           "optional": true,
@@ -186,7 +253,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/components/cdk8s/interfaces/Cdk8s.ts",
-            "line": 30
+            "line": 28
           },
           "name": "imports",
           "optional": true,
@@ -209,7 +276,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/components/cdk8s/interfaces/Cdk8s.ts",
-            "line": 42
+            "line": 40
           },
           "name": "k8sVersion",
           "optional": true,
@@ -227,7 +294,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/components/cdk8s/interfaces/Cdk8s.ts",
-            "line": 36
+            "line": 34
           },
           "name": "outputPath",
           "optional": true,
@@ -289,7 +356,7 @@
           },
           "locationInModule": {
             "filename": "src/components/cdk8s/cdk8s.ts",
-            "line": 109
+            "line": 117
           },
           "name": "postSynthesize",
           "overrides": "projen.Component"
@@ -417,7 +484,7 @@
           },
           "locationInModule": {
             "filename": "src/cdk/cdk8s-library-project.ts",
-            "line": 27
+            "line": 39
           },
           "name": "postSynthesize",
           "overrides": "projen.Project"
@@ -456,7 +523,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/components/cdk8s/interfaces/Cdk8s.ts",
-        "line": 45
+        "line": 43
       },
       "name": "Cdk8sLibraryOptions",
       "symbolId": "src/components/cdk8s/interfaces/Cdk8s:Cdk8sLibraryOptions"
@@ -542,7 +609,7 @@
       "kind": "enum",
       "locationInModule": {
         "filename": "src/components/cdk8s/interfaces/Cdk8s.ts",
-        "line": 6
+        "line": 4
       },
       "members": [
         {
@@ -580,6 +647,6 @@
       "symbolId": "src/components/cdk8s/interfaces/Cdk8s:K8sVersion"
     }
   },
-  "version": "1.0.0-beta.4",
-  "fingerprint": "1LiBfpSGho+D/goBIPYFvlL7FcnHZdZV42rreCT+Hmo="
+  "version": "1.0.0-beta.6",
+  "fingerprint": "/ibgZsJMx+OT+DBlTTPAOvuZmt06x9qeU4mWRg6DrzU="
 }