@jttc/projen-project-types 1.0.0-beta.1 → 1.0.0-beta.3

package/.cz-config.js

@@ -24,7 +24,14 @@ module.exports = {
     { value: 'WIP', name: 'WIP:      Work in progress' },
   ],
 
-  scopes: [{ name: 'projen' }, { name: 'docs' }, { name: 'cdk-library' }],
+  scopes: [
+    { name: 'projen' },
+    { name: 'docs' },
+    { name: 'cdk-library' },
+    { name: 'cdk-app' },
+    { name: 'cdk8s-component' },
+    { name: 'cdk8s-library' },
+  ],
 
   usePreparedCommit: true, // to re-use commit from ./.git/COMMIT_EDITMSG
   allowTicketNumber: false,

package/.jsii

@@ -8,7 +8,7 @@
   },
   "dependencies": {
     "constructs": "^10.4.4",
-    "projen": "^0.98.30"
+    "projen": "^0.99.0"
   },
   "dependencyClosure": {
     "constructs": {
@@ -83,7 +83,7 @@
     "stability": "stable"
   },
   "homepage": "git@github.com:JumpToTheCloud/projen-project-types.git",
-  "jsiiVersion": "5.9.20 (build 6e2b13a)",
+  "jsiiVersion": "5.9.22 (build b81c634)",
   "license": "Apache-2.0",
   "metadata": {
     "jsii": {
@@ -95,7 +95,7 @@
   },
   "name": "@jttc/projen-project-types",
   "readme": {
-    "markdown": "# Projen Project Types\n\nA collection of opinionated custom project templates for [projen.io](https://projen.io).\n\n## Overview\n\nThis repository provides curated project types that extend projen's capabilities with opinionated configurations and best practices. These project types are designed to accelerate development workflows while maintaining consistency and quality across projects.\n\n## Requirements\n\n### Documentation\n\nThis project uses MkDocs for documentation. To work with the documentation locally, you need to install the following dependencies:\n\n```bash\n# Install MkDocs and Material theme\npip3 install mkdocs mkdocs-material\n\n# Install Mike for documentation versioning\npip3 install mike\n```\n\n### Development Commands\n\nOnce the requirements are installed, you can use the following commands:\n\n```bash\n# Build the documentation\nyarn docs:build\n\n# Serve the documentation locally (with live reload)\nyarn docs:serve\n```\n\nThe documentation will be available at `http://localhost:8000` when using the serve command.\n\n## Features\n\n- 🚀 **Ready-to-use project templates** for various use cases\n- 📦 **Integrated tooling** with sensible defaults\n- 🔧 **Customizable configurations** to fit your needs\n- 📚 **Comprehensive documentation** with MkDocs Material theme\n- 🔄 **Continuous integration** templates included\n\n## Getting Started\n\nMore detailed documentation and project types will be added as features are developed. Visit the documentation site for the latest information.\n\n## Contributing\n\nContributions are welcome! Please feel free to submit issues, feature requests, or pull requests to help improve these project types.\n\n## License\n\nThis project is licensed under the terms specified in the LICENSE file."
+    "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."
   },
   "repository": {
     "type": "git",
@@ -108,6 +108,395 @@
     }
   },
   "types": {
+    "@jttc/projen-project-types.Cdk8sAppOptions": {
+      "assembly": "@jttc/projen-project-types",
+      "datatype": true,
+      "docs": {
+        "stability": "stable"
+      },
+      "fqn": "@jttc/projen-project-types.Cdk8sAppOptions",
+      "interfaces": [
+        "@jttc/projen-project-types.Cdk8sBaseOptions",
+        "projen.awscdk.AwsCdkTypeScriptAppOptions"
+      ],
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/components/cdk8s/interfaces/Cdk8s.ts",
+        "line": 48
+      },
+      "name": "Cdk8sAppOptions",
+      "symbolId": "src/components/cdk8s/interfaces/Cdk8s:Cdk8sAppOptions"
+    },
+    "@jttc/projen-project-types.Cdk8sBaseOptions": {
+      "assembly": "@jttc/projen-project-types",
+      "datatype": true,
+      "docs": {
+        "stability": "stable"
+      },
+      "fqn": "@jttc/projen-project-types.Cdk8sBaseOptions",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/components/cdk8s/interfaces/Cdk8s.ts",
+        "line": 14
+      },
+      "name": "Cdk8sBaseOptions",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "default": "main.ts",
+            "stability": "stable",
+            "summary": "The name of the main file."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/components/cdk8s/interfaces/Cdk8s.ts",
+            "line": 26
+          },
+          "name": "appFile",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "\"src/k8s\"",
+            "stability": "stable",
+            "summary": "path of main file to execute the typescript transpilation."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/components/cdk8s/interfaces/Cdk8s.ts",
+            "line": 20
+          },
+          "name": "appPath",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable",
+            "summary": "List of kubernetes imports to be added."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/components/cdk8s/interfaces/Cdk8s.ts",
+            "line": 30
+          },
+          "name": "imports",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "1.31",
+            "stability": "stable",
+            "summary": "The kubernetes version to use."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/components/cdk8s/interfaces/Cdk8s.ts",
+            "line": 42
+          },
+          "name": "k8sVersion",
+          "optional": true,
+          "type": {
+            "fqn": "@jttc/projen-project-types.K8sVersion"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "\"kubernetes\"",
+            "stability": "stable",
+            "summary": "The path where the output synthesized file will be saved."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/components/cdk8s/interfaces/Cdk8s.ts",
+            "line": 36
+          },
+          "name": "outputPath",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "src/components/cdk8s/interfaces/Cdk8s:Cdk8sBaseOptions"
+    },
+    "@jttc/projen-project-types.Cdk8sComponent": {
+      "assembly": "@jttc/projen-project-types",
+      "base": "projen.Component",
+      "docs": {
+        "stability": "stable"
+      },
+      "fqn": "@jttc/projen-project-types.Cdk8sComponent",
+      "initializer": {
+        "docs": {
+          "stability": "stable"
+        },
+        "locationInModule": {
+          "filename": "src/components/cdk8s/cdk8s.ts",
+          "line": 20
+        },
+        "parameters": [
+          {
+            "name": "project",
+            "type": {
+              "fqn": "projen.Project"
+            }
+          },
+          {
+            "name": "id",
+            "type": {
+              "primitive": "string"
+            }
+          },
+          {
+            "name": "props",
+            "optional": true,
+            "type": {
+              "fqn": "@jttc/projen-project-types.Cdk8sBaseOptions"
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/components/cdk8s/cdk8s.ts",
+        "line": 13
+      },
+      "methods": [
+        {
+          "docs": {
+            "remarks": "Order is *not* guaranteed.",
+            "stability": "stable",
+            "summary": "Called after synthesis."
+          },
+          "locationInModule": {
+            "filename": "src/components/cdk8s/cdk8s.ts",
+            "line": 109
+          },
+          "name": "postSynthesize",
+          "overrides": "projen.Component"
+        }
+      ],
+      "name": "Cdk8sComponent",
+      "properties": [
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/components/cdk8s/cdk8s.ts",
+            "line": 15
+          },
+          "name": "appFile",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/components/cdk8s/cdk8s.ts",
+            "line": 14
+          },
+          "name": "appPath",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/components/cdk8s/cdk8s.ts",
+            "line": 16
+          },
+          "name": "imports",
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/components/cdk8s/cdk8s.ts",
+            "line": 18
+          },
+          "name": "k8sVersion",
+          "type": {
+            "fqn": "@jttc/projen-project-types.K8sVersion"
+          }
+        },
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/components/cdk8s/cdk8s.ts",
+            "line": 17
+          },
+          "name": "outputPath",
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "src/components/cdk8s/cdk8s:Cdk8sComponent"
+    },
+    "@jttc/projen-project-types.Cdk8sLibrary": {
+      "assembly": "@jttc/projen-project-types",
+      "base": "projen.awscdk.AwsCdkConstructLibrary",
+      "docs": {
+        "custom": {
+          "pjid": "cdk8s-library"
+        },
+        "stability": "stable",
+        "summary": "CDK Construct Library Project."
+      },
+      "fqn": "@jttc/projen-project-types.Cdk8sLibrary",
+      "initializer": {
+        "docs": {
+          "stability": "stable"
+        },
+        "locationInModule": {
+          "filename": "src/cdk/cdk8s-library-project.ts",
+          "line": 14
+        },
+        "parameters": [
+          {
+            "name": "options",
+            "type": {
+              "fqn": "@jttc/projen-project-types.Cdk8sLibraryOptions"
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/cdk/cdk8s-library-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-library-project.ts",
+            "line": 27
+          },
+          "name": "postSynthesize",
+          "overrides": "projen.Project"
+        }
+      ],
+      "name": "Cdk8sLibrary",
+      "properties": [
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/cdk/cdk8s-library-project.ts",
+            "line": 12
+          },
+          "name": "cdk8s",
+          "type": {
+            "fqn": "@jttc/projen-project-types.Cdk8sComponent"
+          }
+        }
+      ],
+      "symbolId": "src/cdk/cdk8s-library-project:Cdk8sLibrary"
+    },
+    "@jttc/projen-project-types.Cdk8sLibraryOptions": {
+      "assembly": "@jttc/projen-project-types",
+      "datatype": true,
+      "docs": {
+        "stability": "stable"
+      },
+      "fqn": "@jttc/projen-project-types.Cdk8sLibraryOptions",
+      "interfaces": [
+        "@jttc/projen-project-types.Cdk8sBaseOptions",
+        "projen.awscdk.AwsCdkConstructLibraryOptions"
+      ],
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/components/cdk8s/interfaces/Cdk8s.ts",
+        "line": 45
+      },
+      "name": "Cdk8sLibraryOptions",
+      "symbolId": "src/components/cdk8s/interfaces/Cdk8s:Cdk8sLibraryOptions"
+    },
+    "@jttc/projen-project-types.CdkApp": {
+      "assembly": "@jttc/projen-project-types",
+      "base": "projen.awscdk.AwsCdkTypeScriptApp",
+      "docs": {
+        "custom": {
+          "pjid": "cdk-app"
+        },
+        "stability": "stable",
+        "summary": "CDK TypeScript App Project."
+      },
+      "fqn": "@jttc/projen-project-types.CdkApp",
+      "initializer": {
+        "docs": {
+          "stability": "stable"
+        },
+        "locationInModule": {
+          "filename": "src/cdk/cdk-app-project.ts",
+          "line": 13
+        },
+        "parameters": [
+          {
+            "name": "options",
+            "type": {
+              "fqn": "projen.awscdk.AwsCdkTypeScriptAppOptions"
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/cdk/cdk-app-project.ts",
+        "line": 12
+      },
+      "name": "CdkApp",
+      "symbolId": "src/cdk/cdk-app-project:CdkApp"
+    },
     "@jttc/projen-project-types.CdkLibrary": {
       "assembly": "@jttc/projen-project-types",
       "base": "projen.awscdk.AwsCdkConstructLibrary",
@@ -143,8 +532,54 @@
       },
       "name": "CdkLibrary",
       "symbolId": "src/cdk/cdk-library-project:CdkLibrary"
+    },
+    "@jttc/projen-project-types.K8sVersion": {
+      "assembly": "@jttc/projen-project-types",
+      "docs": {
+        "stability": "stable"
+      },
+      "fqn": "@jttc/projen-project-types.K8sVersion",
+      "kind": "enum",
+      "locationInModule": {
+        "filename": "src/components/cdk8s/interfaces/Cdk8s.ts",
+        "line": 6
+      },
+      "members": [
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "name": "V1_29"
+        },
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "name": "V1_30"
+        },
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "name": "V1_31"
+        },
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "name": "V1_32"
+        },
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "name": "V1_33"
+        }
+      ],
+      "name": "K8sVersion",
+      "symbolId": "src/components/cdk8s/interfaces/Cdk8s:K8sVersion"
     }
   },
-  "version": "1.0.0-beta.1",
-  "fingerprint": "ZW7CsPe0ONja40l17dyKVu0USzSrUr+6JxGHqD7wR20="
+  "version": "1.0.0-beta.3",
+  "fingerprint": "JP7XcU0X/oalv6RHUufOk4XFhswaqE132y+OiZhtzqw="
 }