@skeptools/skep-organization-project 0.0.13 → 0.0.14

package/.gitattributes

@@ -1,4 +1,4 @@
-# ~~ Generated by projen. To modify, edit .projenrc.js and run "npx projen".
+# ~~ Generated by projen. To modify, edit .projenrc.ts and run "npx projen".
 
 *.snap linguist-generated
 /.eslintrc.json linguist-generated

package/.jsii

@@ -74,7 +74,7 @@
     "stability": "stable"
   },
   "homepage": "git@github.com:skeptools/skep-organization-project.git",
-  "jsiiVersion": "1.77.0 (build 3e5fa88)",
+  "jsiiVersion": "1.80.0 (build bce6a1d)",
   "license": "Apache-2.0",
   "metadata": {
     "jsii": {
@@ -167,6 +167,6 @@
       "symbolId": "src/skep-organization-project:SkepOrganizationProjectOptions"
     }
   },
-  "version": "0.0.13",
-  "fingerprint": "m2BdPdton5ArYPHV39820rHTfcrp8VJZFnuEjrjaTzg="
+  "version": "0.0.14",
+  "fingerprint": "jkfq+gdVe/QwkHH/JtDVUoFpepkxAl79smvGa74ogRg="
 }

package/API.md

@@ -1,3 +1,14 @@
+# skep-organization-project
+
+## Usage
+```
+nvm use 14
+npx projen new \
+  --from @skeptools/skep-organization-project \
+  --organization-name "Foo Company" \
+  --projenrc-ts
+```
+
 # API Reference <a name="API Reference" id="api-reference"></a>
 
 
@@ -19,13 +30,14 @@ const skepOrganizationProjectOptions: SkepOrganizationProjectOptions = { ... }
 | --- | --- | --- |
 | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.name">name</a></code> | <code>string</code> | This is the name of your project. |
 | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
+| <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.gitIgnoreOptions">gitIgnoreOptions</a></code> | <code>projen.IgnoreFileOptions</code> | Configuration options for .gitignore file. |
 | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.gitOptions">gitOptions</a></code> | <code>projen.GitOptions</code> | Configuration options for git. |
 | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.logging">logging</a></code> | <code>projen.LoggerOptions</code> | Configure logging options such as verbosity. |
 | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.outdir">outdir</a></code> | <code>string</code> | The root directory of the project. |
 | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.parent">parent</a></code> | <code>projen.Project</code> | The parent project, if this project is part of a bigger project. |
 | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.projenCommand">projenCommand</a></code> | <code>string</code> | The shell command to use in order to run the projen CLI. |
 | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.projenrcJson">projenrcJson</a></code> | <code>boolean</code> | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. |
-| <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.projenrcJsonOptions">projenrcJsonOptions</a></code> | <code>projen.ProjenrcOptions</code> | Options for .projenrc.json. |
+| <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.projenrcJsonOptions">projenrcJsonOptions</a></code> | <code>projen.ProjenrcJsonOptions</code> | Options for .projenrc.json. |
 | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.renovatebot">renovatebot</a></code> | <code>boolean</code> | Use renovatebot to handle dependency upgrades. |
 | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.renovatebotOptions">renovatebotOptions</a></code> | <code>projen.RenovatebotOptions</code> | Options for renovatebot. |
 | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.autoApproveOptions">autoApproveOptions</a></code> | <code>projen.github.AutoApproveOptions</code> | Enable and configure the 'auto approve' workflow. |
@@ -120,6 +132,7 @@ const skepOrganizationProjectOptions: SkepOrganizationProjectOptions = { ... }
 | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.mutableBuild">mutableBuild</a></code> | <code>boolean</code> | Automatically update files modified during builds to pull-request branches. |
 | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.npmignore">npmignore</a></code> | <code>string[]</code> | Additional entries to .npmignore. |
 | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.npmignoreEnabled">npmignoreEnabled</a></code> | <code>boolean</code> | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. |
