@skeptools/skep-organization-project 0.0.11 → 0.0.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/.jsii +3 -3
  2. package/API.md +91 -2
  3. package/lib/skep-organization-project.js +1 -1
  4. package/package.json +6 -7
package/.jsii CHANGED
@@ -74,7 +74,7 @@
74
74
  "stability": "stable"
75
75
  },
76
76
  "homepage": "git@github.com:skeptools/skep-organization-project.git",
77
- "jsiiVersion": "1.74.0 (build 6d08790)",
77
+ "jsiiVersion": "1.77.0 (build 3e5fa88)",
78
78
  "license": "Apache-2.0",
79
79
  "metadata": {
80
80
  "jsii": {
@@ -167,6 +167,6 @@
167
167
  "symbolId": "src/skep-organization-project:SkepOrganizationProjectOptions"
168
168
  }
169
169
  },
170
- "version": "0.0.11",
171
- "fingerprint": "PAKwjJ2nNfFJuOX8Nk89Jn4dwAmmScQSGslElOmYcCI="
170
+ "version": "0.0.13",
171
+ "fingerprint": "m2BdPdton5ArYPHV39820rHTfcrp8VJZFnuEjrjaTzg="
172
172
  }
package/API.md CHANGED
@@ -19,6 +19,7 @@ const skepOrganizationProjectOptions: SkepOrganizationProjectOptions = { ... }
19
19
  | --- | --- | --- |
20
20
  | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.name">name</a></code> | <code>string</code> | This is the name of your project. |
21
21
  | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
22
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.gitOptions">gitOptions</a></code> | <code>projen.GitOptions</code> | Configuration options for git. |
22
23
  | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.logging">logging</a></code> | <code>projen.LoggerOptions</code> | Configure logging options such as verbosity. |
23
24
  | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.outdir">outdir</a></code> | <code>string</code> | The root directory of the project. |
24
25
  | <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. |
@@ -73,6 +74,7 @@ const skepOrganizationProjectOptions: SkepOrganizationProjectOptions = { ... }
73
74
  | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.packageName">packageName</a></code> | <code>string</code> | The "name" in package.json. |
74
75
  | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.peerDependencyOptions">peerDependencyOptions</a></code> | <code>projen.javascript.PeerDependencyOptions</code> | Options for `peerDeps`. |
75
76
  | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.peerDeps">peerDeps</a></code> | <code>string[]</code> | Peer dependencies for this module. |
77
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.pnpmVersion">pnpmVersion</a></code> | <code>string</code> | The version of PNPM to use if using PNPM as a package manager. |
76
78
  | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.repository">repository</a></code> | <code>string</code> | The repository is the location where the actual code for your package lives. |
77
79
  | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.repositoryDirectory">repositoryDirectory</a></code> | <code>string</code> | If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. |
78
80
  | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.scopedPackagesOptions">scopedPackagesOptions</a></code> | <code>projen.javascript.ScopedPackagesOptions[]</code> | Options for privately hosted scoped packages. |
@@ -151,6 +153,8 @@ const skepOrganizationProjectOptions: SkepOrganizationProjectOptions = { ... }
151
153
  | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.typescriptVersion">typescriptVersion</a></code> | <code>string</code> | TypeScript version to use. |
152
154
  | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.artifactsFolder">artifactsFolder</a></code> | <code>string</code> | Configurable folder for artifacts to package when transitioning from plan to apply. |
153
155
  | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.deploymentEnvironments">deploymentEnvironments</a></code> | <code>{[ key: string ]: @rlmartin-projen/cdktf-project.DeploymentEnvironment}</code> | Add GitHub Wokflows for enabled environments. |
156
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.embeddedNamespace">embeddedNamespace</a></code> | <code>string</code> | Used to scope the embedded packages to avoid naming collisions. |
157
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.embeddedPackages">embeddedPackages</a></code> | <code>{[ key: string ]: @rlmartin-projen/cdktf-project.EmbeddedPackage}</code> | Small functions to be deployed with the other resources in the repo. |
154
158
  | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.nodeScripts">nodeScripts</a></code> | <code>{[ key: string ]: string}</code> | A set of scripts to be added to package.json but not wrapped by projen. |
155
159
  | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.npmrc">npmrc</a></code> | <code>string[]</code> | Raw lines to drop into the workflow's .npmrc file, to access private package. Empty implies no .npmrc required. |
156
160
  | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.repoAdmins">repoAdmins</a></code> | <code>{[ key: string ]: number}</code> | The GitHub Team slug (including the org_name/ prefix) or GitHub username for the teams/people who maintain infrastructure. |
@@ -189,6 +193,18 @@ Whether to commit the managed files by default.
189
193
 
