@storm-software/workspace-tools 1.16.9 → 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.
Files changed (8) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/README.md +19 -15
  3. package/index.js +1353 -1353
  4. package/meta.json +1 -1
  5. package/package.json +1 -1
  6. package/src/executors/tsup/executor.js +1356 -1356
  7. package/src/executors/tsup/get-config.js +1083 -1083
  8. package/src/executors/tsup/schema.json +3 -3
package/CHANGELOG.md CHANGED
@@ -1,3 +1,11 @@
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
+
1
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)
2
10
 
3
11
 
package/README.md CHANGED
@@ -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
- | *tsConfig \** | `string` | The path to tsconfig file. | "tsconfig.json" |
72
+ | **tsConfig \*** | `string` | The path to the \`tsconfig.json\` file. | "tsconfig.json" |
69
73
  | additionalEntryPoints | `string[]` | List of additional entry points. | `[]` |
70
- | external | `string[]` | Mark one or more module as external. Can use \* wildcards, such as '\*.png'. | |
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
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
- | *platform \** | "browser" \| "neutral" \| "node" \| "worker" | Platform target for outputs. | "neutral" |
78
- | *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." |
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. | |
@@ -167,14 +171,14 @@ The following executor options are available:
167
171
 
168
172
  | Option | Type | Description | Default |
169
173
  | --------- | ------ | ------------- | --------- |
170
- | *name \** | `string` | The name of the workspace root. | |
171
- | *organization \** | `string` | The organization that owns the workspace. | "storm-software" |
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
- | *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)? | |
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
- | *mode \** | "light" \| "dark" | Which client mode should be used for the Nx Task Runner? | "dark" |
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
- | *name \** | `string` | A name for the library. | |
199
+ | **name \*** | `string` | A name for the library. | |
196
200
  | description | `string` | The library used by Storm Software for building TypeScript applications. | |
197
- | *directory \** | `string` | A directory where the lib is placed. | |
198
- | *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\`). | |
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
- | *publishable \** | `boolean` | Generate a publishable library. | |
202
- | *importPath \** | `string` | The library name used to import it, like @storm-software/my-awesome-lib. Required for publishable library. | |
203
- | *buildable \** | `boolean` | Generate a buildable library. | `true` |
204
- | setParserOptionsProject | `boolean` | Whether or not to configure the ESLint \`parserOptions.project\` option. We do not do this by default for lint performance reasons. | |
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