+| <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.npmIgnoreOptions">npmIgnoreOptions</a></code> | <code>projen.IgnoreFileOptions</code> | Configuration options for .npmignore file. |
 | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.package">package</a></code> | <code>boolean</code> | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). |
 | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.prettier">prettier</a></code> | <code>boolean</code> | Setup prettier. |
 | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.prettierOptions">prettierOptions</a></code> | <code>projen.javascript.PrettierOptions</code> | Prettier options. |
@@ -136,6 +149,7 @@ const skepOrganizationProjectOptions: SkepOrganizationProjectOptions = { ... }
 | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.workflowGitIdentity">workflowGitIdentity</a></code> | <code>projen.github.GitIdentity</code> | The git identity to use in workflows. |
 | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | The node version to use in GitHub workflows. |
 | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.disableTsconfig">disableTsconfig</a></code> | <code>boolean</code> | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). |
+| <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.disableTsconfigDev">disableTsconfigDev</a></code> | <code>boolean</code> | Do not generate a `tsconfig.dev.json` file. |
 | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.docgen">docgen</a></code> | <code>boolean</code> | Docgen by Typedoc. |
 | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.docsDirectory">docsDirectory</a></code> | <code>string</code> | Docs directory. |
 | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.entrypointTypes">entrypointTypes</a></code> | <code>string</code> | The .d.ts file that includes the type declarations for this module. |
@@ -163,6 +177,7 @@ const skepOrganizationProjectOptions: SkepOrganizationProjectOptions = { ... }
 | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.terraformModulesSsh">terraformModulesSsh</a></code> | <code>boolean</code> | Set this to true for local dev when using SSH to connect to GitHub. |
 | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.terraformProviders">terraformProviders</a></code> | <code>string[]</code> | Terraform Providers to add to cdktf.json. |
 | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.terraformVars">terraformVars</a></code> | <code>string[]</code> | List of Terraform variables to pull from GitHub secrets and set as TF_VAR_ environment variables during terraform plan. |
+| <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.terraformVersion">terraformVersion</a></code> | <code>string</code> | The Terraform version to use in the build pipelines. |
 | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.organizationName">organizationName</a></code> | <code>string</code> | *No description.* |
 
 ---
@@ -193,6 +208,18 @@ Whether to commit the managed files by default.
 
 ---
 
+##### `gitIgnoreOptions`<sup>Optional</sup> <a name="gitIgnoreOptions" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.gitIgnoreOptions"></a>
+
+```typescript
+public readonly gitIgnoreOptions: IgnoreFileOptions;
+```
+
+- *Type:* projen.IgnoreFileOptions
+
+Configuration options for .gitignore file.
+
+---
+
 ##### `gitOptions`<sup>Optional</sup> <a name="gitOptions" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.gitOptions"></a>
 
 ```typescript
@@ -280,10 +307,10 @@ Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .pr
 ##### `projenrcJsonOptions`<sup>Optional</sup> <a name="projenrcJsonOptions" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.projenrcJsonOptions"></a>
 
 ```typescript
-public readonly projenrcJsonOptions: ProjenrcOptions;
+public readonly projenrcJsonOptions: ProjenrcJsonOptions;
 ```
 
-- *Type:* projen.ProjenrcOptions
+- *Type:* projen.ProjenrcJsonOptions
 - *Default:* default options
 
 Options for .projenrc.json.
@@ -368,7 +395,7 @@ public readonly clobber: boolean;
 ```
 
 - *Type:* boolean
-- *Default:* true
+- *Default:* true, but false for subprojects
 
 Add a `clobber` task which resets the repo to origin.
 
@@ -1065,7 +1092,9 @@ Options for privately hosted scoped packages.
 
 ---
 