190
194
  ---
191
195
 
196
+ ##### `gitOptions`<sup>Optional</sup> <a name="gitOptions" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.gitOptions"></a>
197
+
198
+ ```typescript
199
+ public readonly gitOptions: GitOptions;
200
+ ```
201
+
202
+ - *Type:* projen.GitOptions
203
+
204
+ Configuration options for git.
205
+
206
+ ---
207
+
192
208
  ##### `logging`<sup>Optional</sup> <a name="logging" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.logging"></a>
193
209
 
194
210
  ```typescript
@@ -997,6 +1013,19 @@ test your module against the lowest peer version required.
997
1013
 
998
1014
  ---
999
1015
 
1016
+ ##### `pnpmVersion`<sup>Optional</sup> <a name="pnpmVersion" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.pnpmVersion"></a>
1017
+
1018
+ ```typescript
1019
+ public readonly pnpmVersion: string;
1020
+ ```
1021
+
1022
+ - *Type:* string
1023
+ - *Default:* "7"
1024
+
1025
+ The version of PNPM to use if using PNPM as a package manager.
1026
+
1027
+ ---
1028
+
1000
1029
  ##### `repository`<sup>Optional</sup> <a name="repository" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.repository"></a>
1001
1030
 
1002
1031
  ```typescript
@@ -2066,6 +2095,35 @@ Add GitHub Wokflows for enabled environments.
2066
2095
 
2067
2096
  ---
2068
2097
 
2098
+ ##### `embeddedNamespace`<sup>Optional</sup> <a name="embeddedNamespace" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.embeddedNamespace"></a>
2099
+
2100
+ ```typescript
2101
+ public readonly embeddedNamespace: string;
2102
+ ```
2103
+
2104
+ - *Type:* string
2105
+ - *Default:* top-level project name
2106
+
2107
+ Used to scope the embedded packages to avoid naming collisions.
2108
+
2109
+ ---
2110
+
2111
+ ##### `embeddedPackages`<sup>Optional</sup> <a name="embeddedPackages" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.embeddedPackages"></a>
2112
+
2113
+ ```typescript
2114
+ public readonly embeddedPackages: {[ key: string ]: EmbeddedPackage};
2115
+ ```
2116
+
2117
+ - *Type:* {[ key: string ]: @rlmartin-projen/cdktf-project.EmbeddedPackage}
2118
+ - *Default:* {}
2119
+
2120
+ Small functions to be deployed with the other resources in the repo.
2121
+
2122
+ Should be viewed more as infrastructure than services. Testing and linting
2123
+ intentionally mirror the overall repo.
2124
+
2125
+ ---
2126
+
2069
2127
  ##### `nodeScripts`<sup>Optional</sup> <a name="nodeScripts" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.nodeScripts"></a>
2070
2128
 
