@storm-software/workspace-tools 1.16.4 → 1.16.6
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 +100 -193
- package/index.js +21 -32
- package/meta.json +1 -1
- package/package.json +1 -1
- package/src/executors/tsup/executor.js +21 -32
- package/src/executors/tsup/get-config.js +21 -32
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,18 @@
|
|
|
1
|
+
## [1.16.5](https://github.com/storm-software/storm-ops/compare/workspace-tools-v1.16.4...workspace-tools-v1.16.5) (2023-11-29)
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
### Bug Fixes
|
|
5
|
+
|
|
6
|
+
* **git-tools:** Resolved issue with generation of options table in readme-gen ([69f9c86](https://github.com/storm-software/storm-ops/commit/69f9c86efc90e117c4ec9a5b4d1a520d764af4f5))
|
|
7
|
+
* **workspace-tools:** Resolved issue with paths passed to api-extractor ([3f7c5ea](https://github.com/storm-software/storm-ops/commit/3f7c5ea14b3db1d1444624781a5ec025cc432552))
|
|
8
|
+
|
|
9
|
+
## [1.16.4](https://github.com/storm-software/storm-ops/compare/workspace-tools-v1.16.3...workspace-tools-v1.16.4) (2023-11-29)
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
### Bug Fixes
|
|
13
|
+
|
|
14
|
+
* **git-tools:** Added code to ensure the readme-gen sections are added back after running ([19232ef](https://github.com/storm-software/storm-ops/commit/19232ef62d9d10bb4619debeb968f83e970e38c8))
|
|
15
|
+
|
|
1
16
|
## [1.16.3](https://github.com/storm-software/storm-ops/compare/workspace-tools-v1.16.2...workspace-tools-v1.16.3) (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 />
|
|
@@ -31,110 +31,78 @@ This package is part of the <b>⚡Storm-Ops</b> monorepo. The Storm-Ops packages
|
|
|
31
31
|
|
|
32
32
|
A package containing tools for managing a Storm workspace. It includes various [Nx](https://nx.dev) generators and executors for common development tasks.
|
|
33
33
|
|
|
34
|
-
<!-- START doctoc -->
|
|
35
|
-
<!--
|
|
34
|
+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
|
|
35
|
+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
|
|
36
|
+
|
|
37
|
+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
|
|
36
38
|
|
|
37
39
|
This library was generated with [Nx](https://nx.dev).
|
|
38
40
|
|
|
39
41
|
<!-- START executors -->
|
|
42
|
+
<!-- prettier-ignore-start -->
|
|
43
|
+
<!-- markdownlint-disable -->
|
|
44
|
+
|
|
40
45
|
|
|
41
46
|
## Tsup Builder
|
|
42
47
|
|
|
43
48
|
Run a build on the project using ESBuild with a patched tsup configuration
|
|
44
49
|
|
|
45
|
-
### Example
|
|
50
|
+
### Example
|
|
46
51
|
|
|
47
|
-
This executor can be used by executing the following in a command line utility:
|
|
52
|
+
This executor can be used by executing the following in a command line utility:
|
|
48
53
|
|
|
49
|
-
```cmd
|
|
54
|
+
```cmd
|
|
50
55
|
nx run my-project:tsup
|
|
51
56
|
```
|
|
52
57
|
|
|
53
|
-
**Please note:** _The tsup executor should be included in the desired projects's `project.json` file.All required options must be included in the `options` property of the json._
|
|
58
|
+
**Please note:** _The tsup executor should be included in the desired projects's `project.json` file.All required options must be included in the `options` property of the json._
|
|
54
59
|
|
|
55
60
|
### Options
|
|
56
61
|
|
|
57
62
|
The following executor options are available:
|
|
58
63
|
|
|
59
|
-
| Option
|
|
60
|
-
|
|
|
61
|
-
| entry
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
<!-- END executors -->
|
|
86
|
-
|
|
87
|
-
## Executors
|
|
88
|
-
|
|
89
|
-
The following executors are available in this package to invoke common tasks for the workspace's projects:
|
|
90
|
-
|
|
91
|
-
## Tsup Build executor
|
|
64
|
+
| Option | Type | Description | Default |
|
|
65
|
+
| --------- | ------ | ------------- | --------- |
|
|
66
|
+
| entry | `string` | The path to the entry file, relative to project. | "{sourceRoot}/index.ts" |
|
|
67
|
+
| outputPath | `string` | The output path of the generated files. | "dist/{projectRoot}" |
|
|
68
|
+
| *tsConfig \** | `string` | The path to tsconfig file. | "tsconfig.json" |
|
|
69
|
+
| additionalEntryPoints | `string[]` | List of additional entry points. | `` |
|
|
70
|
+
| external | `string[]` | Mark one or more module as external. Can use \* wildcards, such as '\*.png'. | |
|
|
71
|
+
| bundle | `boolean` | Whether to bundle the main entry point and additional entry points. Set to false to keep individual output files. | `true` |
|
|
72
|
+
| watch | `boolean` | Enable re-building when files change. | |
|
|
73
|
+
| assets | `array` | List of static assets. | `` |
|
|
74
|
+
| clean | `boolean` | Remove previous output before build. | `true` |
|
|
75
|
+
| includeSrc | `boolean` | Should the source files be added to the distribution folder in an \`src\` directory. | `true` |
|
|
76
|
+
| 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." |
|
|
79
|
+
| verbose | `boolean` | Should write extra log outputs with details from the executor. | |
|
|
80
|
+
| define | `object` | Define global constants that can be used in the source code. The value will be converted into a stringified JSON. | |
|
|
81
|
+
| env | `object` | Define environment variables that can be used in the source code. The value will be converted into a stringified JSON. | |
|
|
82
|
+
| apiReport | `boolean` | Should API Extractor generate an API Report file. | `true` |
|
|
83
|
+
| docModel | `boolean` | Should API Extractor generate an Doc Model markdown file. | `true` |
|
|
84
|
+
| tsdocMetadata | `boolean` | Should API Extractor generate an TSDoc Metadata file. | `true` |
|
|
85
|
+
| 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 | `` |
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
**Please note:** _Option names followed by \* above are required, and must be provided to run the executor._
|
|
92
90
|
|
|
93
|
-
Run a build on the project using tsup configuration
|
|
94
91
|
|
|
95
|
-
### Example
|
|
96
92
|
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
```cmd
|
|
100
|
-
nx run my-project:tsup
|
|
101
|
-
```
|
|
102
|
-
|
|
103
|
-
**Please note:** _The tsup executor should be included in the desired projects's `project.json` file._
|
|
104
|
-
|
|
105
|
-
### Options
|
|
106
|
-
|
|
107
|
-
The following executor options are available:
|
|
93
|
+
<!-- markdownlint-restore -->
|
|
94
|
+
<!-- prettier-ignore-end -->
|
|
108
95
|
|
|
109
|
-
|
|
110
|
-
,| outputPath | `string` | The output path of the generated files. | "dist/{projectRoot}" |
|
|
111
|
-
,| tsConfig | `string` | The path to tsconfig file. | "tsconfig.json" |
|
|
112
|
-
,| additionalEntryPoints | `string[]` | List of additional entry points. | `` |
|
|
113
|
-
,| external | `string[]` | Mark one or more module as external. Can use * wildcards, such as '*.png'. | |
|
|
114
|
-
,| bundle | `boolean` | Whether to bundle the main entry point and additional entry points. Set to false to keep individual output files. | `true` |
|
|
115
|
-
,| watch | `boolean` | Enable re-building when files change. | |
|
|
116
|
-
,| assets | `array` | List of static assets. |`` |
|
|
117
|
-
,| clean | `boolean` | Remove previous output before build. | `true` |
|
|
118
|
-
,| includeSrc | `boolean` | Should the source files be added to the distribution folder in an `src` directory. | `true` |
|
|
119
|
-
,| debug | `boolean` | Should output be unminified with source mappings. | |
|
|
120
|
-
,| platform | "browser" \| "neutral" \| "node" \| "worker" | Platform target for outputs. | "neutral" |
|
|
121
|
-
,| 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." |
|
|
122
|
-
,| verbose | `boolean` | Should write extra log outputs with details from the executor. | |
|
|
123
|
-
,| define | `object` | Define global constants that can be used in the source code. The value will be converted into a stringified JSON. | |
|
|
124
|
-
,| env | `object` | Define environment variables that can be used in the source code. The value will be converted into a stringified JSON. | |
|
|
125
|
-
,| apiReport | `boolean` | Should API Extractor generate an API Report file. | `true` |
|
|
126
|
-
,| docModel | `boolean` | Should API Extractor generate an Doc Model markdown file. | `true` |
|
|
127
|
-
,| tsdocMetadata | `boolean` | Should API Extractor generate an TSDoc Metadata file. | `true` |
|
|
128
|
-
,| options | `object` | Additional options to pass to tsup. See https://paka.dev/npm/tsup@7.2.0/api#d35d54aca71eb26e. | |
|
|
129
|
-
,| plugins | `object[]` | List of ESBuild plugins to use during processing | `` |
|
|
130
|
-
,| required |`string` | | |
|
|
131
|
-
,| definitions |`string` | | |
|
|
96
|
+
<!-- END executors -->
|
|
132
97
|
|
|
133
98
|
## Generators
|
|
134
99
|
|
|
135
100
|
The following generators are available with this package to assist in workspace management:
|
|
136
101
|
|
|
137
102
|
<!-- START generators -->
|
|
103
|
+
<!-- prettier-ignore-start -->
|
|
104
|
+
<!-- markdownlint-disable -->
|
|
105
|
+
|
|
138
106
|
|
|
139
107
|
## Init Storm Workspace Plugin
|
|
140
108
|
|
|
@@ -144,48 +112,52 @@ Init Storm Workspace Plugin.
|
|
|
144
112
|
|
|
145
113
|
The following executor options are available:
|
|
146
114
|
|
|
147
|
-
| Option
|
|
148
|
-
|
|
|
149
|
-
| skipFormat
|
|
115
|
+
| Option | Type | Description | Default |
|
|
116
|
+
| --------- | ------ | ------------- | --------- |
|
|
117
|
+
| skipFormat | `boolean` | Skip formatting files. | |
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
|
|
150
121
|
|
|
151
122
|
## Workspace Preset
|
|
152
123
|
|
|
153
124
|
Create a Storm workspace with all of the required files and recommended packages installed.
|
|
154
125
|
|
|
155
|
-
### Examples
|
|
156
|
-
|
|
157
|
-
This generator can be used by executing the following examples in a command line utility:
|
|
126
|
+
### Examples
|
|
158
127
|
|
|
159
|
-
|
|
128
|
+
This generator can be used by executing the following examples in a command line utility:
|
|
160
129
|
|
|
161
|
-
|
|
162
|
-
-
|
|
163
|
-
-
|
|
130
|
+
Generate a storm workspace with:
|
|
131
|
+
- name: example-repo
|
|
132
|
+
- namespace: storm-software
|
|
133
|
+
- organization: storm-software
|
|
164
134
|
- repositoryUrl: <https://github.com/storm-software/example-repo>
|
|
165
135
|
|
|
166
|
-
```cmd
|
|
136
|
+
```cmd
|
|
167
137
|
nx g @storm-software/workspace-tools:preset --name 'example-repo'
|
|
168
138
|
```
|
|
169
139
|
|
|
170
|
-
Generate a storm workspace with:
|
|
171
140
|
|
|
172
|
-
|
|
173
|
-
|
|
141
|
+
|
|
142
|
+
Generate a storm workspace with:
|
|
143
|
+
- name: example-repo
|
|
144
|
+
- namespace: example
|
|
174
145
|
- repositoryUrl: <https://github.com/storm-software/example-repo>
|
|
175
146
|
|
|
176
|
-
```cmd
|
|
147
|
+
```cmd
|
|
177
148
|
nx g @storm-software/workspace-tools:preset --name 'example-repo' --namespace 'example'
|
|
178
149
|
```
|
|
179
150
|
|
|
180
|
-
Generate a storm workspace with:
|
|
181
151
|
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
-
|
|
185
|
-
-
|
|
152
|
+
|
|
153
|
+
Generate a storm workspace with:
|
|
154
|
+
- name: example-repo
|
|
155
|
+
- namespace: example
|
|
156
|
+
- organization: example-org
|
|
157
|
+
- description: An example workspace
|
|
186
158
|
- repositoryUrl: <https://github.com/example-org/example-repo>
|
|
187
159
|
|
|
188
|
-
```cmd
|
|
160
|
+
```cmd
|
|
189
161
|
nx g @storm-software/workspace-tools:preset --name 'example-repo' --namespace 'example' --organization 'example-org' --description 'An example workspace'
|
|
190
162
|
```
|
|
191
163
|
|
|
@@ -193,119 +165,54 @@ nx g @storm-software/workspace-tools:preset --name 'example-repo' --namespace 'e
|
|
|
193
165
|
|
|
194
166
|
The following executor options are available:
|
|
195
167
|
|
|
196
|
-
| Option
|
|
197
|
-
|
|
|
198
|
-
| name
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
168
|
+
| Option | Type | Description | Default |
|
|
169
|
+
| --------- | ------ | ------------- | --------- |
|
|
170
|
+
| *name \** | `string` | The name of the workspace root. | |
|
|
171
|
+
| *organization \** | `string` | The organization that owns the workspace. | "storm-software" |
|
|
172
|
+
| 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)? | |
|
|
174
|
+
| description | `string` | The description of the workspace to use in the package.json and README.md files. | |
|
|
175
|
+
| repositoryUrl | `string` | The URL of the workspace in GitHub. Defaults to <https://github.com/{organization}/{name}> | |
|
|
176
|
+
| 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" |
|
|
178
|
+
| packageManager | "npm" \| "yarn" \| "pnpm" | What package manager is used for the workspace? | "pnpm" |
|
|
207
179
|
|
|
208
|
-
**Please note:** _Option names followed by \* above are required, and must be provided to run the executor._
|
|
209
180
|
|
|
210
|
-
|
|
181
|
+
**Please note:** _Option names followed by \* above are required, and must be provided to run the executor._
|
|
211
182
|
|
|
212
|
-
Generate a new node library project in the Storm workspace
|
|
213
183
|
|
|
214
|
-
### Options
|
|
215
184
|
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
| Option | Type | Description | Default |
|
|
219
|
-
| ------ | -------------------------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------ |
|
|
220
|
-
| name\* | `string` | A name for the library. | |
|
|
221
|
-
| , | description | `string` | The library used by Storm Software for building TypeScript applications. | |
|
|
222
|
-
| , | directory\* | `string` | A directory where the lib is placed. | |
|
|
223
|
-
| , | 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\`). | |
|
|
224
|
-
| , | tags | `string` | Add tags to the library (used for linting). | |
|
|
225
|
-
| , | strict | `boolean` | Whether to enable tsconfig strict mode or not. | `true` |
|
|
226
|
-
| , | publishable\* | `boolean` | Generate a publishable library. | |
|
|
227
|
-
| , | importPath\* | `string` | The library name used to import it, like @storm-software/my-awesome-lib. Required for publishable library. | |
|
|
228
|
-
| , | buildable\* | `boolean` | Generate a buildable library. | `true` |
|
|
229
|
-
| , | setParserOptionsProject | `boolean` | Whether or not to configure the ESLint \`parserOptions.project\` option. We do not do this by default for lint performance reasons. | |
|
|
230
|
-
| , | rootProject | `boolean` | Is the current project the root project in the workspace. | |
|
|
231
|
-
|
|
232
|
-
**Please note:** _Option names followed by \* above are required, and must be provided to run the executor._
|
|
233
|
-
|
|
234
|
-
<!-- END generators -->
|
|
235
|
-
|
|
236
|
-
## Init Storm Workspace Plugin
|
|
237
|
-
|
|
238
|
-
Init Storm Workspace Plugin.
|
|
239
|
-
|
|
240
|
-
### Options
|
|
241
|
-
|
|
242
|
-
The following executor options are available:
|
|
243
|
-
|
|
244
|
-
| Option | Type | Description | Default || --------- | ------ | ------------- | --------- || skipFormat | `boolean` | Skip formatting files. | |
|
|
245
|
-
|
|
246
|
-
## Storm Workspace preset
|
|
247
|
-
|
|
248
|
-
Storm workspace preset generator
|
|
249
|
-
|
|
250
|
-
### Examples
|
|
251
|
-
|
|
252
|
-
This generator can be used by executing the following examples in a command line utility:
|
|
253
|
-
|
|
254
|
-
#### Generate a storm workspace with the name: example-repo, namespace: storm-software, organization: storm-software, and repositoryUrl: 'https://github.com/storm-software/example-repo'.
|
|
255
|
-
|
|
256
|
-
```
|
|
257
|
-
nx g @storm-software/workspace-tools:preset --name 'example-repo'
|
|
258
|
-
```
|
|
259
|
-
|
|
260
|
-
#### Generate a storm workspace with the name: example-repo, namespace: example, and repositoryUrl: 'https://github.com/storm-software/example-repo'.
|
|
261
|
-
|
|
262
|
-
```
|
|
263
|
-
nx g @storm-software/workspace-tools:preset --name 'example-repo' --namespace 'example'
|
|
264
|
-
```
|
|
265
|
-
|
|
266
|
-
#### Generate a storm workspace with the name: example-repo, namespace: example, organization: example-org, description: 'An example workspace', and repositoryUrl: 'https://github.com/example-org/example-repo'.
|
|
185
|
+
## Add Node Library
|
|
267
186
|
|
|
268
|
-
|
|
269
|
-
nx g @storm-software/workspace-tools:preset --name 'example-repo' --namespace 'example' --organization 'example-org' --description 'An example workspace'
|
|
270
|
-
```
|
|
187
|
+
Generate a new node library project in the Storm workspace
|
|
271
188
|
|
|
272
189
|
### Options
|
|
273
190
|
|
|
274
191
|
The following executor options are available:
|
|
275
192
|
|
|
276
|
-
| Option
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
193
|
+
| Option | Type | Description | Default |
|
|
194
|
+
| --------- | ------ | ------------- | --------- |
|
|
195
|
+
| *name \** | `string` | A name for the library. | |
|
|
196
|
+
| 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\`). | |
|
|
199
|
+
| tags | `string` | Add tags to the library (used for linting). | |
|
|
200
|
+
| 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
|
+
| rootProject | `boolean` | Is the current project the root project in the workspace. | |
|
|
285
206
|
|
|
286
|
-
**Please note:** _Option names followed by _ above are required, and must be provided to run the executor.\*
|
|
287
207
|
|
|
288
|
-
|
|
208
|
+
**Please note:** _Option names followed by \* above are required, and must be provided to run the executor._
|
|
289
209
|
|
|
290
|
-
Generate a new node library project in the Storm workspace
|
|
291
210
|
|
|
292
|
-
### Options
|
|
293
211
|
|
|
294
|
-
|
|
212
|
+
<!-- markdownlint-restore -->
|
|
213
|
+
<!-- prettier-ignore-end -->
|
|
295
214
|
|
|
296
|
-
|
|
297
|
-
,| description | `string` | The library used by Storm Software for building TypeScript applications. | |
|
|
298
|
-
,| directory\* | `string` | A directory where the lib is placed. | |
|
|
299
|
-
,| 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`). | |
|
|
300
|
-
,| tags | `string` | Add tags to the library (used for linting). | |
|
|
301
|
-
,| strict | `boolean` | Whether to enable tsconfig strict mode or not. | `true` |
|
|
302
|
-
,| publishable\* | `boolean` | Generate a publishable library. | |
|
|
303
|
-
,| importPath\* | `string` | The library name used to import it, like @storm-software/my-awesome-lib. Required for publishable library. | |
|
|
304
|
-
,| buildable\* | `boolean` | Generate a buildable library. | `true` |
|
|
305
|
-
,| setParserOptionsProject | `boolean` | Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons. | |
|
|
306
|
-
,| rootProject | `boolean` | Is the current project the root project in the workspace. | |
|
|
307
|
-
|
|
308
|
-
**Please note:** _Option names followed by _ above are required, and must be provided to run the executor.\*
|
|
215
|
+
<!-- END generators -->
|
|
309
216
|
|
|
310
217
|
## Building
|
|
311
218
|
|
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=jfpznnlqnqdfplcpcfcc56m4ui_@microsoft+api-extractor@7.38.3_@swc+core@1._iuolylkk4du3r6khqgpcwkyvma/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=jfpznnlqnqdfplcpcfcc56m4ui_@microsoft+api-extractor@7.38.3_@swc+core@1._iuolylkk4du3r6khqgpcwkyvma/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=jfpznnlqnqdfplcpcfcc56m4ui_@microsoft+api-extractor@7.38.3_@swc+core@1._iuolylkk4du3r6khqgpcwkyvma/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=jfpznnlqnqdfplcpcfcc56m4ui_@microsoft+api-extractor@7.38.3_@swc+core@1._iuolylkk4du3r6khqgpcwkyvma/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=jfpznnlqnqdfplcpcfcc56m4ui_@microsoft+api-extractor@7.38.3_@swc+core@1._iuolylkk4du3r6khqgpcwkyvma/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=jfpznnlqnqdfplcpcfcc56m4ui_@microsoft+api-extractor@7.38.3_@swc+core@1._iuolylkk4du3r6khqgpcwkyvma/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=jfpznnlqnqdfplcpcfcc56m4ui_@microsoft+api-extractor@7.38.3_@swc+core@1._iuolylkk4du3r6khqgpcwkyvma/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=jfpznnlqnqdfplcpcfcc56m4ui_@microsoft+api-extractor@7.38.3_@swc+core@1._iuolylkk4du3r6khqgpcwkyvma/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=jfpznnlqnqdfplcpcfcc56m4ui_@microsoft+api-extractor@7.38.3_@swc+core@1._iuolylkk4du3r6khqgpcwkyvma/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=jfpznnlqnqdfplcpcfcc56m4ui_@microsoft+api-extractor@7.38.3_@swc+core@1._iuolylkk4du3r6khqgpcwkyvma/node_modules/tsup/dist/index.js"(exports) {
|
|
95511
95511
|
"use strict";
|
|
95512
95512
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
95513
95513
|
function _interopRequireDefault(obj) {
|
|
@@ -97870,55 +97870,44 @@ var require_dist5 = __commonJS({
|
|
|
97870
97870
|
var logger2 = _chunk7G76EW2Rjs.createLogger.call(void 0);
|
|
97871
97871
|
function rollupDtsFile(options, inputFilePath, dtsExtension, tsconfigFilePath) {
|
|
97872
97872
|
let projectFolder = packageJsonSearch(options.outDir, options.silent, "dts", logger2);
|
|
97873
|
-
if (projectFolder.endsWith("/")) {
|
|
97874
|
-
projectFolder = projectFolder.slice(0, -1);
|
|
97875
|
-
}
|
|
97876
97873
|
!options.silent && logger2.info("dts", `\u26A1 Preparing to run API Extractor (DTS generate): ${projectFolder}`);
|
|
97877
|
-
const relativeProjectFolder = _path2.default.relative(
|
|
97878
|
-
_path2.default.join(options.workspaceRoot, projectFolder.replaceAll("/", "\\")),
|
|
97879
|
-
options.workspaceRoot
|
|
97880
|
-
);
|
|
97881
97874
|
const apiReferenceProjectDir = _path2.default.join(
|
|
97882
|
-
|
|
97875
|
+
options.workspaceRoot,
|
|
97883
97876
|
"docs",
|
|
97884
97877
|
"api-reports",
|
|
97885
97878
|
options.projectRoot
|
|
97886
|
-
).replaceAll("
|
|
97879
|
+
).replaceAll("/", "\\");
|
|
97887
97880
|
let configObject = {
|
|
97888
97881
|
mainEntryPointFilePath: inputFilePath.includes(options.workspaceRoot) ? inputFilePath : _path2.default.join(options.workspaceRoot, inputFilePath),
|
|
97889
97882
|
apiReport: {
|
|
97890
97883
|
enabled: options.apiReport !== false,
|
|
97891
97884
|
reportFileName: "api-report.md",
|
|
97892
|
-
reportFolder:
|
|
97893
|
-
reportTempFolder:
|
|
97894
|
-
|
|
97885
|
+
reportFolder: apiReferenceProjectDir,
|
|
97886
|
+
reportTempFolder: _path2.default.join(
|
|
97887
|
+
options.workspaceRoot,
|
|
97895
97888
|
"tmp",
|
|
97896
97889
|
"api-reports"
|
|
97897
|
-
).replaceAll("
|
|
97890
|
+
).replaceAll("/", "\\")
|
|
97898
97891
|
},
|
|
97899
97892
|
docModel: {
|
|
97900
97893
|
enabled: options.docModel !== false,
|
|
97901
|
-
apiJsonFilePath:
|
|
97894
|
+
apiJsonFilePath: _path2.default.join(
|
|
97902
97895
|
apiReferenceProjectDir,
|
|
97903
|
-
relativeProjectFolder,
|
|
97904
97896
|
"documents-model.api.json"
|
|
97905
|
-
).replaceAll("
|
|
97897
|
+
).replaceAll("/", "\\")
|
|
97906
97898
|
},
|
|
97907
97899
|
dtsRollup: {
|
|
97908
97900
|
enabled: true,
|
|
97909
97901
|
untrimmedFilePath: `<projectFolder>/${_path2.default.join(
|
|
97910
|
-
|
|
97911
|
-
options.outDir,
|
|
97902
|
+
options.outDir.replaceAll("\\", "/").replace(projectFolder.replaceAll("\\", "/"), ""),
|
|
97912
97903
|
`index${dtsExtension}`
|
|
97913
97904
|
).replaceAll("\\", "/")}`,
|
|
97914
97905
|
betaTrimmedFilePath: `<projectFolder>/${_path2.default.join(
|
|
97915
|
-
|
|
97916
|
-
options.outDir,
|
|
97906
|
+
options.outDir.replaceAll("\\", "/").replace(projectFolder.replaceAll("\\", "/"), ""),
|
|
97917
97907
|
"index-beta.d.ts"
|
|
97918
97908
|
).replaceAll("\\", "/")}`,
|
|
97919
97909
|
publicTrimmedFilePath: `<projectFolder>/${_path2.default.join(
|
|
97920
|
-
|
|
97921
|
-
options.outDir,
|
|
97910
|
+
options.outDir.replaceAll("\\", "/").replace(projectFolder.replaceAll("\\", "/"), ""),
|
|
97922
97911
|
"index-public.d.ts"
|
|
97923
97912
|
).replaceAll("\\", "/")}`
|
|
97924
97913
|
},
|