projen-cdktf-hybrid-construct 0.1.1

package/.gitattributes

@@ -0,0 +1,25 @@
+# ~~ Generated by projen. To modify, edit .projenrc.js and run "npx projen".
+
+*.snap linguist-generated
+/.eslintrc.json linguist-generated
+/.gitattributes linguist-generated
+/.github/pull_request_template.md linguist-generated
+/.github/workflows/auto-approve.yml linguist-generated
+/.github/workflows/build.yml linguist-generated
+/.github/workflows/pull-request-lint.yml linguist-generated
+/.github/workflows/release.yml linguist-generated
+/.github/workflows/upgrade-main.yml linguist-generated
+/.gitignore linguist-generated
+/.mergify.yml linguist-generated
+/.npmignore linguist-generated
+/.prettierignore linguist-generated
+/.prettierrc.json linguist-generated
+/.projen/** linguist-generated
+/.projen/deps.json linguist-generated
+/.projen/files.json linguist-generated
+/.projen/tasks.json linguist-generated
+/LICENSE linguist-generated
+/package.json linguist-generated
+/tsconfig.dev.json linguist-generated
+/tsconfig.json linguist-generated
+/yarn.lock linguist-generated

package/.prettierignore

@@ -0,0 +1 @@
+# ~~ Generated by projen. To modify, edit .projenrc.js and run "npx projen".

package/.prettierrc.json

@@ -0,0 +1,3 @@
+{
+  "overrides": []
+}

package/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2022 Daniel Schmidt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,43 @@
+# Projen-CDKTF-Hybrid-Construct
+
+Projen template for CDKTF Constructs that should also be used as Terraform Modules.
+
+## Usage
+
+```bash
+mkdir my-new-hybrid-construct
+cd my-new-hybrid-construct
+npx projen typescript
+npm install projen-cdktf-hybrid-construct
+```
+
+Edit the `.projenrc.js`:
+
+```js
+const { HybridModule } = require("projen-cdktf-hybrid-construct");
+
+const project = new HybridModule({
+  defaultReleaseBranch: "main",
+  name: "my-new-hybrid-construct",
+
+  // All options available in the Projen Typescript template
+  // 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. */
+});
+project.synth();
+```
+
+### Roadmap
+
+- [x] Add dedicated file for HCL templates
+- [x] Add example folder
+- [ ] Add `terraform` example folder
+- [ ] [Auto-generate parts of the docs](https://github.com/terraform-aws-modules/terraform-aws-eks/blob/e90c877a741ab3cc4215376a70f7bcc360b6a3d2/.github/workflows/pre-commit.yml)
+- [ ] Add testing strategy
+- [ ] Add deployment scripts to Artifactory
+- [ ] Add deployment scripts to Github Packages
+- [ ] Add construct / option / docs to publish existing module as construct
+- [ ] Add construct for managing multiple repos like this
+- [ ] Add option to manager projen template to bootstrap cdktf app that deploys Artifactory?

package/example/.gitattributes

@@ -0,0 +1,24 @@
+# ~~ Generated by projen. To modify, edit .projenrc.js and run "npx projen".
+
+*.snap linguist-generated
+/.eslintrc.json linguist-generated
+/.gitattributes linguist-generated
+/.github/pull_request_template.md linguist-generated
+/.github/workflows/build.yml linguist-generated
+/.github/workflows/pull-request-lint.yml linguist-generated
+/.github/workflows/release.yml linguist-generated
+/.github/workflows/upgrade-main.yml linguist-generated
+/.gitignore linguist-generated
+/.mergify.yml linguist-generated
+/.npmignore linguist-generated
+/.prettierignore linguist-generated
+/.prettierrc.json linguist-generated
+/.projen/** linguist-generated
+/.projen/deps.json linguist-generated
+/.projen/files.json linguist-generated
+/.projen/tasks.json linguist-generated
+/LICENSE linguist-generated
+/package.json linguist-generated
+/scripts/copy-modules.sh linguist-generated
+/tsconfig.dev.json linguist-generated
+/yarn.lock linguist-generated

package/example/.jsii

@@ -0,0 +1,210 @@
+{
+  "author": {
+    "email": "danielmschmidt92@gmail.com",
+    "name": "Daniel Schmidt",
+    "roles": [
+      "author"
+    ]
+  },
+  "dependencies": {
+    "cdktf": "^0.9.4",
+    "cdktf-tf-module-stack": "^0.0.8",
+    "constructs": "^10.0.25"
+  },
+  "dependencyClosure": {
+    "cdktf": {
+      "submodules": {
+        "cdktf.testingMatchers": {}
+      },
+      "targets": {
+        "dotnet": {
+          "namespace": "HashiCorp.Cdktf",
+          "packageId": "HashiCorp.Cdktf"
+        },
+        "go": {
+          "moduleName": "github.com/hashicorp/terraform-cdk-go",
+          "packageName": "cdktf"
+        },
+        "java": {
+          "maven": {
+            "artifactId": "cdktf",
+            "groupId": "com.hashicorp"
+          },
+          "package": "com.hashicorp.cdktf"
+        },
+        "js": {
+          "npm": "cdktf"
+        },
+        "python": {
+          "distName": "cdktf",
+          "module": "cdktf"
+        }
+      }
+    },
+    "cdktf-tf-module-stack": {
+      "targets": {
+        "js": {
+          "npm": "cdktf-tf-module-stack"
+        },
+        "python": {
+          "distName": "cdktf-tf-module-stack",
+          "module": "cdktf_tf_module_stack"
+        }
+      }
+    },
+    "constructs": {
+      "targets": {
+        "dotnet": {
+          "namespace": "Constructs",
+          "packageId": "Constructs"
+        },
+        "go": {
+          "moduleName": "github.com/aws/constructs-go"
+        },
+        "java": {
+          "maven": {
+            "artifactId": "constructs",
+            "groupId": "software.constructs"
+          },
+          "package": "software.constructs"
+        },
+        "js": {
+          "npm": "constructs"
+        },
+        "python": {
+          "distName": "constructs",
+          "module": "constructs"
+        }
+      }
+    }
+  },
+  "description": "my-module",
+  "docs": {
+    "stability": "stable"
+  },
+  "homepage": "github.com/DanielMSchmidt/my-module",
+  "jsiiVersion": "1.55.1 (build 07d2d90)",
+  "keywords": [
+    "cdk",
+    "cdktf",
+    "cdktf-hybrid"
+  ],
+  "license": "Apache-2.0",
+  "metadata": {
+    "jsii": {
+      "pacmak": {
+        "hasDefaultInterfaces": true
+      }
+    },
+    "tscRootDir": "src"
+  },
+  "name": "my-module",
+  "readme": {
+    "markdown": "# replace this"
+  },
+  "repository": {
+    "type": "git",
+    "url": "github.com/DanielMSchmidt/my-module"
+  },
+  "schema": "jsii/0.10.0",
+  "targets": {
+    "js": {
+      "npm": "my-module"
+    }
+  },
+  "types": {
+    "my-module.MyConstruct": {
+      "assembly": "my-module",
+      "base": "constructs.Construct",
+      "docs": {
+        "stability": "stable"
+      },
+      "fqn": "my-module.MyConstruct",
+      "initializer": {
+        "docs": {
+          "stability": "stable"
+        },
+        "locationInModule": {
+          "filename": "src/index.ts",
+          "line": 8
+        },
+        "parameters": [
+          {
+            "name": "scope",
+            "type": {
+              "fqn": "constructs.Construct"
+            }
+          },
+          {
+            "name": "id",
+            "type": {
+              "primitive": "string"
+            }
+          },
+          {
+            "name": "config",
+            "type": {
+              "fqn": "my-module.MyConstructOptions"
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/index.ts",
+        "line": 7
+      },
+      "name": "MyConstruct",
+      "properties": [
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "locationInModule": {
+            "filename": "src/index.ts",
+            "line": 8
+          },
+          "name": "config",
+          "type": {
+            "fqn": "my-module.MyConstructOptions"
+          }
+        }
+      ],
+      "symbolId": "src/index:MyConstruct"
+    },
+    "my-module.MyConstructOptions": {
+      "assembly": "my-module",
+      "datatype": true,
+      "docs": {
+        "stability": "stable"
+      },
+      "fqn": "my-module.MyConstructOptions",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/index.ts",
+        "line": 3
+      },
+      "name": "MyConstructOptions",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/index.ts",
+            "line": 4
+          },
+          "name": "propertyA",
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "src/index:MyConstructOptions"
+    }
+  },
+  "version": "0.0.0",
+  "fingerprint": "LXRNBKCxxunulhAB9xLnKA+HxpjBvVIPGPTWDGAv1/s="
+}

package/example/.prettierignore

@@ -0,0 +1 @@
+# ~~ Generated by projen. To modify, edit .projenrc.js and run "npx projen".

package/example/.prettierrc.json

@@ -0,0 +1,3 @@
+{
+  "overrides": []
+}

package/example/API.md

@@ -0,0 +1,160 @@
+# API Reference <a name="API Reference" id="api-reference"></a>
+
+## Constructs <a name="Constructs" id="Constructs"></a>
+
+### MyConstruct <a name="MyConstruct" id="my-module.MyConstruct"></a>
+
+#### Initializers <a name="Initializers" id="my-module.MyConstruct.Initializer"></a>
+
+```typescript
+import { MyConstruct } from 'my-module'
+
+new MyConstruct(scope: Construct, id: string, config: MyConstructOptions)
+```
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#my-module.MyConstruct.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
+| <code><a href="#my-module.MyConstruct.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
+| <code><a href="#my-module.MyConstruct.Initializer.parameter.config">config</a></code> | <code><a href="#my-module.MyConstructOptions">MyConstructOptions</a></code> | *No description.* |
+
+---
+
+##### `scope`<sup>Required</sup> <a name="scope" id="my-module.MyConstruct.Initializer.parameter.scope"></a>
+
+- *Type:* constructs.Construct
+
+---
+
+##### `id`<sup>Required</sup> <a name="id" id="my-module.MyConstruct.Initializer.parameter.id"></a>
+
+- *Type:* string
+
+---
+
+##### `config`<sup>Required</sup> <a name="config" id="my-module.MyConstruct.Initializer.parameter.config"></a>
+
+- *Type:* <a href="#my-module.MyConstructOptions">MyConstructOptions</a>
+
+---
+
+#### Methods <a name="Methods" id="Methods"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| <code><a href="#my-module.MyConstruct.toString">toString</a></code> | Returns a string representation of this construct. |
+
+---
+
+##### `toString` <a name="toString" id="my-module.MyConstruct.toString"></a>
+
+```typescript
+public toString(): string
+```
+
+Returns a string representation of this construct.
+
+#### Static Functions <a name="Static Functions" id="Static Functions"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| <code><a href="#my-module.MyConstruct.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
+
+---
+
+##### `isConstruct` <a name="isConstruct" id="my-module.MyConstruct.isConstruct"></a>
+
+```typescript
+import { MyConstruct } from 'my-module'
+
+MyConstruct.isConstruct(x: any)
+```
+
+Checks if `x` is a construct.
+
+Use this method instead of `instanceof` to properly detect `Construct`
+instances, even when the construct library is symlinked.
+
+Explanation: in JavaScript, multiple copies of the `constructs` library on
+disk are seen as independent, completely different libraries. As a
+consequence, the class `Construct` in each copy of the `constructs` library
+is seen as a different class, and an instance of one class will not test as
+`instanceof` the other class. `npm install` will not create installations
+like this, but users may manually symlink construct libraries together or
+use a monorepo tool: in those cases, multiple copies of the `constructs`
+library can be accidentally installed, and `instanceof` will behave
+unpredictably. It is safest to avoid using `instanceof`, and using
+this type-testing method instead.
+
+###### `x`<sup>Required</sup> <a name="x" id="my-module.MyConstruct.isConstruct.parameter.x"></a>
+
+- *Type:* any
+
+Any object.
+
+---
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#my-module.MyConstruct.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
+| <code><a href="#my-module.MyConstruct.property.config">config</a></code> | <code><a href="#my-module.MyConstructOptions">MyConstructOptions</a></code> | *No description.* |
+
+---
+
+##### `node`<sup>Required</sup> <a name="node" id="my-module.MyConstruct.property.node"></a>
+
+```typescript
+public readonly node: Node;
+```
+
+- *Type:* constructs.Node
+
+The tree node.
+
+---
+
+##### `config`<sup>Required</sup> <a name="config" id="my-module.MyConstruct.property.config"></a>
+
+```typescript
+public readonly config: MyConstructOptions;
+```
+
+- *Type:* <a href="#my-module.MyConstructOptions">MyConstructOptions</a>
+
+---
+
+
+## Structs <a name="Structs" id="Structs"></a>
+
+### MyConstructOptions <a name="MyConstructOptions" id="my-module.MyConstructOptions"></a>
+
+#### Initializer <a name="Initializer" id="my-module.MyConstructOptions.Initializer"></a>
+
+```typescript
+import { MyConstructOptions } from 'my-module'
+
+const myConstructOptions: MyConstructOptions = { ... }
+```
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#my-module.MyConstructOptions.property.propertyA">propertyA</a></code> | <code>string</code> | *No description.* |
+
+---
+
+##### `propertyA`<sup>Required</sup> <a name="propertyA" id="my-module.MyConstructOptions.property.propertyA"></a>
+
+```typescript
+public readonly propertyA: string;
+```
+
+- *Type:* string
+
+---
+
+
+