2071
2129
  ```typescript
@@ -2244,6 +2302,7 @@ new SkepOrganizationProject(options: SkepOrganizationProjectOptions)
2244
2302
  | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.removeScript">removeScript</a></code> | Removes the npm script (always successful). |
2245
2303
  | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.renderWorkflowSetup">renderWorkflowSetup</a></code> | Returns the set of workflow steps which should be executed to bootstrap a workflow. |
2246
2304
  | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.setScript">setScript</a></code> | Replaces the contents of an npm package.json script. |
2305
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.addEmbeddedPackage">addEmbeddedPackage</a></code> | *No description.* |
2247
2306
 
2248
2307
  ---
2249
2308
 
@@ -2741,6 +2800,36 @@ The command to execute.
2741
2800
 
2742
2801
  ---
2743
2802
 
2803
+ ##### `addEmbeddedPackage` <a name="addEmbeddedPackage" id="@skeptools/skep-organization-project.SkepOrganizationProject.addEmbeddedPackage"></a>
2804
+
2805
+ ```typescript
2806
+ public addEmbeddedPackage(name: string, config: EmbeddedPackage, majorVersion: number, namespaceOpt?: string): void
2807
+ ```
2808
+
2809
+ ###### `name`<sup>Required</sup> <a name="name" id="@skeptools/skep-organization-project.SkepOrganizationProject.addEmbeddedPackage.parameter.name"></a>
2810
+
2811
+ - *Type:* string
2812
+
2813
+ ---
2814
+
2815
+ ###### `config`<sup>Required</sup> <a name="config" id="@skeptools/skep-organization-project.SkepOrganizationProject.addEmbeddedPackage.parameter.config"></a>
2816
+
2817
+ - *Type:* @rlmartin-projen/cdktf-project.EmbeddedPackage
2818
+
2819
+ ---
2820
+
2821
+ ###### `majorVersion`<sup>Required</sup> <a name="majorVersion" id="@skeptools/skep-organization-project.SkepOrganizationProject.addEmbeddedPackage.parameter.majorVersion"></a>
2822
+
2823
+ - *Type:* number
2824
+
2825
+ ---
2826
+
2827
+ ###### `namespaceOpt`<sup>Optional</sup> <a name="namespaceOpt" id="@skeptools/skep-organization-project.SkepOrganizationProject.addEmbeddedPackage.parameter.namespaceOpt"></a>
2828
+
2829
+ - *Type:* string
2830
+
2831
+ ---
2832
+
2744
2833
 
2745
2834
  #### Properties <a name="Properties" id="Properties"></a>
2746
2835
 
@@ -2788,7 +2877,7 @@ The command to execute.
2788
2877
  | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.buildWorkflow">buildWorkflow</a></code> | <code>projen.build.BuildWorkflow</code> | The PR build GitHub workflow. |
2789
2878
  | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.buildWorkflowJobId">buildWorkflowJobId</a></code> | <code>string</code> | The job ID of the build workflow. |
2790
2879
  | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.jest">jest</a></code> | <code>projen.javascript.Jest</code> | The Jest configuration (if enabled). |
2791
- | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.maxNodeVersion">maxNodeVersion</a></code> | <code>string</code> | Maximum node version required by this pacakge. |
2880
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.maxNodeVersion">maxNodeVersion</a></code> | <code>string</code> | Maximum node version required by this package. |
2792
2881
  | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> | Minimum node.js version required by this package. |
2793
2882
  | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.npmignore">npmignore</a></code> | <code>projen.IgnoreFile</code> | The .npmignore file. |
2794
2883
  | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.prettier">prettier</a></code> | <code>projen.javascript.Prettier</code> | *No description.* |
@@ -3329,7 +3418,7 @@ public readonly maxNodeVersion: string;
3329
3418
 
3330
3419
  - *Type:* string
3331
3420
 
3332
- Maximum node version required by this pacakge.
3421
+ Maximum node version required by this package.
3333
3422
 
3334
3423
  ---
3335
3424
 
package/lib/skep-organization-project.js CHANGED
@@ -25,5 +25,5 @@ class SkepOrganizationProject extends cdktf_project_1.CdktfProject {
25
25
  }
26
26
  exports.SkepOrganizationProject = SkepOrganizationProject;
27
27
  _a = JSII_RTTI_SYMBOL_1;
28
- SkepOrganizationProject[_a] = { fqn: "@skeptools/skep-organization-project.SkepOrganizationProject", version: "0.0.11" };
28
+ SkepOrganizationProject[_a] = { fqn: "@skeptools/skep-organization-project.SkepOrganizationProject", version: "0.0.13" };
29
29
  //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2tlcC1vcmdhbml6YXRpb24tcHJvamVjdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9za2VwLW9yZ2FuaXphdGlvbi1wcm9qZWN0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7O0FBQUEsNkJBQTZCO0FBQzdCLGtFQUFtRjtBQUNuRixvRUFBbUc7QUFNbkcsTUFBTSxZQUFZLEdBQUc7SUFDbkIsb0JBQW9CO0lBQ3BCLGtCQUFrQjtDQUNuQixDQUFDO0FBRUYsTUFBYSx1QkFBd0IsU0FBUSw0QkFBWTtJQUN2RCxZQUFZLE9BQXVDO1FBQ2pELE1BQU0sV0FBVyxHQUFHO1lBQ2xCLEdBQUcsT0FBTztZQUNWLElBQUksRUFBRSwrQkFBYyxDQUFDLENBQUMsR0FBRyxZQUFZLEVBQUUsR0FBRyxDQUFDLE9BQU8sQ0FBQyxJQUFJLElBQUksRUFBRSxDQUFDLENBQUMsQ0FBQztZQUNoRSxpQkFBaUIsRUFBRSx5QkFBUSxDQUFDLE9BQU8sQ0FBQyxnQkFBZ0IsQ0FBQztTQUN0RCxDQUFDO1FBQ0YsTUFBTSxFQUFFLE9BQU8sRUFBRSxXQUFXLEVBQUUsS0FBSyxFQUFFLEdBQUcsNkJBQVksQ0FBQyxXQUFXLEVBQUUsSUFBSSxDQUFDLElBQUksQ0FBQyxTQUFTLEVBQUUsVUFBVSxDQUFDLEVBQUUsSUFBSSxDQUFDLENBQUM7UUFDMUcsS0FBSyxDQUFDLFdBQVcsQ0FBQyxDQUFDO1FBQ25CLHlCQUFRLENBQUMsSUFBSSxFQUFFLEtBQUssQ0FBQyxDQUFDO1FBQ3RCLG1DQUFtQztJQUNyQyxDQUFDOztBQVhILDBEQVlDIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0ICogYXMgcGF0aCBmcm9tICdwYXRoJztcbmltcG9ydCB7IENka3RmUHJvamVjdCwgQ2RrdGZQcm9qZWN0T3B0aW9ucyB9IGZyb20gJ0BybG1hcnRpbi1wcm9qZW4vY2RrdGYtcHJvamVjdCc7XG5pbXBvcnQgeyBhZGRGaWxlcywgYWxsQ2FzZXMsIGxvYWRTZXR0aW5ncywgc3F1YXNoUGFja2FnZXMgfSBmcm9tICdAcmxtYXJ0aW4tcHJvamVuL3Byb2plbi1wcm9qZWN0JztcblxuZXhwb3J0IGludGVyZmFjZSBTa2VwT3JnYW5pemF0aW9uUHJvamVjdE9wdGlvbnMgZXh0ZW5kcyBDZGt0ZlByb2plY3RPcHRpb25zIHtcbiAgcmVhZG9ubHkgb3JnYW5pemF0aW9uTmFtZTogc3RyaW5nO1xufVxuXG5jb25zdCBkZXBlbmRlbmNpZXMgPSBbXG4gICdAc2tlcHRvb2xzL3NrZXBAfjAnLFxuICAndGltZXpvbmUtZW51bUB+MScsXG5dO1xuXG5leHBvcnQgY2xhc3MgU2tlcE9yZ2FuaXphdGlvblByb2plY3QgZXh0ZW5kcyBDZGt0ZlByb2plY3Qge1xuICBjb25zdHJ1Y3RvcihvcHRpb25zOiBTa2VwT3JnYW5pemF0aW9uUHJvamVjdE9wdGlvbnMpIHtcbiAgICBjb25zdCB0ZW1wT3B0aW9ucyA9IHtcbiAgICAgIC4uLm9wdGlvbnMsXG4gICAgICBkZXBzOiBzcXVhc2hQYWNrYWdlcyhbLi4uZGVwZW5kZW5jaWVzLCAuLi4ob3B0aW9ucy5kZXBzIHx8IFtdKV0pLFxuICAgICAgX29yZ2FuaXphdGlvbk5hbWU6IGFsbENhc2VzKG9wdGlvbnMub3JnYW5pemF0aW9uTmFtZSksXG4gICAgfTtcbiAgICBjb25zdCB7IG9wdGlvbnM6IHByb2plY3RPcHRzLCBmaWxlcyB9ID0gbG9hZFNldHRpbmdzKHRlbXBPcHRpb25zLCBwYXRoLmpvaW4oX19kaXJuYW1lLCAnLi4vZmlsZXMnKSwgdHJ1ZSk7XG4gICAgc3VwZXIocHJvamVjdE9wdHMpO1xuICAgIGFkZEZpbGVzKHRoaXMsIGZpbGVzKTtcbiAgICAvLyBBZGQgbm9uLXRlbXBsYXRlZCByZXNvdXJjZXMgaGVyZVxuICB9XG59XG4iXX0=
package/package.json CHANGED
@@ -45,17 +45,16 @@
45
45
  "eslint-plugin-import": "^2.27.5",
46
46
  "jest": "^27",
47
47
  "jest-junit": "^13",
48
- "jsii": "^1.74.0",
49
- "jsii-diff": "^1.74.0",
50
- "jsii-docgen": "^7.0.218",
51
- "jsii-pacmak": "^1.74.0",
52
- "json-schema": "^0.4.0",
48
+ "jsii": "^1.77.0",
49
+ "jsii-diff": "^1.77.0",
50
+ "jsii-docgen": "^7.1.22",
51
+ "jsii-pacmak": "^1.77.0",
53
52
  "npm-check-updates": "^16",
54
53
  "projen": "^0.65.58",
55
54
  "standard-version": "^9",
56
55
  "ts-jest": "^27",
57
56
  "ts-node": "^10.9.1",
58
- "typescript": "^4.9.4"
57
+ "typescript": "^4.9.5"
59
58
  },
60
59
  "peerDependencies": {
61
60
  "@rlmartin-projen/cdktf-project": "~0",
@@ -76,7 +75,7 @@
76
75
  "publishConfig": {
77
76
  "access": "public"
78
77
  },
79
- "version": "0.0.11",
78
+ "version": "0.0.13",
80
79
  "jest": {
81
80
  "testMatch": [
82
81
  "<rootDir>/src/**/__tests__/**/*.ts?(x)",