cdklabs-projen-project-types 0.3.36 → 0.5.0
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.
- package/.jsii +603 -24
- package/.yarn/install-state.gz +0 -0
- package/API.md +732 -20
- package/README.md +24 -0
- package/lib/cdk.js +2 -2
- package/lib/cdklabs.js +3 -3
- package/lib/jsii.js +1 -1
- package/lib/rosetta.d.ts +2 -2
- package/lib/rosetta.js +2 -2
- package/lib/yarn/constraints.js +1 -1
- package/lib/yarn/index.d.ts +1 -0
- package/lib/yarn/index.js +2 -1
- package/lib/yarn/jsii-build.d.ts +38 -0
- package/lib/yarn/jsii-build.js +60 -0
- package/lib/yarn/monorepo-release.js +191 -72
- package/lib/yarn/monorepo.js +2 -2
- package/lib/yarn/typescript-workspace-release.d.ts +1 -0
- package/lib/yarn/typescript-workspace-release.js +3 -2
- package/lib/yarn/typescript-workspace.d.ts +2 -0
- package/lib/yarn/typescript-workspace.js +6 -2
- package/package.json +7 -7
package/API.md
CHANGED
|
@@ -13100,19 +13100,19 @@ ensure that rosetta will run successfully
|
|
|
13100
13100
|
```typescript
|
|
13101
13101
|
import { Rosetta } from 'cdklabs-projen-project-types'
|
|
13102
13102
|
|
|
13103
|
-
new Rosetta(project:
|
|
13103
|
+
new Rosetta(project: TypeScriptProject, options?: RosettaOptions)
|
|
13104
13104
|
```
|
|
13105
13105
|
|
|
13106
13106
|
| **Name** | **Type** | **Description** |
|
|
13107
13107
|
| --- | --- | --- |
|
|
13108
|
-
| <code><a href="#cdklabs-projen-project-types.Rosetta.Initializer.parameter.project">project</a></code> | <code>projen.
|
|
13108
|
+
| <code><a href="#cdklabs-projen-project-types.Rosetta.Initializer.parameter.project">project</a></code> | <code>projen.typescript.TypeScriptProject</code> | *No description.* |
|
|
13109
13109
|
| <code><a href="#cdklabs-projen-project-types.Rosetta.Initializer.parameter.options">options</a></code> | <code><a href="#cdklabs-projen-project-types.RosettaOptions">RosettaOptions</a></code> | *No description.* |
|
|
13110
13110
|
|
|
13111
13111
|
---
|
|
13112
13112
|
|
|
13113
13113
|
##### `project`<sup>Required</sup> <a name="project" id="cdklabs-projen-project-types.Rosetta.Initializer.parameter.project"></a>
|
|
13114
13114
|
|
|
13115
|
-
- *Type:* projen.
|
|
13115
|
+
- *Type:* projen.typescript.TypeScriptProject
|
|
13116
13116
|
|
|
13117
13117
|
---
|
|
13118
13118
|
|
|
@@ -14016,7 +14016,7 @@ When given a project, this it the project itself.
|
|
|
14016
14016
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspace.property.testTask">testTask</a></code> | <code>projen.Task</code> | *No description.* |
|
|
14017
14017
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspace.property.defaultTask">defaultTask</a></code> | <code>projen.Task</code> | This is the "default" task, the one that executes "projen". |
|
|
14018
14018
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspace.property.initProject">initProject</a></code> | <code>projen.InitProject</code> | The options used when this project is bootstrapped via `projen new`. |
|
|
14019
|
-
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspace.property.parent">parent</a></code> | <code>projen.
|
|
14019
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspace.property.parent">parent</a></code> | <code>cdklabs-projen-project-types.yarn.Monorepo</code> | A parent project. |
|
|
14020
14020
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspace.property.projectType">projectType</a></code> | <code>projen.ProjectType</code> | *No description.* |
|
|
14021
14021
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspace.property.autoApprove">autoApprove</a></code> | <code>projen.github.AutoApprove</code> | Auto approve set up for this project. |
|
|
14022
14022
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspace.property.devContainer">devContainer</a></code> | <code>projen.vscode.DevContainer</code> | Access for .devcontainer.json (used for GitHub Codespaces). |
|
|
@@ -14348,10 +14348,10 @@ FQN of the project type.
|
|
|
14348
14348
|
##### `parent`<sup>Optional</sup> <a name="parent" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspace.property.parent"></a>
|
|
14349
14349
|
|
|
14350
14350
|
```typescript
|
|
14351
|
-
public readonly parent:
|
|
14351
|
+
public readonly parent: Monorepo;
|
|
14352
14352
|
```
|
|
14353
14353
|
|
|
14354
|
-
- *Type:* projen.
|
|
14354
|
+
- *Type:* cdklabs-projen-project-types.yarn.Monorepo
|
|
14355
14355
|
|
|
14356
14356
|
A parent project.
|
|
14357
14357
|
|
|
@@ -15059,6 +15059,7 @@ Test whether the given construct is a component.
|
|
|
15059
15059
|
| --- | --- | --- |
|
|
15060
15060
|
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceRelease.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
|
|
15061
15061
|
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceRelease.property.project">project</a></code> | <code>projen.Project</code> | *No description.* |
|
|
15062
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceRelease.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | *No description.* |
|
|
15062
15063
|
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceRelease.property.workspace">workspace</a></code> | <code>cdklabs-projen-project-types.yarn.TypeScriptWorkspace</code> | *No description.* |
|
|
15063
15064
|
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceRelease.property.publisher">publisher</a></code> | <code>projen.release.Publisher</code> | *No description.* |
|
|
15064
15065
|
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceRelease.property.version">version</a></code> | <code>projen.Version</code> | *No description.* |
|
|
@@ -15087,6 +15088,16 @@ public readonly project: Project;
|
|
|
15087
15088
|
|
|
15088
15089
|
---
|
|
15089
15090
|
|
|
15091
|
+
##### `artifactsDirectory`<sup>Required</sup> <a name="artifactsDirectory" id="cdklabs-projen-project-types.yarn.WorkspaceRelease.property.artifactsDirectory"></a>
|
|
15092
|
+
|
|
15093
|
+
```typescript
|
|
15094
|
+
public readonly artifactsDirectory: string;
|
|
15095
|
+
```
|
|
15096
|
+
|
|
15097
|
+
- *Type:* string
|
|
15098
|
+
|
|
15099
|
+
---
|
|
15100
|
+
|
|
15090
15101
|
##### `workspace`<sup>Required</sup> <a name="workspace" id="cdklabs-projen-project-types.yarn.WorkspaceRelease.property.workspace"></a>
|
|
15091
15102
|
|
|
15092
15103
|
```typescript
|
|
@@ -34731,6 +34742,295 @@ The version is enforced across all workspaces using Yarn Berry constraints.
|
|
|
34731
34742
|
|
|
34732
34743
|
---
|
|
34733
34744
|
|
|
34745
|
+
### JsiiBuildOptions <a name="JsiiBuildOptions" id="cdklabs-projen-project-types.yarn.JsiiBuildOptions"></a>
|
|
34746
|
+
|
|
34747
|
+
Options for `JsiiBuild`.
|
|
34748
|
+
|
|
34749
|
+
#### Initializer <a name="Initializer" id="cdklabs-projen-project-types.yarn.JsiiBuildOptions.Initializer"></a>
|
|
34750
|
+
|
|
34751
|
+
```typescript
|
|
34752
|
+
import { yarn } from 'cdklabs-projen-project-types'
|
|
34753
|
+
|
|
34754
|
+
const jsiiBuildOptions: yarn.JsiiBuildOptions = { ... }
|
|
34755
|
+
```
|
|
34756
|
+
|
|
34757
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
34758
|
+
|
|
34759
|
+
| **Name** | **Type** | **Description** |
|
|
34760
|
+
| --- | --- | --- |
|
|
34761
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.release.CodeArtifactOptions</code> | Options for publishing npm package to AWS CodeArtifact. |
|
|
34762
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.compat">compat</a></code> | <code>boolean</code> | Automatically run API compatibility test against the latest version published to npm after compilation. |
|
|
34763
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.compatIgnore">compatIgnore</a></code> | <code>string</code> | Name of the ignore file for API compatibility tests. |
|
|
34764
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.compressAssembly">compressAssembly</a></code> | <code>boolean</code> | Emit a compressed version of the assembly. |
|
|
34765
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.docgen">docgen</a></code> | <code>boolean</code> | Generate a MarkDown file describing the jsii API. |
|
|
34766
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.docgenFilePath">docgenFilePath</a></code> | <code>string</code> | File path for generated docs. |
|
|
34767
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.excludeTypescript">excludeTypescript</a></code> | <code>string[]</code> | Accepts a list of glob patterns. |
|
|
34768
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.jsiiVersion">jsiiVersion</a></code> | <code>string</code> | Version of the jsii compiler to use. |
|
|
34769
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.npmTrustedPublishing">npmTrustedPublishing</a></code> | <code>boolean</code> | Whether to use trusted publishing for npm. |
|
|
34770
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.publishToGo">publishToGo</a></code> | <code>projen.cdk.JsiiGoTarget</code> | Publish Go bindings to a git repository. |
|
|
34771
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.publishToMaven">publishToMaven</a></code> | <code>projen.cdk.JsiiJavaTarget</code> | Publish to maven. |
|
|
34772
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.publishToNuget">publishToNuget</a></code> | <code>projen.cdk.JsiiDotNetTarget</code> | Publish to NuGet. |
|
|
34773
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.publishToPypi">publishToPypi</a></code> | <code>projen.cdk.JsiiPythonTarget</code> | Publish to pypi. |
|
|
34774
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.releaseToNpm">releaseToNpm</a></code> | <code>boolean</code> | Whether to publish to npm. |
|
|
34775
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.stability">stability</a></code> | <code>string</code> | The stability of the package. |
|
|
34776
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.workflowBootstrapSteps">workflowBootstrapSteps</a></code> | <code>projen.github.workflows.Step[]</code> | Additional steps to run before packaging in workflows. |
|
|
34777
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | The node version to use in packaging workflows. |
|
|
34778
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.workspaceDirectory">workspaceDirectory</a></code> | <code>string</code> | Relative path of the package within the repository. |
|
|
34779
|
+
|
|
34780
|
+
---
|
|
34781
|
+
|
|
34782
|
+
##### `codeArtifactOptions`<sup>Optional</sup> <a name="codeArtifactOptions" id="cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.codeArtifactOptions"></a>
|
|
34783
|
+
|
|
34784
|
+
```typescript
|
|
34785
|
+
public readonly codeArtifactOptions: CodeArtifactOptions;
|
|
34786
|
+
```
|
|
34787
|
+
|
|
34788
|
+
- *Type:* projen.release.CodeArtifactOptions
|
|
34789
|
+
- *Default:* undefined
|
|
34790
|
+
|
|
34791
|
+
Options for publishing npm package to AWS CodeArtifact.
|
|
34792
|
+
|
|
34793
|
+
---
|
|
34794
|
+
|
|
34795
|
+
##### `compat`<sup>Optional</sup> <a name="compat" id="cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.compat"></a>
|
|
34796
|
+
|
|
34797
|
+
```typescript
|
|
34798
|
+
public readonly compat: boolean;
|
|
34799
|
+
```
|
|
34800
|
+
|
|
34801
|
+
- *Type:* boolean
|
|
34802
|
+
- *Default:* false
|
|
34803
|
+
|
|
34804
|
+
Automatically run API compatibility test against the latest version published to npm after compilation.
|
|
34805
|
+
|
|
34806
|
+
You can manually run compatibility tests using `yarn compat` if this feature is disabled.
|
|
34807
|
+
- You can ignore compatibility failures by adding lines to a ".compatignore" file.
|
|
34808
|
+
|
|
34809
|
+
---
|
|
34810
|
+
|
|
34811
|
+
##### `compatIgnore`<sup>Optional</sup> <a name="compatIgnore" id="cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.compatIgnore"></a>
|
|
34812
|
+
|
|
34813
|
+
```typescript
|
|
34814
|
+
public readonly compatIgnore: string;
|
|
34815
|
+
```
|
|
34816
|
+
|
|
34817
|
+
- *Type:* string
|
|
34818
|
+
- *Default:* ".compatignore"
|
|
34819
|
+
|
|
34820
|
+
Name of the ignore file for API compatibility tests.
|
|
34821
|
+
|
|
34822
|
+
---
|
|
34823
|
+
|
|
34824
|
+
##### `compressAssembly`<sup>Optional</sup> <a name="compressAssembly" id="cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.compressAssembly"></a>
|
|
34825
|
+
|
|
34826
|
+
```typescript
|
|
34827
|
+
public readonly compressAssembly: boolean;
|
|
34828
|
+
```
|
|
34829
|
+
|
|
34830
|
+
- *Type:* boolean
|
|
34831
|
+
- *Default:* false
|
|
34832
|
+
|
|
34833
|
+
Emit a compressed version of the assembly.
|
|
34834
|
+
|
|
34835
|
+
---
|
|
34836
|
+
|
|
34837
|
+
##### `docgen`<sup>Optional</sup> <a name="docgen" id="cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.docgen"></a>
|
|
34838
|
+
|
|
34839
|
+
```typescript
|
|
34840
|
+
public readonly docgen: boolean;
|
|
34841
|
+
```
|
|
34842
|
+
|
|
34843
|
+
- *Type:* boolean
|
|
34844
|
+
- *Default:* true
|
|
34845
|
+
|
|
34846
|
+
Generate a MarkDown file describing the jsii API.
|
|
34847
|
+
|
|
34848
|
+
---
|
|
34849
|
+
|
|
34850
|
+
##### `docgenFilePath`<sup>Optional</sup> <a name="docgenFilePath" id="cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.docgenFilePath"></a>
|
|
34851
|
+
|
|
34852
|
+
```typescript
|
|
34853
|
+
public readonly docgenFilePath: string;
|
|
34854
|
+
```
|
|
34855
|
+
|
|
34856
|
+
- *Type:* string
|
|
34857
|
+
- *Default:* "API.md"
|
|
34858
|
+
|
|
34859
|
+
File path for generated docs.
|
|
34860
|
+
|
|
34861
|
+
---
|
|
34862
|
+
|
|
34863
|
+
##### `excludeTypescript`<sup>Optional</sup> <a name="excludeTypescript" id="cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.excludeTypescript"></a>
|
|
34864
|
+
|
|
34865
|
+
```typescript
|
|
34866
|
+
public readonly excludeTypescript: string[];
|
|
34867
|
+
```
|
|
34868
|
+
|
|
34869
|
+
- *Type:* string[]
|
|
34870
|
+
|
|
34871
|
+
Accepts a list of glob patterns.
|
|
34872
|
+
|
|
34873
|
+
Files matching any of those patterns will be excluded from the TypeScript compiler input.
|
|
34874
|
+
|
|
34875
|
+
By default, jsii will include all *.ts files (except .d.ts files) in the TypeScript compiler input.
|
|
34876
|
+
This can be problematic for example when the package's build or test procedure generates .ts files
|
|
34877
|
+
that cannot be compiled with jsii's compiler settings.
|
|
34878
|
+
|
|
34879
|
+
---
|
|
34880
|
+
|
|
34881
|
+
##### `jsiiVersion`<sup>Optional</sup> <a name="jsiiVersion" id="cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.jsiiVersion"></a>
|
|
34882
|
+
|
|
34883
|
+
```typescript
|
|
34884
|
+
public readonly jsiiVersion: string;
|
|
34885
|
+
```
|
|
34886
|
+
|
|
34887
|
+
- *Type:* string
|
|
34888
|
+
- *Default:* "~5.9.0"
|
|
34889
|
+
|
|
34890
|
+
Version of the jsii compiler to use.
|
|
34891
|
+
|
|
34892
|
+
Set to "*" if you want to manually manage the version of jsii in your
|
|
34893
|
+
project by managing updates to `package.json` on your own.
|
|
34894
|
+
|
|
34895
|
+
NOTE: The jsii compiler releases since 5.0.0 are not semantically versioned
|
|
34896
|
+
and should remain on the same minor, so we recommend using a `~` dependency
|
|
34897
|
+
(e.g. `~5.0.0`).
|
|
34898
|
+
|
|
34899
|
+
---
|
|
34900
|
+
|
|
34901
|
+
##### `npmTrustedPublishing`<sup>Optional</sup> <a name="npmTrustedPublishing" id="cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.npmTrustedPublishing"></a>
|
|
34902
|
+
|
|
34903
|
+
```typescript
|
|
34904
|
+
public readonly npmTrustedPublishing: boolean;
|
|
34905
|
+
```
|
|
34906
|
+
|
|
34907
|
+
- *Type:* boolean
|
|
34908
|
+
- *Default:* false
|
|
34909
|
+
|
|
34910
|
+
Whether to use trusted publishing for npm.
|
|
34911
|
+
|
|
34912
|
+
---
|
|
34913
|
+
|
|
34914
|
+
##### `publishToGo`<sup>Optional</sup> <a name="publishToGo" id="cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.publishToGo"></a>
|
|
34915
|
+
|
|
34916
|
+
```typescript
|
|
34917
|
+
public readonly publishToGo: JsiiGoTarget;
|
|
34918
|
+
```
|
|
34919
|
+
|
|
34920
|
+
- *Type:* projen.cdk.JsiiGoTarget
|
|
34921
|
+
- *Default:* no publishing
|
|
34922
|
+
|
|
34923
|
+
Publish Go bindings to a git repository.
|
|
34924
|
+
|
|
34925
|
+
---
|
|
34926
|
+
|
|
34927
|
+
##### `publishToMaven`<sup>Optional</sup> <a name="publishToMaven" id="cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.publishToMaven"></a>
|
|
34928
|
+
|
|
34929
|
+
```typescript
|
|
34930
|
+
public readonly publishToMaven: JsiiJavaTarget;
|
|
34931
|
+
```
|
|
34932
|
+
|
|
34933
|
+
- *Type:* projen.cdk.JsiiJavaTarget
|
|
34934
|
+
- *Default:* no publishing
|
|
34935
|
+
|
|
34936
|
+
Publish to maven.
|
|
34937
|
+
|
|
34938
|
+
---
|
|
34939
|
+
|
|
34940
|
+
##### `publishToNuget`<sup>Optional</sup> <a name="publishToNuget" id="cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.publishToNuget"></a>
|
|
34941
|
+
|
|
34942
|
+
```typescript
|
|
34943
|
+
public readonly publishToNuget: JsiiDotNetTarget;
|
|
34944
|
+
```
|
|
34945
|
+
|
|
34946
|
+
- *Type:* projen.cdk.JsiiDotNetTarget
|
|
34947
|
+
- *Default:* no publishing
|
|
34948
|
+
|
|
34949
|
+
Publish to NuGet.
|
|
34950
|
+
|
|
34951
|
+
---
|
|
34952
|
+
|
|
34953
|
+
##### `publishToPypi`<sup>Optional</sup> <a name="publishToPypi" id="cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.publishToPypi"></a>
|
|
34954
|
+
|
|
34955
|
+
```typescript
|
|
34956
|
+
public readonly publishToPypi: JsiiPythonTarget;
|
|
34957
|
+
```
|
|
34958
|
+
|
|
34959
|
+
- *Type:* projen.cdk.JsiiPythonTarget
|
|
34960
|
+
- *Default:* no publishing
|
|
34961
|
+
|
|
34962
|
+
Publish to pypi.
|
|
34963
|
+
|
|
34964
|
+
---
|
|
34965
|
+
|
|
34966
|
+
##### `releaseToNpm`<sup>Optional</sup> <a name="releaseToNpm" id="cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.releaseToNpm"></a>
|
|
34967
|
+
|
|
34968
|
+
```typescript
|
|
34969
|
+
public readonly releaseToNpm: boolean;
|
|
34970
|
+
```
|
|
34971
|
+
|
|
34972
|
+
- *Type:* boolean
|
|
34973
|
+
- *Default:* true
|
|
34974
|
+
|
|
34975
|
+
Whether to publish to npm.
|
|
34976
|
+
|
|
34977
|
+
---
|
|
34978
|
+
|
|
34979
|
+
##### `stability`<sup>Optional</sup> <a name="stability" id="cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.stability"></a>
|
|
34980
|
+
|
|
34981
|
+
```typescript
|
|
34982
|
+
public readonly stability: string;
|
|
34983
|
+
```
|
|
34984
|
+
|
|
34985
|
+
- *Type:* string
|
|
34986
|
+
- *Default:* "stable"
|
|
34987
|
+
|
|
34988
|
+
The stability of the package.
|
|
34989
|
+
|
|
34990
|
+
---
|
|
34991
|
+
|
|
34992
|
+
##### `workflowBootstrapSteps`<sup>Optional</sup> <a name="workflowBootstrapSteps" id="cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.workflowBootstrapSteps"></a>
|
|
34993
|
+
|
|
34994
|
+
```typescript
|
|
34995
|
+
public readonly workflowBootstrapSteps: Step[];
|
|
34996
|
+
```
|
|
34997
|
+
|
|
34998
|
+
- *Type:* projen.github.workflows.Step[]
|
|
34999
|
+
- *Default:* []
|
|
35000
|
+
|
|
35001
|
+
Additional steps to run before packaging in workflows.
|
|
35002
|
+
|
|
35003
|
+
---
|
|
35004
|
+
|
|
35005
|
+
##### `workflowNodeVersion`<sup>Optional</sup> <a name="workflowNodeVersion" id="cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.workflowNodeVersion"></a>
|
|
35006
|
+
|
|
35007
|
+
```typescript
|
|
35008
|
+
public readonly workflowNodeVersion: string;
|
|
35009
|
+
```
|
|
35010
|
+
|
|
35011
|
+
- *Type:* string
|
|
35012
|
+
- *Default:* "lts/*"
|
|
35013
|
+
|
|
35014
|
+
The node version to use in packaging workflows.
|
|
35015
|
+
|
|
35016
|
+
---
|
|
35017
|
+
|
|
35018
|
+
##### `workspaceDirectory`<sup>Optional</sup> <a name="workspaceDirectory" id="cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.workspaceDirectory"></a>
|
|
35019
|
+
|
|
35020
|
+
```typescript
|
|
35021
|
+
public readonly workspaceDirectory: string;
|
|
35022
|
+
```
|
|
35023
|
+
|
|
35024
|
+
- *Type:* string
|
|
35025
|
+
- *Default:* "." - root of the repository
|
|
35026
|
+
|
|
35027
|
+
Relative path of the package within the repository.
|
|
35028
|
+
|
|
35029
|
+
This is used in monorepo setups where the package is not at the root.
|
|
35030
|
+
Packaging steps will extract build artifacts into this subdirectory.
|
|
35031
|
+
|
|
35032
|
+
---
|
|
35033
|
+
|
|
34734
35034
|
### MonorepoOptions <a name="MonorepoOptions" id="cdklabs-projen-project-types.yarn.MonorepoOptions"></a>
|
|
34735
35035
|
|
|
34736
35036
|
MonorepoOptions.
|
|
@@ -40155,32 +40455,377 @@ The name of the root workspace if included.
|
|
|
40155
40455
|
|
|
40156
40456
|
---
|
|
40157
40457
|
|
|
40158
|
-
###
|
|
40458
|
+
### WorkspaceJsiiBuildOptions <a name="WorkspaceJsiiBuildOptions" id="cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions"></a>
|
|
40159
40459
|
|
|
40160
|
-
#### Initializer <a name="Initializer" id="cdklabs-projen-project-types.yarn.
|
|
40460
|
+
#### Initializer <a name="Initializer" id="cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.Initializer"></a>
|
|
40161
40461
|
|
|
40162
40462
|
```typescript
|
|
40163
40463
|
import { yarn } from 'cdklabs-projen-project-types'
|
|
40164
40464
|
|
|
40165
|
-
const
|
|
40465
|
+
const workspaceJsiiBuildOptions: yarn.WorkspaceJsiiBuildOptions = { ... }
|
|
40166
40466
|
```
|
|
40167
40467
|
|
|
40168
40468
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
40169
40469
|
|
|
40170
40470
|
| **Name** | **Type** | **Description** |
|
|
40171
40471
|
| --- | --- | --- |
|
|
40172
|
-
| <code><a href="#cdklabs-projen-project-types.yarn.
|
|
40173
|
-
| <code><a href="#cdklabs-projen-project-types.yarn.
|
|
40174
|
-
| <code><a href="#cdklabs-projen-project-types.yarn.
|
|
40175
|
-
| <code><a href="#cdklabs-projen-project-types.yarn.
|
|
40176
|
-
| <code><a href="#cdklabs-projen-project-types.yarn.
|
|
40177
|
-
| <code><a href="#cdklabs-projen-project-types.yarn.
|
|
40178
|
-
| <code><a href="#cdklabs-projen-project-types.yarn.
|
|
40179
|
-
| <code><a href="#cdklabs-projen-project-types.yarn.
|
|
40180
|
-
| <code><a href="#cdklabs-projen-project-types.yarn.
|
|
40181
|
-
| <code><a href="#cdklabs-projen-project-types.yarn.
|
|
40472
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.release.CodeArtifactOptions</code> | Options for publishing npm package to AWS CodeArtifact. |
|
|
40473
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.compat">compat</a></code> | <code>boolean</code> | Automatically run API compatibility test against the latest version published to npm after compilation. |
|
|
40474
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.compatIgnore">compatIgnore</a></code> | <code>string</code> | Name of the ignore file for API compatibility tests. |
|
|
40475
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.compressAssembly">compressAssembly</a></code> | <code>boolean</code> | Emit a compressed version of the assembly. |
|
|
40476
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.docgen">docgen</a></code> | <code>boolean</code> | Generate a MarkDown file describing the jsii API. |
|
|
40477
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.docgenFilePath">docgenFilePath</a></code> | <code>string</code> | File path for generated docs. |
|
|
40478
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.excludeTypescript">excludeTypescript</a></code> | <code>string[]</code> | Accepts a list of glob patterns. |
|
|
40479
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.jsiiVersion">jsiiVersion</a></code> | <code>string</code> | Version of the jsii compiler to use. |
|
|
40480
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.npmTrustedPublishing">npmTrustedPublishing</a></code> | <code>boolean</code> | Whether to use trusted publishing for npm. |
|
|
40481
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.publishToGo">publishToGo</a></code> | <code>projen.cdk.JsiiGoTarget</code> | Publish Go bindings to a git repository. |
|
|
40482
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.publishToMaven">publishToMaven</a></code> | <code>projen.cdk.JsiiJavaTarget</code> | Publish to maven. |
|
|
40483
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.publishToNuget">publishToNuget</a></code> | <code>projen.cdk.JsiiDotNetTarget</code> | Publish to NuGet. |
|
|
40484
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.publishToPypi">publishToPypi</a></code> | <code>projen.cdk.JsiiPythonTarget</code> | Publish to pypi. |
|
|
40485
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.releaseToNpm">releaseToNpm</a></code> | <code>boolean</code> | Whether to publish to npm. |
|
|
40486
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.stability">stability</a></code> | <code>string</code> | The stability of the package. |
|
|
40487
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.workflowBootstrapSteps">workflowBootstrapSteps</a></code> | <code>projen.github.workflows.Step[]</code> | Additional steps to run before packaging in workflows. |
|
|
40488
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | The node version to use in packaging workflows. |
|
|
40489
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.workspaceDirectory">workspaceDirectory</a></code> | <code>string</code> | Relative path of the package within the repository. |
|
|
40490
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.composite">composite</a></code> | <code>boolean</code> | Whether to turn on composite mode for the TypeScript project. |
|
|
40491
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.pypiClassifiers">pypiClassifiers</a></code> | <code>string[]</code> | PyPI classifiers to add to `package.json`. |
|
|
40492
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.rosettaDependencies">rosettaDependencies</a></code> | <code>string[]</code> | Additional example dependencies for Rosetta. |
|
|
40493
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.rosettaStrict">rosettaStrict</a></code> | <code>boolean</code> | Whether to turn on 'strict' mode for Rosetta. |
|
|
40494
|
+
|
|
40495
|
+
---
|
|
40496
|
+
|
|
40497
|
+
##### `codeArtifactOptions`<sup>Optional</sup> <a name="codeArtifactOptions" id="cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.codeArtifactOptions"></a>
|
|
40182
40498
|
|
|
40183
|
-
|
|
40499
|
+
```typescript
|
|
40500
|
+
public readonly codeArtifactOptions: CodeArtifactOptions;
|
|
40501
|
+
```
|
|
40502
|
+
|
|
40503
|
+
- *Type:* projen.release.CodeArtifactOptions
|
|
40504
|
+
- *Default:* undefined
|
|
40505
|
+
|
|
40506
|
+
Options for publishing npm package to AWS CodeArtifact.
|
|
40507
|
+
|
|
40508
|
+
---
|
|
40509
|
+
|
|
40510
|
+
##### `compat`<sup>Optional</sup> <a name="compat" id="cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.compat"></a>
|
|
40511
|
+
|
|
40512
|
+
```typescript
|
|
40513
|
+
public readonly compat: boolean;
|
|
40514
|
+
```
|
|
40515
|
+
|
|
40516
|
+
- *Type:* boolean
|
|
40517
|
+
- *Default:* false
|
|
40518
|
+
|
|
40519
|
+
Automatically run API compatibility test against the latest version published to npm after compilation.
|
|
40520
|
+
|
|
40521
|
+
You can manually run compatibility tests using `yarn compat` if this feature is disabled.
|
|
40522
|
+
- You can ignore compatibility failures by adding lines to a ".compatignore" file.
|
|
40523
|
+
|
|
40524
|
+
---
|
|
40525
|
+
|
|
40526
|
+
##### `compatIgnore`<sup>Optional</sup> <a name="compatIgnore" id="cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.compatIgnore"></a>
|
|
40527
|
+
|
|
40528
|
+
```typescript
|
|
40529
|
+
public readonly compatIgnore: string;
|
|
40530
|
+
```
|
|
40531
|
+
|
|
40532
|
+
- *Type:* string
|
|
40533
|
+
- *Default:* ".compatignore"
|
|
40534
|
+
|
|
40535
|
+
Name of the ignore file for API compatibility tests.
|
|
40536
|
+
|
|
40537
|
+
---
|
|
40538
|
+
|
|
40539
|
+
##### `compressAssembly`<sup>Optional</sup> <a name="compressAssembly" id="cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.compressAssembly"></a>
|
|
40540
|
+
|
|
40541
|
+
```typescript
|
|
40542
|
+
public readonly compressAssembly: boolean;
|
|
40543
|
+
```
|
|
40544
|
+
|
|
40545
|
+
- *Type:* boolean
|
|
40546
|
+
- *Default:* false
|
|
40547
|
+
|
|
40548
|
+
Emit a compressed version of the assembly.
|
|
40549
|
+
|
|
40550
|
+
---
|
|
40551
|
+
|
|
40552
|
+
##### `docgen`<sup>Optional</sup> <a name="docgen" id="cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.docgen"></a>
|
|
40553
|
+
|
|
40554
|
+
```typescript
|
|
40555
|
+
public readonly docgen: boolean;
|
|
40556
|
+
```
|
|
40557
|
+
|
|
40558
|
+
- *Type:* boolean
|
|
40559
|
+
- *Default:* true
|
|
40560
|
+
|
|
40561
|
+
Generate a MarkDown file describing the jsii API.
|
|
40562
|
+
|
|
40563
|
+
---
|
|
40564
|
+
|
|
40565
|
+
##### `docgenFilePath`<sup>Optional</sup> <a name="docgenFilePath" id="cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.docgenFilePath"></a>
|
|
40566
|
+
|
|
40567
|
+
```typescript
|
|
40568
|
+
public readonly docgenFilePath: string;
|
|
40569
|
+
```
|
|
40570
|
+
|
|
40571
|
+
- *Type:* string
|
|
40572
|
+
- *Default:* "API.md"
|
|
40573
|
+
|
|
40574
|
+
File path for generated docs.
|
|
40575
|
+
|
|
40576
|
+
---
|
|
40577
|
+
|
|
40578
|
+
##### `excludeTypescript`<sup>Optional</sup> <a name="excludeTypescript" id="cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.excludeTypescript"></a>
|
|
40579
|
+
|
|
40580
|
+
```typescript
|
|
40581
|
+
public readonly excludeTypescript: string[];
|
|
40582
|
+
```
|
|
40583
|
+
|
|
40584
|
+
- *Type:* string[]
|
|
40585
|
+
|
|
40586
|
+
Accepts a list of glob patterns.
|
|
40587
|
+
|
|
40588
|
+
Files matching any of those patterns will be excluded from the TypeScript compiler input.
|
|
40589
|
+
|
|
40590
|
+
By default, jsii will include all *.ts files (except .d.ts files) in the TypeScript compiler input.
|
|
40591
|
+
This can be problematic for example when the package's build or test procedure generates .ts files
|
|
40592
|
+
that cannot be compiled with jsii's compiler settings.
|
|
40593
|
+
|
|
40594
|
+
---
|
|
40595
|
+
|
|
40596
|
+
##### `jsiiVersion`<sup>Optional</sup> <a name="jsiiVersion" id="cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.jsiiVersion"></a>
|
|
40597
|
+
|
|
40598
|
+
```typescript
|
|
40599
|
+
public readonly jsiiVersion: string;
|
|
40600
|
+
```
|
|
40601
|
+
|
|
40602
|
+
- *Type:* string
|
|
40603
|
+
- *Default:* "~5.9.0"
|
|
40604
|
+
|
|
40605
|
+
Version of the jsii compiler to use.
|
|
40606
|
+
|
|
40607
|
+
Set to "*" if you want to manually manage the version of jsii in your
|
|
40608
|
+
project by managing updates to `package.json` on your own.
|
|
40609
|
+
|
|
40610
|
+
NOTE: The jsii compiler releases since 5.0.0 are not semantically versioned
|
|
40611
|
+
and should remain on the same minor, so we recommend using a `~` dependency
|
|
40612
|
+
(e.g. `~5.0.0`).
|
|
40613
|
+
|
|
40614
|
+
---
|
|
40615
|
+
|
|
40616
|
+
##### `npmTrustedPublishing`<sup>Optional</sup> <a name="npmTrustedPublishing" id="cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.npmTrustedPublishing"></a>
|
|
40617
|
+
|
|
40618
|
+
```typescript
|
|
40619
|
+
public readonly npmTrustedPublishing: boolean;
|
|
40620
|
+
```
|
|
40621
|
+
|
|
40622
|
+
- *Type:* boolean
|
|
40623
|
+
- *Default:* false
|
|
40624
|
+
|
|
40625
|
+
Whether to use trusted publishing for npm.
|
|
40626
|
+
|
|
40627
|
+
---
|
|
40628
|
+
|
|
40629
|
+
##### `publishToGo`<sup>Optional</sup> <a name="publishToGo" id="cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.publishToGo"></a>
|
|
40630
|
+
|
|
40631
|
+
```typescript
|
|
40632
|
+
public readonly publishToGo: JsiiGoTarget;
|
|
40633
|
+
```
|
|
40634
|
+
|
|
40635
|
+
- *Type:* projen.cdk.JsiiGoTarget
|
|
40636
|
+
- *Default:* no publishing
|
|
40637
|
+
|
|
40638
|
+
Publish Go bindings to a git repository.
|
|
40639
|
+
|
|
40640
|
+
---
|
|
40641
|
+
|
|
40642
|
+
##### `publishToMaven`<sup>Optional</sup> <a name="publishToMaven" id="cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.publishToMaven"></a>
|
|
40643
|
+
|
|
40644
|
+
```typescript
|
|
40645
|
+
public readonly publishToMaven: JsiiJavaTarget;
|
|
40646
|
+
```
|
|
40647
|
+
|
|
40648
|
+
- *Type:* projen.cdk.JsiiJavaTarget
|
|
40649
|
+
- *Default:* no publishing
|
|
40650
|
+
|
|
40651
|
+
Publish to maven.
|
|
40652
|
+
|
|
40653
|
+
---
|
|
40654
|
+
|
|
40655
|
+
##### `publishToNuget`<sup>Optional</sup> <a name="publishToNuget" id="cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.publishToNuget"></a>
|
|
40656
|
+
|
|
40657
|
+
```typescript
|
|
40658
|
+
public readonly publishToNuget: JsiiDotNetTarget;
|
|
40659
|
+
```
|
|
40660
|
+
|
|
40661
|
+
- *Type:* projen.cdk.JsiiDotNetTarget
|
|
40662
|
+
- *Default:* no publishing
|
|
40663
|
+
|
|
40664
|
+
Publish to NuGet.
|
|
40665
|
+
|
|
40666
|
+
---
|
|
40667
|
+
|
|
40668
|
+
##### `publishToPypi`<sup>Optional</sup> <a name="publishToPypi" id="cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.publishToPypi"></a>
|
|
40669
|
+
|
|
40670
|
+
```typescript
|
|
40671
|
+
public readonly publishToPypi: JsiiPythonTarget;
|
|
40672
|
+
```
|
|
40673
|
+
|
|
40674
|
+
- *Type:* projen.cdk.JsiiPythonTarget
|
|
40675
|
+
- *Default:* no publishing
|
|
40676
|
+
|
|
40677
|
+
Publish to pypi.
|
|
40678
|
+
|
|
40679
|
+
---
|
|
40680
|
+
|
|
40681
|
+
##### `releaseToNpm`<sup>Optional</sup> <a name="releaseToNpm" id="cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.releaseToNpm"></a>
|
|
40682
|
+
|
|
40683
|
+
```typescript
|
|
40684
|
+
public readonly releaseToNpm: boolean;
|
|
40685
|
+
```
|
|
40686
|
+
|
|
40687
|
+
- *Type:* boolean
|
|
40688
|
+
- *Default:* true
|
|
40689
|
+
|
|
40690
|
+
Whether to publish to npm.
|
|
40691
|
+
|
|
40692
|
+
---
|
|
40693
|
+
|
|
40694
|
+
##### `stability`<sup>Optional</sup> <a name="stability" id="cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.stability"></a>
|
|
40695
|
+
|
|
40696
|
+
```typescript
|
|
40697
|
+
public readonly stability: string;
|
|
40698
|
+
```
|
|
40699
|
+
|
|
40700
|
+
- *Type:* string
|
|
40701
|
+
- *Default:* "stable"
|
|
40702
|
+
|
|
40703
|
+
The stability of the package.
|
|
40704
|
+
|
|
40705
|
+
---
|
|
40706
|
+
|
|
40707
|
+
##### `workflowBootstrapSteps`<sup>Optional</sup> <a name="workflowBootstrapSteps" id="cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.workflowBootstrapSteps"></a>
|
|
40708
|
+
|
|
40709
|
+
```typescript
|
|
40710
|
+
public readonly workflowBootstrapSteps: Step[];
|
|
40711
|
+
```
|
|
40712
|
+
|
|
40713
|
+
- *Type:* projen.github.workflows.Step[]
|
|
40714
|
+
- *Default:* []
|
|
40715
|
+
|
|
40716
|
+
Additional steps to run before packaging in workflows.
|
|
40717
|
+
|
|
40718
|
+
---
|
|
40719
|
+
|
|
40720
|
+
##### `workflowNodeVersion`<sup>Optional</sup> <a name="workflowNodeVersion" id="cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.workflowNodeVersion"></a>
|
|
40721
|
+
|
|
40722
|
+
```typescript
|
|
40723
|
+
public readonly workflowNodeVersion: string;
|
|
40724
|
+
```
|
|
40725
|
+
|
|
40726
|
+
- *Type:* string
|
|
40727
|
+
- *Default:* "lts/*"
|
|
40728
|
+
|
|
40729
|
+
The node version to use in packaging workflows.
|
|
40730
|
+
|
|
40731
|
+
---
|
|
40732
|
+
|
|
40733
|
+
##### `workspaceDirectory`<sup>Optional</sup> <a name="workspaceDirectory" id="cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.workspaceDirectory"></a>
|
|
40734
|
+
|
|
40735
|
+
```typescript
|
|
40736
|
+
public readonly workspaceDirectory: string;
|
|
40737
|
+
```
|
|
40738
|
+
|
|
40739
|
+
- *Type:* string
|
|
40740
|
+
- *Default:* "." - root of the repository
|
|
40741
|
+
|
|
40742
|
+
Relative path of the package within the repository.
|
|
40743
|
+
|
|
40744
|
+
This is used in monorepo setups where the package is not at the root.
|
|
40745
|
+
Packaging steps will extract build artifacts into this subdirectory.
|
|
40746
|
+
|
|
40747
|
+
---
|
|
40748
|
+
|
|
40749
|
+
##### `composite`<sup>Optional</sup> <a name="composite" id="cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.composite"></a>
|
|
40750
|
+
|
|
40751
|
+
```typescript
|
|
40752
|
+
public readonly composite: boolean;
|
|
40753
|
+
```
|
|
40754
|
+
|
|
40755
|
+
- *Type:* boolean
|
|
40756
|
+
- *Default:* false
|
|
40757
|
+
|
|
40758
|
+
Whether to turn on composite mode for the TypeScript project.
|
|
40759
|
+
|
|
40760
|
+
---
|
|
40761
|
+
|
|
40762
|
+
##### `pypiClassifiers`<sup>Optional</sup> <a name="pypiClassifiers" id="cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.pypiClassifiers"></a>
|
|
40763
|
+
|
|
40764
|
+
```typescript
|
|
40765
|
+
public readonly pypiClassifiers: string[];
|
|
40766
|
+
```
|
|
40767
|
+
|
|
40768
|
+
- *Type:* string[]
|
|
40769
|
+
- *Default:* none
|
|
40770
|
+
|
|
40771
|
+
PyPI classifiers to add to `package.json`.
|
|
40772
|
+
|
|
40773
|
+
---
|
|
40774
|
+
|
|
40775
|
+
##### `rosettaDependencies`<sup>Optional</sup> <a name="rosettaDependencies" id="cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.rosettaDependencies"></a>
|
|
40776
|
+
|
|
40777
|
+
```typescript
|
|
40778
|
+
public readonly rosettaDependencies: string[];
|
|
40779
|
+
```
|
|
40780
|
+
|
|
40781
|
+
- *Type:* string[]
|
|
40782
|
+
- *Default:* []
|
|
40783
|
+
|
|
40784
|
+
Additional example dependencies for Rosetta.
|
|
40785
|
+
|
|
40786
|
+
> [https://github.com/aws/jsii-rosetta?tab=readme-ov-file#dependencies](https://github.com/aws/jsii-rosetta?tab=readme-ov-file#dependencies)
|
|
40787
|
+
|
|
40788
|
+
---
|
|
40789
|
+
|
|
40790
|
+
##### `rosettaStrict`<sup>Optional</sup> <a name="rosettaStrict" id="cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.rosettaStrict"></a>
|
|
40791
|
+
|
|
40792
|
+
```typescript
|
|
40793
|
+
public readonly rosettaStrict: boolean;
|
|
40794
|
+
```
|
|
40795
|
+
|
|
40796
|
+
- *Type:* boolean
|
|
40797
|
+
- *Default:* true
|
|
40798
|
+
|
|
40799
|
+
Whether to turn on 'strict' mode for Rosetta.
|
|
40800
|
+
|
|
40801
|
+
---
|
|
40802
|
+
|
|
40803
|
+
### WorkspaceReleaseOptions <a name="WorkspaceReleaseOptions" id="cdklabs-projen-project-types.yarn.WorkspaceReleaseOptions"></a>
|
|
40804
|
+
|
|
40805
|
+
#### Initializer <a name="Initializer" id="cdklabs-projen-project-types.yarn.WorkspaceReleaseOptions.Initializer"></a>
|
|
40806
|
+
|
|
40807
|
+
```typescript
|
|
40808
|
+
import { yarn } from 'cdklabs-projen-project-types'
|
|
40809
|
+
|
|
40810
|
+
const workspaceReleaseOptions: yarn.WorkspaceReleaseOptions = { ... }
|
|
40811
|
+
```
|
|
40812
|
+
|
|
40813
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
40814
|
+
|
|
40815
|
+
| **Name** | **Type** | **Description** |
|
|
40816
|
+
| --- | --- | --- |
|
|
40817
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceReleaseOptions.property.private">private</a></code> | <code>boolean</code> | *No description.* |
|
|
40818
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceReleaseOptions.property.versionBranchOptions">versionBranchOptions</a></code> | <code>projen.VersionBranchOptions</code> | *No description.* |
|
|
40819
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceReleaseOptions.property.environment">environment</a></code> | <code>string</code> | *No description.* |
|
|
40820
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceReleaseOptions.property.nextVersionCommand">nextVersionCommand</a></code> | <code>string</code> | *No description.* |
|
|
40821
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceReleaseOptions.property.npmDistTag">npmDistTag</a></code> | <code>string</code> | *No description.* |
|
|
40822
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceReleaseOptions.property.npmTrustedPublishing">npmTrustedPublishing</a></code> | <code>boolean</code> | *No description.* |
|
|
40823
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceReleaseOptions.property.publishToNpm">publishToNpm</a></code> | <code>boolean</code> | *No description.* |
|
|
40824
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceReleaseOptions.property.releasableCommits">releasableCommits</a></code> | <code>projen.ReleasableCommits</code> | *No description.* |
|
|
40825
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceReleaseOptions.property.repoRuntimeDependencies">repoRuntimeDependencies</a></code> | <code>{[ key: string ]: string}</code> | For runtime and peer dependencies, the type of dependency we take on each package. |
|
|
40826
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceReleaseOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | *No description.* |
|
|
40827
|
+
|
|
40828
|
+
---
|
|
40184
40829
|
|
|
40185
40830
|
##### `private`<sup>Required</sup> <a name="private" id="cdklabs-projen-project-types.yarn.WorkspaceReleaseOptions.property.private"></a>
|
|
40186
40831
|
|
|
@@ -40285,6 +40930,73 @@ public readonly workflowNodeVersion: string;
|
|
|
40285
40930
|
|
|
40286
40931
|
---
|
|
40287
40932
|
|
|
40933
|
+
## Classes <a name="Classes" id="Classes"></a>
|
|
40934
|
+
|
|
40935
|
+
### WorkspaceJsiiBuild <a name="WorkspaceJsiiBuild" id="cdklabs-projen-project-types.yarn.WorkspaceJsiiBuild"></a>
|
|
40936
|
+
|
|
40937
|
+
- *Implements:* constructs.IMixin
|
|
40938
|
+
|
|
40939
|
+
A mixin that applies the upstream projen JsiiBuild to a TypeScriptWorkspace, adding monorepo-appropriate defaults (Rosetta, composite, pypiClassifiers).
|
|
40940
|
+
|
|
40941
|
+
#### Initializers <a name="Initializers" id="cdklabs-projen-project-types.yarn.WorkspaceJsiiBuild.Initializer"></a>
|
|
40942
|
+
|
|
40943
|
+
```typescript
|
|
40944
|
+
import { yarn } from 'cdklabs-projen-project-types'
|
|
40945
|
+
|
|
40946
|
+
new yarn.WorkspaceJsiiBuild(options?: WorkspaceJsiiBuildOptions)
|
|
40947
|
+
```
|
|
40948
|
+
|
|
40949
|
+
| **Name** | **Type** | **Description** |
|
|
40950
|
+
| --- | --- | --- |
|
|
40951
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceJsiiBuild.Initializer.parameter.options">options</a></code> | <code>cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions</code> | *No description.* |
|
|
40952
|
+
|
|
40953
|
+
---
|
|
40954
|
+
|
|
40955
|
+
##### `options`<sup>Optional</sup> <a name="options" id="cdklabs-projen-project-types.yarn.WorkspaceJsiiBuild.Initializer.parameter.options"></a>
|
|
40956
|
+
|
|
40957
|
+
- *Type:* cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions
|
|
40958
|
+
|
|
40959
|
+
---
|
|
40960
|
+
|
|
40961
|
+
#### Methods <a name="Methods" id="Methods"></a>
|
|
40962
|
+
|
|
40963
|
+
| **Name** | **Description** |
|
|
40964
|
+
| --- | --- |
|
|
40965
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceJsiiBuild.applyTo">applyTo</a></code> | Applies the mixin functionality to the target construct. |
|
|
40966
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceJsiiBuild.supports">supports</a></code> | Determines whether this mixin can be applied to the given construct. |
|
|
40967
|
+
|
|
40968
|
+
---
|
|
40969
|
+
|
|
40970
|
+
##### `applyTo` <a name="applyTo" id="cdklabs-projen-project-types.yarn.WorkspaceJsiiBuild.applyTo"></a>
|
|
40971
|
+
|
|
40972
|
+
```typescript
|
|
40973
|
+
public applyTo(construct: IConstruct): void
|
|
40974
|
+
```
|
|
40975
|
+
|
|
40976
|
+
Applies the mixin functionality to the target construct.
|
|
40977
|
+
|
|
40978
|
+
###### `construct`<sup>Required</sup> <a name="construct" id="cdklabs-projen-project-types.yarn.WorkspaceJsiiBuild.applyTo.parameter.construct"></a>
|
|
40979
|
+
|
|
40980
|
+
- *Type:* constructs.IConstruct
|
|
40981
|
+
|
|
40982
|
+
---
|
|
40983
|
+
|
|
40984
|
+
##### `supports` <a name="supports" id="cdklabs-projen-project-types.yarn.WorkspaceJsiiBuild.supports"></a>
|
|
40985
|
+
|
|
40986
|
+
```typescript
|
|
40987
|
+
public supports(construct: IConstruct): boolean
|
|
40988
|
+
```
|
|
40989
|
+
|
|
40990
|
+
Determines whether this mixin can be applied to the given construct.
|
|
40991
|
+
|
|
40992
|
+
###### `construct`<sup>Required</sup> <a name="construct" id="cdklabs-projen-project-types.yarn.WorkspaceJsiiBuild.supports.parameter.construct"></a>
|
|
40993
|
+
|
|
40994
|
+
- *Type:* constructs.IConstruct
|
|
40995
|
+
|
|
40996
|
+
---
|
|
40997
|
+
|
|
40998
|
+
|
|
40999
|
+
|
|
40288
41000
|
|
|
40289
41001
|
## Protocols <a name="Protocols" id="Protocols"></a>
|
|
40290
41002
|
|