-##### `scripts`<sup>Optional</sup> <a name="scripts" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.scripts"></a>
+##### ~~`scripts`~~<sup>Optional</sup> <a name="scripts" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.scripts"></a>
+
+- *Deprecated:* use `project.addTask()` or `package.setScript()`
 
 ```typescript
 public readonly scripts: {[ key: string ]: string};
@@ -1078,6 +1107,7 @@ npm scripts to include.
 
 If a script has the same name as a standard script,
 the standard script will be overwritten.
+Also adds the script as a task.
 
 ---
 
@@ -1657,6 +1687,18 @@ Defines an .npmignore file. Normally this is only needed for libraries that are
 
 ---
 
+##### `npmIgnoreOptions`<sup>Optional</sup> <a name="npmIgnoreOptions" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.npmIgnoreOptions"></a>
+
+```typescript
+public readonly npmIgnoreOptions: IgnoreFileOptions;
+```
+
+- *Type:* projen.IgnoreFileOptions
+
+Configuration options for .npmignore file.
+
+---
+
 ##### `package`<sup>Optional</sup> <a name="package" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.package"></a>
 
 ```typescript
@@ -1867,6 +1909,19 @@ Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.jso
 
 ---
 
+##### `disableTsconfigDev`<sup>Optional</sup> <a name="disableTsconfigDev" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.disableTsconfigDev"></a>
+
+```typescript
+public readonly disableTsconfigDev: boolean;
+```
+
+- *Type:* boolean
+- *Default:* false
+
+Do not generate a `tsconfig.dev.json` file.
+
+---
+
 ##### `docgen`<sup>Optional</sup> <a name="docgen" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.docgen"></a>
 
 ```typescript
@@ -2236,6 +2291,19 @@ not include the TF_VAR_ prefix.
 
 ---
 
+##### `terraformVersion`<sup>Optional</sup> <a name="terraformVersion" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.terraformVersion"></a>
+
+```typescript
+public readonly terraformVersion: string;
+```
+
+- *Type:* string
+- *Default:* latest
+
+The Terraform version to use in the build pipelines.
+
+---
+
 ##### `organizationName`<sup>Required</sup> <a name="organizationName" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.organizationName"></a>
 
 ```typescript
@@ -2297,6 +2365,7 @@ new SkepOrganizationProject(options: SkepOrganizationProjectOptions)
 | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.addFields">addFields</a></code> | Directly set fields in `package.json`. |
 | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.addKeywords">addKeywords</a></code> | Adds keywords to package.json (deduplicated). |
 | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.addPeerDeps">addPeerDeps</a></code> | Defines peer dependencies. |
+| <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.addScripts">addScripts</a></code> | Replaces the contents of multiple npm package.json scripts. |
 | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.addTestCommand">addTestCommand</a></code> | DEPRECATED. |
 | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.hasScript">hasScript</a></code> | Indicates if a script by the name name is defined. |
 | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.removeScript">removeScript</a></code> | Removes the npm script (always successful). |
@@ -2714,6 +2783,22 @@ add/upgrade`. If you wish to specify a version range use this syntax:
 
 ---
 
+##### `addScripts` <a name="addScripts" id="@skeptools/skep-organization-project.SkepOrganizationProject.addScripts"></a>
+
+```typescript
+public addScripts(scripts: {[ key: string ]: string}): void
+```
+
+Replaces the contents of multiple npm package.json scripts.
+
+###### `scripts`<sup>Required</sup> <a name="scripts" id="@skeptools/skep-organization-project.SkepOrganizationProject.addScripts.parameter.scripts"></a>
+
+- *Type:* {[ key: string ]: string}
+
+The scripts to set.
+
+---
+
 ##### ~~`addTestCommand`~~ <a name="addTestCommand" id="@skeptools/skep-organization-project.SkepOrganizationProject.addTestCommand"></a>
 
 ```typescript
@@ -2728,7 +2813,7 @@ DEPRECATED.
 
 ---
 
