@nikovirtala/projen-constructs 0.3.2 → 0.3.3
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 +270 -282
- package/README.md +144 -11
- package/docs/api/classes/AwsCdkConstructLibraryProject.html +1 -1
- package/docs/api/classes/AwsCdkTypeScriptAppProject.html +1 -1
- package/docs/api/classes/JsiiProject.html +1 -1
- package/docs/api/classes/TypeScriptProject.html +1 -1
- package/docs/api/index.html +152 -12
- package/docs/api/interfaces/AwsCdkConstructLibraryProjectOptions.html +4 -7
- package/docs/api/interfaces/AwsCdkTypeScriptAppProjectOptions.html +4 -7
- package/docs/api/interfaces/JsiiProjectOptions.html +4 -7
- package/docs/api/interfaces/TypeScriptProjectOptions.html +4 -7
- package/lib/components/bundle-lambda-function-code.js +3 -3
- package/lib/components/colima.js +1 -1
- package/lib/components/homebrew.js +1 -1
- package/lib/components/lambda-function-construct-generator.js +1 -1
- package/lib/components/localstack.js +1 -1
- package/lib/components/mise.js +1 -1
- package/lib/components/typedoc.js +1 -1
- package/lib/components/vitest.js +1 -1
- package/lib/project-generator.d.ts +17 -1
- package/lib/project-generator.js +47 -4
- package/lib/projects/awscdk-construct-library-options.generated.d.ts +1 -2
- package/lib/projects/awscdk-construct-library-options.generated.js +1 -1
- package/lib/projects/awscdk-construct-library.generated.js +1 -1
- package/lib/projects/awscdk-typescript-app-options.generated.d.ts +1 -2
- package/lib/projects/awscdk-typescript-app-options.generated.js +1 -1
- package/lib/projects/awscdk-typescript-app.generated.js +1 -1
- package/lib/projects/jsii-options.generated.d.ts +1 -2
- package/lib/projects/jsii-options.generated.js +1 -1
- package/lib/projects/jsii.generated.js +1 -1
- package/lib/projects/typescript-options.generated.d.ts +1 -2
- package/lib/projects/typescript-options.generated.js +1 -1
- package/lib/projects/typescript.generated.js +1 -1
- package/package.json +1 -1
|
@@ -1570,15 +1570,12 @@ subprojects.</p>
|
|
|
1570
1570
|
</div>
|
|
1571
1571
|
<div class="tsd-comment tsd-typography">
|
|
1572
1572
|
<div class="tsd-tag-default">
|
|
1573
|
-
<h4 class="tsd-anchor-link" id="default-74">Default<a href="#default-74" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><
|
|
1574
|
-
|
|
1575
|
-
|
|
1573
|
+
<h4 class="tsd-anchor-link" id="default-74">Default<a href="#default-74" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">- </span><span class="hl-5">pnpm</span>
|
|
1574
|
+
</code><button type="button">Copy</button></pre>
|
|
1575
|
+
|
|
1576
1576
|
</div>
|
|
1577
1577
|
<div class="tsd-tag-stability">
|
|
1578
1578
|
<h4 class="tsd-anchor-link" id="stability-90">Stability<a href="#stability-90" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
1579
|
-
</div>
|
|
1580
|
-
<div class="tsd-tag-pjnew">
|
|
1581
|
-
<h4 class="tsd-anchor-link" id="pjnew-1">Pjnew<a href="#pjnew-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>$PACKAGE_MANAGER</p>
|
|
1582
1579
|
</div></div></section>
|
|
1583
1580
|
<section class="tsd-panel tsd-member">
|
|
1584
1581
|
<h3 class="tsd-anchor-link" id="packagename"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>package<wbr/>Name</span><a href="#packagename" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
@@ -1824,7 +1821,7 @@ Can be used to customize in special environments.</p>
|
|
|
1824
1821
|
<h4 class="tsd-anchor-link" id="stability-107">Stability<a href="#stability-107" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
1825
1822
|
</div>
|
|
1826
1823
|
<div class="tsd-tag-pjnew">
|
|
1827
|
-
<h4 class="tsd-anchor-link" id="pjnew-
|
|
1824
|
+
<h4 class="tsd-anchor-link" id="pjnew-1">Pjnew<a href="#pjnew-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>true</p>
|
|
1828
1825
|
</div></div></section>
|
|
1829
1826
|
<section class="tsd-panel tsd-member">
|
|
1830
1827
|
<h3 class="tsd-anchor-link" id="projenrctsoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>projenrc<wbr/>Ts<wbr/>Options</span><a href="#projenrctsoptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
@@ -1430,15 +1430,12 @@ subprojects.</p>
|
|
|
1430
1430
|
</div>
|
|
1431
1431
|
<div class="tsd-comment tsd-typography">
|
|
1432
1432
|
<div class="tsd-tag-default">
|
|
1433
|
-
<h4 class="tsd-anchor-link" id="default-67">Default<a href="#default-67" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><
|
|
1434
|
-
|
|
1435
|
-
|
|
1433
|
+
<h4 class="tsd-anchor-link" id="default-67">Default<a href="#default-67" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">- </span><span class="hl-5">pnpm</span>
|
|
1434
|
+
</code><button type="button">Copy</button></pre>
|
|
1435
|
+
|
|
1436
1436
|
</div>
|
|
1437
1437
|
<div class="tsd-tag-stability">
|
|
1438
1438
|
<h4 class="tsd-anchor-link" id="stability-82">Stability<a href="#stability-82" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
1439
|
-
</div>
|
|
1440
|
-
<div class="tsd-tag-pjnew">
|
|
1441
|
-
<h4 class="tsd-anchor-link" id="pjnew">Pjnew<a href="#pjnew" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>$PACKAGE_MANAGER</p>
|
|
1442
1439
|
</div></div></section>
|
|
1443
1440
|
<section class="tsd-panel tsd-member">
|
|
1444
1441
|
<h3 class="tsd-anchor-link" id="packagename"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>package<wbr/>Name</span><a href="#packagename" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
@@ -1684,7 +1681,7 @@ Can be used to customize in special environments.</p>
|
|
|
1684
1681
|
<h4 class="tsd-anchor-link" id="stability-99">Stability<a href="#stability-99" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
1685
1682
|
</div>
|
|
1686
1683
|
<div class="tsd-tag-pjnew">
|
|
1687
|
-
<h4 class="tsd-anchor-link" id="pjnew
|
|
1684
|
+
<h4 class="tsd-anchor-link" id="pjnew">Pjnew<a href="#pjnew" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>true</p>
|
|
1688
1685
|
</div></div></section>
|
|
1689
1686
|
<section class="tsd-panel tsd-member">
|
|
1690
1687
|
<h3 class="tsd-anchor-link" id="projenrctsoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>projenrc<wbr/>Ts<wbr/>Options</span><a href="#projenrctsoptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
@@ -55,7 +55,7 @@ function convertToPosixPath(p) {
|
|
|
55
55
|
return p.split(node_path_1.sep).join(node_path_1.posix.sep);
|
|
56
56
|
}
|
|
57
57
|
class Bundler extends projen_1.Component {
|
|
58
|
-
static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.Bundler", version: "0.3.
|
|
58
|
+
static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.Bundler", version: "0.3.3" };
|
|
59
59
|
static of(project) {
|
|
60
60
|
const isBundler = (o) => o instanceof Bundler;
|
|
61
61
|
return project.components.find(isBundler);
|
|
@@ -157,7 +157,7 @@ class Bundler extends projen_1.Component {
|
|
|
157
157
|
}
|
|
158
158
|
exports.Bundler = Bundler;
|
|
159
159
|
class LambdaFunctionCodeBundle extends projen_1.Component {
|
|
160
|
-
static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.LambdaFunctionCodeBundle", version: "0.3.
|
|
160
|
+
static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.LambdaFunctionCodeBundle", version: "0.3.3" };
|
|
161
161
|
constructor(project, options) {
|
|
162
162
|
super(project);
|
|
163
163
|
const bundler = Bundler.of(project);
|
|
@@ -200,7 +200,7 @@ class LambdaFunctionCodeBundle extends projen_1.Component {
|
|
|
200
200
|
}
|
|
201
201
|
exports.LambdaFunctionCodeBundle = LambdaFunctionCodeBundle;
|
|
202
202
|
class LambdaFunctionCodeBundler extends projen_1.Component {
|
|
203
|
-
static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.LambdaFunctionCodeBundler", version: "0.3.
|
|
203
|
+
static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.LambdaFunctionCodeBundler", version: "0.3.3" };
|
|
204
204
|
constructor(project, options) {
|
|
205
205
|
super(project);
|
|
206
206
|
const entrypoints = [];
|
package/lib/components/colima.js
CHANGED
|
@@ -6,7 +6,7 @@ const component_1 = require("projen/lib/component");
|
|
|
6
6
|
const task_shell_1 = require("projen/lib/task-shell");
|
|
7
7
|
const homebrew_1 = require("./homebrew");
|
|
8
8
|
class Colima extends component_1.Component {
|
|
9
|
-
static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.Colima", version: "0.3.
|
|
9
|
+
static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.Colima", version: "0.3.3" };
|
|
10
10
|
constructor(scope) {
|
|
11
11
|
super(scope);
|
|
12
12
|
const project = this.project;
|
|
@@ -6,7 +6,7 @@ const component_1 = require("projen/lib/component");
|
|
|
6
6
|
const task_shell_1 = require("projen/lib/task-shell");
|
|
7
7
|
const textfile_1 = require("projen/lib/textfile");
|
|
8
8
|
class Homebrew extends component_1.Component {
|
|
9
|
-
static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.Homebrew", version: "0.3.
|
|
9
|
+
static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.Homebrew", version: "0.3.3" };
|
|
10
10
|
static of(project) {
|
|
11
11
|
const isHomebrew = (c) => c instanceof Homebrew;
|
|
12
12
|
return project.components.find(isHomebrew);
|
|
@@ -39,7 +39,7 @@ const path = __importStar(require("node:path"));
|
|
|
39
39
|
const projen_1 = require("projen");
|
|
40
40
|
const utils_1 = require("../utils");
|
|
41
41
|
class LambdaFunctionConstructGenerator extends projen_1.Component {
|
|
42
|
-
static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.LambdaFunctionConstructGenerator", version: "0.3.
|
|
42
|
+
static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.LambdaFunctionConstructGenerator", version: "0.3.3" };
|
|
43
43
|
sourceDir;
|
|
44
44
|
outputDir;
|
|
45
45
|
filePattern;
|
|
@@ -7,7 +7,7 @@ const javascript_1 = require("projen/lib/javascript");
|
|
|
7
7
|
const colima_1 = require("./colima");
|
|
8
8
|
const homebrew_1 = require("./homebrew");
|
|
9
9
|
class LocalStack extends component_1.Component {
|
|
10
|
-
static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.LocalStack", version: "0.3.
|
|
10
|
+
static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.LocalStack", version: "0.3.3" };
|
|
11
11
|
constructor(scope, options = {}) {
|
|
12
12
|
super(scope);
|
|
13
13
|
const project = javascript_1.NodeProject.of(this);
|
package/lib/components/mise.js
CHANGED
|
@@ -7,7 +7,7 @@ const component_1 = require("projen/lib/component");
|
|
|
7
7
|
const textfile_1 = require("projen/lib/textfile");
|
|
8
8
|
const homebrew_1 = require("./homebrew");
|
|
9
9
|
class Mise extends component_1.Component {
|
|
10
|
-
static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.Mise", version: "0.3.
|
|
10
|
+
static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.Mise", version: "0.3.3" };
|
|
11
11
|
static of(project) {
|
|
12
12
|
const isMise = (c) => c instanceof Mise;
|
|
13
13
|
return project.components.find(isMise);
|
|
@@ -34,7 +34,7 @@ const DEFAULT_CONFIG = {
|
|
|
34
34
|
* TypeDoc component for projen projects
|
|
35
35
|
*/
|
|
36
36
|
class TypeDoc extends component_1.Component {
|
|
37
|
-
static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.TypeDoc", version: "0.3.
|
|
37
|
+
static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.TypeDoc", version: "0.3.3" };
|
|
38
38
|
static of(project) {
|
|
39
39
|
const isTypeDoc = (c) => c instanceof TypeDoc;
|
|
40
40
|
return project.components.find(isTypeDoc);
|
package/lib/components/vitest.js
CHANGED
|
@@ -140,7 +140,7 @@ var CoverageReporter;
|
|
|
140
140
|
CoverageReporter["TEXT"] = "text";
|
|
141
141
|
})(CoverageReporter || (exports.CoverageReporter = CoverageReporter = {}));
|
|
142
142
|
class Vitest extends component_1.Component {
|
|
143
|
-
static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.Vitest", version: "0.3.
|
|
143
|
+
static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.Vitest", version: "0.3.3" };
|
|
144
144
|
static of(project) {
|
|
145
145
|
const isVitest = (c) => c instanceof Vitest;
|
|
146
146
|
return project.components.find(isVitest);
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import type { Project, SourceCodeOptions } from "projen";
|
|
2
1
|
import * as projen from "projen";
|
|
2
|
+
import { type Project, type SourceCodeOptions } from "projen";
|
|
3
3
|
import type { ProjectType } from "./project-type";
|
|
4
4
|
/**
|
|
5
5
|
* Configuration for a component to be integrated into a generated project
|
|
@@ -115,6 +115,22 @@ export declare class ProjectGenerator extends projen.Component {
|
|
|
115
115
|
* @param options - Generator configuration
|
|
116
116
|
*/
|
|
117
117
|
constructor(project: Project, options: ProjectGeneratorOptions);
|
|
118
|
+
/**
|
|
119
|
+
* Drops the `@pjnew` annotation from the `packageManager` option.
|
|
120
|
+
*
|
|
121
|
+
* `projen new` renders that annotation as an explicit argument in the `.projenrc.ts`
|
|
122
|
+
* it generates, where it takes precedence over the defaults these project types
|
|
123
|
+
* apply. Projen annotates `packageManager` with the `$PACKAGE_MANAGER` macro, which
|
|
124
|
+
* resolves to the package manager that runs the command, so `npx projen new --from`
|
|
125
|
+
* would pin a new project to npm. Without an annotation the option is left out of
|
|
126
|
+
* the generated `.projenrc.ts` and the default of this library applies.
|
|
127
|
+
*
|
|
128
|
+
* The annotation cannot be re-pointed at pnpm instead: projen only accepts a macro
|
|
129
|
+
* or a primitive value as an initial value, and this option is an enum.
|
|
130
|
+
*
|
|
131
|
+
* @param base - The projen options struct the generated interface is derived from
|
|
132
|
+
*/
|
|
133
|
+
private withoutPackageManagerInitialValue;
|
|
118
134
|
/**
|
|
119
135
|
* Casts project to TypeScript project type
|
|
120
136
|
*
|