@storm-software/workspace-tools 1.16.8 → 1.16.10
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/CHANGELOG.md +15 -0
- package/README.md +23 -19
- package/index.js +16 -26
- package/meta.json +1 -1
- package/package.json +1 -1
- package/src/executors/tsup/executor.js +16 -26
- package/src/executors/tsup/get-config.js +16 -26
- package/src/executors/tsup/schema.json +3 -3
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,18 @@
|
|
|
1
|
+
## [1.16.9](https://github.com/storm-software/storm-ops/compare/workspace-tools-v1.16.8...workspace-tools-v1.16.9) (2023-11-29)
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
### Bug Fixes
|
|
5
|
+
|
|
6
|
+
* **git-tools:** Resolved issue with escape character in descriptions for nx plugins ([c4c5cb0](https://github.com/storm-software/storm-ops/commit/c4c5cb0ec512d74836d9769dac50b3e545993b0c))
|
|
7
|
+
* **workspace-tools:** Update tsup patch so correct files are written after api-extractor ([7106c74](https://github.com/storm-software/storm-ops/commit/7106c74eddc0fe552b142c467ea63e74fb7026ba))
|
|
8
|
+
|
|
9
|
+
## [1.16.8](https://github.com/storm-software/storm-ops/compare/workspace-tools-v1.16.7...workspace-tools-v1.16.8) (2023-11-29)
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
### Bug Fixes
|
|
13
|
+
|
|
14
|
+
* **workspace-tools:** Update tsup patch to use workspace root as base directory for api-extractor ([d8cdc3c](https://github.com/storm-software/storm-ops/commit/d8cdc3c461ac1a95a814f04e569f05a54d1a8937))
|
|
15
|
+
|
|
1
16
|
## [1.16.7](https://github.com/storm-software/storm-ops/compare/workspace-tools-v1.16.6...workspace-tools-v1.16.7) (2023-11-29)
|
|
2
17
|
|
|
3
18
|
|
package/README.md
CHANGED
|
@@ -16,7 +16,7 @@ This package is part of the <b>⚡Storm-Ops</b> monorepo. The Storm-Ops packages
|
|
|
16
16
|
|
|
17
17
|
<h3 align="center">💻 Visit <a href="https://stormsoftware.org" target="_blank">stormsoftware.org</a> to stay up to date with this developer</h3><br />
|
|
18
18
|
|
|
19
|
-
[](https://prettier.io/)
|
|
20
20
|
[](http://nx.dev/) [](https://nextjs.org/) [](http://commitizen.github.io/cz-cli/)  [](https://docusaurus.io/) 
|
|
21
21
|
|
|
22
22
|
<h3 align="center" bold="true">⚠️ <b>Attention</b> ⚠️ This repository, and the apps, libraries, and tools contained within, is still in it's initial development phase. As a result, bugs and issues are expected with it's usage. When the main development phase completes, a proper release will be performed, the packages will be availible through NPM (and other distributions), and this message will be removed. However, in the meantime, please feel free to report any issues you may come across.</h3><br />
|
|
@@ -38,6 +38,10 @@ A package containing tools for managing a Storm workspace. It includes various [
|
|
|
38
38
|
|
|
39
39
|
This library was generated with [Nx](https://nx.dev).
|
|
40
40
|
|
|
41
|
+
## Executors
|
|
42
|
+
|
|
43
|
+
The following executors are available in this package to invoke common tasks for the workspace's projects:
|
|
44
|
+
|
|
41
45
|
<!-- START executors -->
|
|
42
46
|
<!-- prettier-ignore-start -->
|
|
43
47
|
<!-- markdownlint-disable -->
|
|
@@ -65,17 +69,17 @@ The following executor options are available:
|
|
|
65
69
|
| --------- | ------ | ------------- | --------- |
|
|
66
70
|
| entry | `string` | The path to the entry file, relative to project. | "{sourceRoot}/index.ts" |
|
|
67
71
|
| outputPath | `string` | The output path of the generated files. | "dist/{projectRoot}" |
|
|
68
|
-
|
|
|
69
|
-
| additionalEntryPoints | `string[]` | List of additional entry points. |
|
|
70
|
-
| external | `string[]` | Mark one or more module as external. Can use \* wildcards, such as
|
|
72
|
+
| **tsConfig \*** | `string` | The path to the \`tsconfig.json\` file. | "tsconfig.json" |
|
|
73
|
+
| additionalEntryPoints | `string[]` | List of additional entry points. | `[]` |
|
|
74
|
+
| external | `string[]` | Mark one or more module as external. Can use \* wildcards, such as \*.png. | |
|
|
71
75
|
| bundle | `boolean` | Whether to bundle the main entry point and additional entry points. Set to false to keep individual output files. | `true` |
|
|
72
76
|
| watch | `boolean` | Enable re-building when files change. | |
|
|
73
|
-
| assets | `array` | List of static assets. |
|
|
77
|
+
| assets | `array` | List of static assets. | `[]` |
|
|
74
78
|
| clean | `boolean` | Remove previous output before build. | `true` |
|
|
75
79
|
| includeSrc | `boolean` | Should the source files be added to the distribution folder in an \`src\` directory. | `true` |
|
|
76
80
|
| debug | `boolean` | Should output be unminified with source mappings. | |
|
|
77
|
-
|
|
|
78
|
-
|
|
|
81
|
+
| **platform \*** | "browser" \| "neutral" \| "node" \| "worker" | Platform target for outputs. | "neutral" |
|
|
82
|
+
| **banner \*** | `string` | A short heading added to the top of each typescript file added in the output folder's \`src\` directory. | "This code was developed by Storm Software (<https://stormsoftware.org>) and is licensed under the Apache License 2.0." |
|
|
79
83
|
| verbose | `boolean` | Should write extra log outputs with details from the executor. | |
|
|
80
84
|
| define | `object` | Define global constants that can be used in the source code. The value will be converted into a stringified JSON. | |
|
|
81
85
|
| env | `object` | Define environment variables that can be used in the source code. The value will be converted into a stringified JSON. | |
|
|
@@ -83,7 +87,7 @@ The following executor options are available:
|
|
|
83
87
|
| docModel | `boolean` | Should API Extractor generate an Doc Model markdown file. | `true` |
|
|
84
88
|
| tsdocMetadata | `boolean` | Should API Extractor generate an TSDoc Metadata file. | `true` |
|
|
85
89
|
| options | `object` | Additional options to pass to tsup. See <https://paka.dev/npm/tsup@7.2.0/api#d35d54aca71eb26e>. | |
|
|
86
|
-
| plugins | `object[]` | List of ESBuild plugins to use during processing |
|
|
90
|
+
| plugins | `object[]` | List of ESBuild plugins to use during processing | `[]` |
|
|
87
91
|
|
|
88
92
|
|
|
89
93
|
**Please note:** _Option names followed by \* above are required, and must be provided to run the executor._
|
|
@@ -167,14 +171,14 @@ The following executor options are available:
|
|
|
167
171
|
|
|
168
172
|
| Option | Type | Description | Default |
|
|
169
173
|
| --------- | ------ | ------------- | --------- |
|
|
170
|
-
|
|
|
171
|
-
|
|
|
174
|
+
| **name \*** | `string` | The name of the workspace root. | |
|
|
175
|
+
| **organization \*** | `string` | The organization that owns the workspace. | "storm-software" |
|
|
172
176
|
| namespace | `string` | The npm scope used for the workspace. Defaults to the organization name. | |
|
|
173
|
-
|
|
|
177
|
+
| **includeApps \*** | `boolean` | Should a separate `apps` folder be created for this workspace (if Yes: `apps` and `libs` folders will be added, if No: `packages` folders will be added)? | |
|
|
174
178
|
| description | `string` | The description of the workspace to use in the package.json and README.md files. | |
|
|
175
179
|
| repositoryUrl | `string` | The URL of the workspace in GitHub. Defaults to <https://github.com/{organization}/{name}> | |
|
|
176
180
|
| nxCloud | `boolean` | Should distributed caching with Nx Cloud be enabled for the workspace? | |
|
|
177
|
-
|
|
|
181
|
+
| **mode \*** | "light" \| "dark" | Which client mode should be used for the Nx Task Runner? | "dark" |
|
|
178
182
|
| packageManager | "npm" \| "yarn" \| "pnpm" | What package manager is used for the workspace? | "pnpm" |
|
|
179
183
|
|
|
180
184
|
|
|
@@ -192,16 +196,16 @@ The following executor options are available:
|
|
|
192
196
|
|
|
193
197
|
| Option | Type | Description | Default |
|
|
194
198
|
| --------- | ------ | ------------- | --------- |
|
|
195
|
-
|
|
|
199
|
+
| **name \*** | `string` | A name for the library. | |
|
|
196
200
|
| description | `string` | The library used by Storm Software for building TypeScript applications. | |
|
|
197
|
-
|
|
|
198
|
-
|
|
|
201
|
+
| **directory \*** | `string` | A directory where the lib is placed. | |
|
|
202
|
+
| **projectNameAndRootFormat \*** | "as-provided" \| "derived" | Whether to generate the project name and root directory as provided (`as-provided`) or generate them composing their values and taking the configured layout into account (`derived`). | |
|
|
199
203
|
| tags | `string` | Add tags to the library (used for linting). | |
|
|
200
204
|
| strict | `boolean` | Whether to enable tsconfig strict mode or not. | `true` |
|
|
201
|
-
|
|
|
202
|
-
|
|
|
203
|
-
|
|
|
204
|
-
| setParserOptionsProject | `boolean` | Whether or not to configure the ESLint
|
|
205
|
+
| **publishable \*** | `boolean` | Generate a publishable library. | |
|
|
206
|
+
| **importPath \*** | `string` | The library name used to import it, like @storm-software/my-awesome-lib. Required for publishable library. | |
|
|
207
|
+
| **buildable \*** | `boolean` | Generate a buildable library. | `true` |
|
|
208
|
+
| setParserOptionsProject | `boolean` | Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons. | |
|
|
205
209
|
| rootProject | `boolean` | Is the current project the root project in the workspace. | |
|
|
206
210
|
|
|
207
211
|
|
package/index.js
CHANGED
|
@@ -40019,9 +40019,9 @@ var require_brace_expansion2 = __commonJS({
|
|
|
40019
40019
|
}
|
|
40020
40020
|
});
|
|
40021
40021
|
|
|
40022
|
-
// node_modules/.pnpm/tsup@8.0.0_patch_hash=
|
|
40022
|
+
// node_modules/.pnpm/tsup@8.0.0_patch_hash=ycbj4ze4nximjalgxenbuscbmq_@microsoft+api-extractor@7.38.3_@swc+core@1._sppchyqgfxkd36p6h24jhpliga/node_modules/tsup/dist/chunk-EPAEWGCP.js
|
|
40023
40023
|
var require_chunk_EPAEWGCP = __commonJS({
|
|
40024
|
-
"node_modules/.pnpm/tsup@8.0.0_patch_hash=
|
|
40024
|
+
"node_modules/.pnpm/tsup@8.0.0_patch_hash=ycbj4ze4nximjalgxenbuscbmq_@microsoft+api-extractor@7.38.3_@swc+core@1._sppchyqgfxkd36p6h24jhpliga/node_modules/tsup/dist/chunk-EPAEWGCP.js"(exports) {
|
|
40025
40025
|
"use strict";
|
|
40026
40026
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
40027
40027
|
var version = "8.0.0";
|
|
@@ -40481,9 +40481,9 @@ var require_resolve_from = __commonJS({
|
|
|
40481
40481
|
}
|
|
40482
40482
|
});
|
|
40483
40483
|
|
|
40484
|
-
// node_modules/.pnpm/tsup@8.0.0_patch_hash=
|
|
40484
|
+
// node_modules/.pnpm/tsup@8.0.0_patch_hash=ycbj4ze4nximjalgxenbuscbmq_@microsoft+api-extractor@7.38.3_@swc+core@1._sppchyqgfxkd36p6h24jhpliga/node_modules/tsup/dist/chunk-GQ77QZBO.js
|
|
40485
40485
|
var require_chunk_GQ77QZBO = __commonJS({
|
|
40486
|
-
"node_modules/.pnpm/tsup@8.0.0_patch_hash=
|
|
40486
|
+
"node_modules/.pnpm/tsup@8.0.0_patch_hash=ycbj4ze4nximjalgxenbuscbmq_@microsoft+api-extractor@7.38.3_@swc+core@1._sppchyqgfxkd36p6h24jhpliga/node_modules/tsup/dist/chunk-GQ77QZBO.js"(exports) {
|
|
40487
40487
|
"use strict";
|
|
40488
40488
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
40489
40489
|
function _interopRequireDefault(obj) {
|
|
@@ -40761,9 +40761,9 @@ var require_chunk_GQ77QZBO = __commonJS({
|
|
|
40761
40761
|
}
|
|
40762
40762
|
});
|
|
40763
40763
|
|
|
40764
|
-
// node_modules/.pnpm/tsup@8.0.0_patch_hash=
|
|
40764
|
+
// node_modules/.pnpm/tsup@8.0.0_patch_hash=ycbj4ze4nximjalgxenbuscbmq_@microsoft+api-extractor@7.38.3_@swc+core@1._sppchyqgfxkd36p6h24jhpliga/node_modules/tsup/dist/chunk-UIX4URMV.js
|
|
40765
40765
|
var require_chunk_UIX4URMV = __commonJS({
|
|
40766
|
-
"node_modules/.pnpm/tsup@8.0.0_patch_hash=
|
|
40766
|
+
"node_modules/.pnpm/tsup@8.0.0_patch_hash=ycbj4ze4nximjalgxenbuscbmq_@microsoft+api-extractor@7.38.3_@swc+core@1._sppchyqgfxkd36p6h24jhpliga/node_modules/tsup/dist/chunk-UIX4URMV.js"(exports) {
|
|
40767
40767
|
"use strict";
|
|
40768
40768
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
40769
40769
|
function _interopRequireWildcard(obj) {
|
|
@@ -41697,9 +41697,9 @@ var require_dist2 = __commonJS({
|
|
|
41697
41697
|
}
|
|
41698
41698
|
});
|
|
41699
41699
|
|
|
41700
|
-
// node_modules/.pnpm/tsup@8.0.0_patch_hash=
|
|
41700
|
+
// node_modules/.pnpm/tsup@8.0.0_patch_hash=ycbj4ze4nximjalgxenbuscbmq_@microsoft+api-extractor@7.38.3_@swc+core@1._sppchyqgfxkd36p6h24jhpliga/node_modules/tsup/dist/chunk-7G76EW2R.js
|
|
41701
41701
|
var require_chunk_7G76EW2R = __commonJS({
|
|
41702
|
-
"node_modules/.pnpm/tsup@8.0.0_patch_hash=
|
|
41702
|
+
"node_modules/.pnpm/tsup@8.0.0_patch_hash=ycbj4ze4nximjalgxenbuscbmq_@microsoft+api-extractor@7.38.3_@swc+core@1._sppchyqgfxkd36p6h24jhpliga/node_modules/tsup/dist/chunk-7G76EW2R.js"(exports) {
|
|
41703
41703
|
"use strict";
|
|
41704
41704
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
41705
41705
|
function _interopRequireDefault(obj) {
|
|
@@ -95505,9 +95505,9 @@ var require_chokidar = __commonJS({
|
|
|
95505
95505
|
}
|
|
95506
95506
|
});
|
|
95507
95507
|
|
|
95508
|
-
// node_modules/.pnpm/tsup@8.0.0_patch_hash=
|
|
95508
|
+
// node_modules/.pnpm/tsup@8.0.0_patch_hash=ycbj4ze4nximjalgxenbuscbmq_@microsoft+api-extractor@7.38.3_@swc+core@1._sppchyqgfxkd36p6h24jhpliga/node_modules/tsup/dist/index.js
|
|
95509
95509
|
var require_dist5 = __commonJS({
|
|
95510
|
-
"node_modules/.pnpm/tsup@8.0.0_patch_hash=
|
|
95510
|
+
"node_modules/.pnpm/tsup@8.0.0_patch_hash=ycbj4ze4nximjalgxenbuscbmq_@microsoft+api-extractor@7.38.3_@swc+core@1._sppchyqgfxkd36p6h24jhpliga/node_modules/tsup/dist/index.js"(exports) {
|
|
95511
95511
|
"use strict";
|
|
95512
95512
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
95513
95513
|
function _interopRequireDefault(obj) {
|
|
@@ -97921,7 +97921,7 @@ var require_dist5 = __commonJS({
|
|
|
97921
97921
|
return "";
|
|
97922
97922
|
}
|
|
97923
97923
|
var logger2 = _chunk7G76EW2Rjs.createLogger.call(void 0);
|
|
97924
|
-
function rollupDtsFile(options, inputFilePath,
|
|
97924
|
+
function rollupDtsFile(options, inputFilePath, outputFilePath, tsconfigFilePath) {
|
|
97925
97925
|
let projectFolder = packageJsonSearch(options.outDir, options.silent, "dts", logger2);
|
|
97926
97926
|
!options.silent && logger2.info("dts", `\u26A1 Preparing to run API Extractor (DTS generate): ${projectFolder}`);
|
|
97927
97927
|
const apiReferenceProjectDir = `<projectFolder>/${_path2.default.join(
|
|
@@ -97949,18 +97949,7 @@ var require_dist5 = __commonJS({
|
|
|
97949
97949
|
},
|
|
97950
97950
|
dtsRollup: {
|
|
97951
97951
|
enabled: true,
|
|
97952
|
-
untrimmedFilePath:
|
|
97953
|
-
options.outDir,
|
|
97954
|
-
`index${dtsExtension}`
|
|
97955
|
-
).replaceAll("\\", "/")}`,
|
|
97956
|
-
betaTrimmedFilePath: `<projectFolder>/${_path2.default.join(
|
|
97957
|
-
options.outDir,
|
|
97958
|
-
`index-beta${dtsExtension}`
|
|
97959
|
-
).replaceAll("\\", "/")}`,
|
|
97960
|
-
publicTrimmedFilePath: `<projectFolder>/${_path2.default.join(
|
|
97961
|
-
options.outDir,
|
|
97962
|
-
`index-public${dtsExtension}`
|
|
97963
|
-
).replaceAll("\\", "/")}`
|
|
97952
|
+
untrimmedFilePath: outputFilePath
|
|
97964
97953
|
},
|
|
97965
97954
|
tsdocMetadata: {
|
|
97966
97955
|
enabled: options.tsdocMetadata !== false,
|
|
@@ -98029,7 +98018,7 @@ var require_dist5 = __commonJS({
|
|
|
98029
98018
|
let dtsExtension = _chunkGQ77QZBOjs.defaultOutExtension.call(void 0, { format: format2, pkgType: pkg.type }).dts;
|
|
98030
98019
|
let dtsInputFilePath = _path2.default.join(
|
|
98031
98020
|
declarationDir,
|
|
98032
|
-
|
|
98021
|
+
options.projectRoot,
|
|
98033
98022
|
"_tsup-dts-aggregation" + dtsExtension
|
|
98034
98023
|
);
|
|
98035
98024
|
dtsInputFilePath = dtsInputFilePath.replace(/\.d\.mts$/, ".dmts.d.ts").replace(/\.d\.cts$/, ".dcts.d.ts");
|
|
@@ -98038,10 +98027,11 @@ var require_dist5 = __commonJS({
|
|
|
98038
98027
|
dtsInputFilePath,
|
|
98039
98028
|
formatAggregationExports(exports2, declarationDir)
|
|
98040
98029
|
);
|
|
98030
|
+
let dtsOutputFilePath = _path2.default.join(outDir, "declaration" + dtsExtension);
|
|
98041
98031
|
rollupDtsFile(
|
|
98042
98032
|
options,
|
|
98043
98033
|
dtsInputFilePath,
|
|
98044
|
-
|
|
98034
|
+
dtsOutputFilePath,
|
|
98045
98035
|
options.tsconfig || "tsconfig.json"
|
|
98046
98036
|
);
|
|
98047
98037
|
for (let [out, sourceFileName] of Object.entries(
|
|
@@ -98055,7 +98045,7 @@ var require_dist5 = __commonJS({
|
|
|
98055
98045
|
_chunkGQ77QZBOjs.writeFileSync.call(
|
|
98056
98046
|
void 0,
|
|
98057
98047
|
outFileName,
|
|
98058
|
-
formatDistributionExports(currentExports, outFileName,
|
|
98048
|
+
formatDistributionExports(currentExports, outFileName, dtsOutputFilePath)
|
|
98059
98049
|
);
|
|
98060
98050
|
}
|
|
98061
98051
|
}
|