-##### `hasScript` <a name="hasScript" id="@skeptools/skep-organization-project.SkepOrganizationProject.hasScript"></a>
+##### ~~`hasScript`~~ <a name="hasScript" id="@skeptools/skep-organization-project.SkepOrganizationProject.hasScript"></a>
 
 ```typescript
 public hasScript(name: string): boolean

package/lib/skep-organization-project.js

@@ -25,5 +25,5 @@ class SkepOrganizationProject extends cdktf_project_1.CdktfProject {
 }
 exports.SkepOrganizationProject = SkepOrganizationProject;
 _a = JSII_RTTI_SYMBOL_1;
-SkepOrganizationProject[_a] = { fqn: "@skeptools/skep-organization-project.SkepOrganizationProject", version: "0.0.13" };
+SkepOrganizationProject[_a] = { fqn: "@skeptools/skep-organization-project.SkepOrganizationProject", version: "0.0.14" };
 //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2tlcC1vcmdhbml6YXRpb24tcHJvamVjdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9za2VwLW9yZ2FuaXphdGlvbi1wcm9qZWN0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7O0FBQUEsNkJBQTZCO0FBQzdCLGtFQUFtRjtBQUNuRixvRUFBbUc7QUFNbkcsTUFBTSxZQUFZLEdBQUc7SUFDbkIsb0JBQW9CO0lBQ3BCLGtCQUFrQjtDQUNuQixDQUFDO0FBRUYsTUFBYSx1QkFBd0IsU0FBUSw0QkFBWTtJQUN2RCxZQUFZLE9BQXVDO1FBQ2pELE1BQU0sV0FBVyxHQUFHO1lBQ2xCLEdBQUcsT0FBTztZQUNWLElBQUksRUFBRSwrQkFBYyxDQUFDLENBQUMsR0FBRyxZQUFZLEVBQUUsR0FBRyxDQUFDLE9BQU8sQ0FBQyxJQUFJLElBQUksRUFBRSxDQUFDLENBQUMsQ0FBQztZQUNoRSxpQkFBaUIsRUFBRSx5QkFBUSxDQUFDLE9BQU8sQ0FBQyxnQkFBZ0IsQ0FBQztTQUN0RCxDQUFDO1FBQ0YsTUFBTSxFQUFFLE9BQU8sRUFBRSxXQUFXLEVBQUUsS0FBSyxFQUFFLEdBQUcsNkJBQVksQ0FBQyxXQUFXLEVBQUUsSUFBSSxDQUFDLElBQUksQ0FBQyxTQUFTLEVBQUUsVUFBVSxDQUFDLEVBQUUsSUFBSSxDQUFDLENBQUM7UUFDMUcsS0FBSyxDQUFDLFdBQVcsQ0FBQyxDQUFDO1FBQ25CLHlCQUFRLENBQUMsSUFBSSxFQUFFLEtBQUssQ0FBQyxDQUFDO1FBQ3RCLG1DQUFtQztJQUNyQyxDQUFDOztBQVhILDBEQVlDIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0ICogYXMgcGF0aCBmcm9tICdwYXRoJztcbmltcG9ydCB7IENka3RmUHJvamVjdCwgQ2RrdGZQcm9qZWN0T3B0aW9ucyB9IGZyb20gJ0BybG1hcnRpbi1wcm9qZW4vY2RrdGYtcHJvamVjdCc7XG5pbXBvcnQgeyBhZGRGaWxlcywgYWxsQ2FzZXMsIGxvYWRTZXR0aW5ncywgc3F1YXNoUGFja2FnZXMgfSBmcm9tICdAcmxtYXJ0aW4tcHJvamVuL3Byb2plbi1wcm9qZWN0JztcblxuZXhwb3J0IGludGVyZmFjZSBTa2VwT3JnYW5pemF0aW9uUHJvamVjdE9wdGlvbnMgZXh0ZW5kcyBDZGt0ZlByb2plY3RPcHRpb25zIHtcbiAgcmVhZG9ubHkgb3JnYW5pemF0aW9uTmFtZTogc3RyaW5nO1xufVxuXG5jb25zdCBkZXBlbmRlbmNpZXMgPSBbXG4gICdAc2tlcHRvb2xzL3NrZXBAfjAnLFxuICAndGltZXpvbmUtZW51bUB+MScsXG5dO1xuXG5leHBvcnQgY2xhc3MgU2tlcE9yZ2FuaXphdGlvblByb2plY3QgZXh0ZW5kcyBDZGt0ZlByb2plY3Qge1xuICBjb25zdHJ1Y3RvcihvcHRpb25zOiBTa2VwT3JnYW5pemF0aW9uUHJvamVjdE9wdGlvbnMpIHtcbiAgICBjb25zdCB0ZW1wT3B0aW9ucyA9IHtcbiAgICAgIC4uLm9wdGlvbnMsXG4gICAgICBkZXBzOiBzcXVhc2hQYWNrYWdlcyhbLi4uZGVwZW5kZW5jaWVzLCAuLi4ob3B0aW9ucy5kZXBzIHx8IFtdKV0pLFxuICAgICAgX29yZ2FuaXphdGlvbk5hbWU6IGFsbENhc2VzKG9wdGlvbnMub3JnYW5pemF0aW9uTmFtZSksXG4gICAgfTtcbiAgICBjb25zdCB7IG9wdGlvbnM6IHByb2plY3RPcHRzLCBmaWxlcyB9ID0gbG9hZFNldHRpbmdzKHRlbXBPcHRpb25zLCBwYXRoLmpvaW4oX19kaXJuYW1lLCAnLi4vZmlsZXMnKSwgdHJ1ZSk7XG4gICAgc3VwZXIocHJvamVjdE9wdHMpO1xuICAgIGFkZEZpbGVzKHRoaXMsIGZpbGVzKTtcbiAgICAvLyBBZGQgbm9uLXRlbXBsYXRlZCByZXNvdXJjZXMgaGVyZVxuICB9XG59XG4iXX0=

package/package.json

@@ -36,19 +36,19 @@
   },
   "devDependencies": {
     "@types/jest": "^27",
-    "@types/node": "^14",
+    "@types/node": "^16",
     "@typescript-eslint/eslint-plugin": "^5",
     "@typescript-eslint/parser": "^5",
     "eslint": "^8",
     "eslint-import-resolver-node": "^0.3.7",
-    "eslint-import-resolver-typescript": "^3.5.3",
+    "eslint-import-resolver-typescript": "^3.5.5",
     "eslint-plugin-import": "^2.27.5",
     "jest": "^27",
-    "jest-junit": "^13",
-    "jsii": "^1.77.0",
-    "jsii-diff": "^1.77.0",
-    "jsii-docgen": "^7.1.22",
-    "jsii-pacmak": "^1.77.0",
+    "jest-junit": "^15",
+    "jsii": "1.x",
+    "jsii-diff": "^1.80.0",
+    "jsii-docgen": "^7.2.1",
+    "jsii-pacmak": "^1.80.0",
     "npm-check-updates": "^16",
     "projen": "^0.65.58",
     "standard-version": "^9",
@@ -70,12 +70,16 @@
   "bundledDependencies": [
     "liquidjs"
   ],
+  "resolutions": {
+    "@types/prettier": "2.6.0",
+    "@types/babel__traverse": "7.18.2"
+  },
   "main": "lib/index.js",
   "license": "Apache-2.0",
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.0.13",
+  "version": "0.0.14",
   "jest": {
     "testMatch": [
       "<rootDir>/src/**/__tests__/**/*.ts?(x)",
@@ -126,9 +130,5 @@
       "rootDir": "src"
     }
   },
-  "resolutions": {
-    "@types/prettier": "2.6.0",
-    "@types/babel__traverse": "7.18.2"
-  },
-  "//": "~~ Generated by projen. To modify, edit .projenrc.js and run \"npx projen\"."
+  "//": "~~ Generated by projen. To modify, edit .projenrc.ts and run \"npx projen\"."
 }