@storm-software/workspace-tools 1.225.0 → 1.226.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.
Files changed (3) hide show
  1. package/CHANGELOG.md +17 -0
  2. package/README.md +60 -19
  3. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -1,3 +1,20 @@
1
+ ## 1.226.0 (2025-01-12)
2
+
3
+ ### Features
4
+
5
+ - **tsdown:** Added the `tsdown` build executor
6
+ ([72f4efad](https://github.com/storm-software/storm-ops/commit/72f4efad))
7
+
8
+ ### Bug Fixes
9
+
10
+ - **workspace-tools:** Resolved build issue when bundling `tsdown` package
11
+ ([16b519bb](https://github.com/storm-software/storm-ops/commit/16b519bb))
12
+
13
+ ### Continuous Integration
14
+
15
+ - **tsdown:** Update package to exclude `oxc` packages from distributable
16
+ ([8e9ad1ad](https://github.com/storm-software/storm-ops/commit/8e9ad1ad))
17
+
1
18
  ## 1.225.0 (2025-01-12)
2
19
 
3
20
  ### Features
package/README.md CHANGED
@@ -21,7 +21,7 @@ This package is part of the <b>⚡Storm-Ops</b> monorepo. The Storm-Ops packages
21
21
 
22
22
  <h3 align="center">💻 Visit <a href="https://stormsoftware.com" target="_blank">stormsoftware.com</a> to stay up to date with this developer</h3><br />
23
23
 
24
- [![Version](https://img.shields.io/badge/version-1.224.2-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;[![Nx](https://img.shields.io/badge/Nx-17.0.2-lightgrey?style=for-the-badge&logo=nx&logoWidth=20&&color=1fb2a6)](http://nx.dev/)&nbsp;[![NextJs](https://img.shields.io/badge/Next.js-14.0.2-lightgrey?style=for-the-badge&logo=nextdotjs&logoWidth=20&color=1fb2a6)](https://nextjs.org/)&nbsp;[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge&logo=commitlint&color=1fb2a6)](http://commitizen.github.io/cz-cli/)&nbsp;![Semantic-Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge&color=1fb2a6)&nbsp;[![documented with Fumadocs](https://img.shields.io/badge/documented_with-fumadocs-success.svg?style=for-the-badge&logo=readthedocs&color=1fb2a6)](https://fumadocs.vercel.app/)&nbsp;![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/storm-software/storm-ops/cr.yml?style=for-the-badge&logo=github-actions&color=1fb2a6)
24
+ [![Version](https://img.shields.io/badge/version-1.225.0-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;[![Nx](https://img.shields.io/badge/Nx-17.0.2-lightgrey?style=for-the-badge&logo=nx&logoWidth=20&&color=1fb2a6)](http://nx.dev/)&nbsp;[![NextJs](https://img.shields.io/badge/Next.js-14.0.2-lightgrey?style=for-the-badge&logo=nextdotjs&logoWidth=20&color=1fb2a6)](https://nextjs.org/)&nbsp;[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge&logo=commitlint&color=1fb2a6)](http://commitizen.github.io/cz-cli/)&nbsp;![Semantic-Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge&color=1fb2a6)&nbsp;[![documented with Fumadocs](https://img.shields.io/badge/documented_with-fumadocs-success.svg?style=for-the-badge&logo=readthedocs&color=1fb2a6)](https://fumadocs.vercel.app/)&nbsp;![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/storm-software/storm-ops/cr.yml?style=for-the-badge&logo=github-actions&color=1fb2a6)
25
25
 
26
26
  <!-- prettier-ignore-start -->
27
27
  <!-- markdownlint-disable -->
@@ -49,56 +49,59 @@ This package is part of the <b>⚡Storm-Ops</b> monorepo. The Storm-Ops packages
49
49
  - [Typia Generate](#typia-generate)
50
50
  - [Example](#example)
51
51
  - [Options](#options)
52
- - [ESBuild Builder](#esbuild-builder)
52
+ - [TSDown Builder](#tsdown-builder)
53
53
  - [Example](#example-1)
54
54
  - [Options](#options-1)
55
- - [Unbuild Builder](#unbuild-builder)
55
+ - [ESBuild Builder](#esbuild-builder)
56
56
  - [Example](#example-2)
57
57
  - [Options](#options-2)
58
- - [Clean Publish](#clean-publish)
58
+ - [Unbuild Builder](#unbuild-builder)
59
59
  - [Example](#example-3)
60
60
  - [Options](#options-3)
61
- - [Size-Limit Test](#size-limit-test)
61
+ - [Clean Publish](#clean-publish)
62
62
  - [Example](#example-4)
63
63
  - [Options](#options-4)
64
- - [Npm Publish](#npm-publish)
64
+ - [Size-Limit Test](#size-limit-test)
65
65
  - [Example](#example-5)
66
66
  - [Options](#options-5)
67
- - [Cargo Publish](#cargo-publish)
67
+ - [Npm Publish](#npm-publish)
68
68
  - [Example](#example-6)
69
69
  - [Options](#options-6)
70
- - [Cargo Build](#cargo-build)
70
+ - [Cargo Publish](#cargo-publish)
71
71
  - [Example](#example-7)
72
72
  - [Options](#options-7)
73
- - [Cargo Check](#cargo-check)
73
+ - [Cargo Build](#cargo-build)
74
74
  - [Example](#example-8)
75
75
  - [Options](#options-8)
76
- - [Cargo Format](#cargo-format)
76
+ - [Cargo Check](#cargo-check)
77
77
  - [Example](#example-9)
78
78
  - [Options](#options-9)
79
- - [Cargo Clippy](#cargo-clippy)
79
+ - [Cargo Format](#cargo-format)
80
80
  - [Example](#example-10)
81
81
  - [Options](#options-10)
82
- - [Cargo Doc](#cargo-doc)
82
+ - [Cargo Clippy](#cargo-clippy)
83
83
  - [Example](#example-11)
84
84
  - [Options](#options-11)
85
+ - [Cargo Doc](#cargo-doc)
86
+ - [Example](#example-12)
87
+ - [Options](#options-12)
85
88
  - [Generators](#generators)
86
89
  - [Init Storm Workspace Plugin](#init-storm-workspace-plugin)
87
- - [Options](#options-12)
90
+ - [Options](#options-13)
88
91
  - [Workspace Preset](#workspace-preset)
89
92
  - [Examples](#examples)
90
- - [Options](#options-13)
91
- - [Add Node Library](#add-node-library)
92
93
  - [Options](#options-14)
93
- - [Configuration Schema Creator](#configuration-schema-creator)
94
+ - [Add Node Library](#add-node-library)
94
95
  - [Options](#options-15)
95
- - [Add Neutral Library](#add-neutral-library)
96
+ - [Configuration Schema Creator](#configuration-schema-creator)
96
97
  - [Options](#options-16)
97
- - [Add browser Library](#add-browser-library)
98
+ - [Add Neutral Library](#add-neutral-library)
98
99
  - [Options](#options-17)
100
+ - [Add browser Library](#add-browser-library)
101
+ - [Options](#options-18)
99
102
  - [design-tokens](#design-tokens)
100
103
  - [Storm Release Version Generator](#storm-release-version-generator)
101
- - [Options](#options-18)
104
+ - [Options](#options-19)
102
105
  - [Building](#building)
103
106
  - [Running unit tests](#running-unit-tests)
104
107
  - [Storm Workspaces](#storm-workspaces)
@@ -189,6 +192,44 @@ The following executor options are available:
189
192
 
190
193
 
191
194
 
195
+ ## TSDown Builder
196
+
197
+ Run the \`tsdown\` build process on a selected project
198
+
199
+ ### Example
200
+
201
+ This executor can be used by executing the following in a command line utility:
202
+
203
+ ```cmd
204
+ nx run my-project:tsdown
205
+ ```
206
+
207
+ **Please note:** _The tsdown 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._
208
+
209
+ ### Options
210
+
211
+ The following executor options are available:
212
+
213
+ | Option | Type | Description | Default |
214
+ | --------- | ------ | ------------- | --------- |
215
+ | **entry \*** | `string[]` | The path to the entry file (or multiple paths/files), relative to \`projectRoot\` path. | `[]` |
216
+ | **outputPath \*** | `string` | The output path of the generated files. | "dist/{projectRoot}" |
217
+ | **tsconfig \*** | `string` | The path to the \`tsconfig.json\` file. | "{projectRoot}/tsconfig.json" |
218
+ | watch | `boolean` | Enable re-building when files change. | |
219
+ | assets | `array` | List of static assets. | `[]` |
220
+ | clean | `boolean` | Remove previous output before build. | `true` |
221
+ | includeSrc | `boolean` | Should the source files be added to the distribution folder in an \`src\` directory. | |
222
+ | generatePackageJson | `boolean` | Should a package.json file be generated in the output folder or should the existing one be copied in. | `true` |
223
+ | debug | `boolean` | Should output be unminified with source mappings. | |
224
+ | platform | "browser" \| "neutral" \| "node" | Platform target for outputs. | "neutral" |
225
+ | minify | `boolean` | Should the build process minify the output files? | |
226
+ | verbose | `boolean` | Should write extra log outputs with details from the executor. | |
227
+
228
+
229
+ **Please note:** _Option names followed by \* above are required, and must be provided to run the executor._
230
+
231
+
232
+
192
233
  ## ESBuild Builder
193
234
 
194
235
  Run the esbuild build process on a selected project
package/package.json CHANGED
@@ -1 +1 @@
1
- {"name":"@storm-software/workspace-tools","version":"1.225.0","type":"commonjs","description":"Tools for managing a Storm workspace, including various Nx generators and executors for common development tasks.","repository":{"type":"github","url":"https://github.com/storm-software/storm-ops","directory":"packages/workspace-tools"},"homepage":"https://stormsoftware.com","bugs":"https://github.com/storm-software/storm-ops/issues","author":{"name":"Storm Software","email":"contact@stormsoftware.com","url":"https://stormsoftware.com"},"license":"Apache-2.0","private":false,"main":"./index.js","exports":{".":"./index.js","./package.json":"./package.json","./config/nx-default.json":"./config/nx-default.json","./config/nx-cloud.json":"./config/nx-cloud.json","./assets/cjs_shims":"./assets/cjs_shims.js","./assets/esm_shims":"./assets/esm_shims.js","./migrations.json":"./migrations.json","./generators.json":"./generators.json","./generators/*/schema.json":"./src/generators/*/schema.json","./executors.json":"./executors.json","./executors/*/schema.json":"./src/executors/*/schema.json","./plugins/rust":"./src/plugins/rust/index.js","./plugins/typescript":"./src/plugins/typescript/index.js","./plugins/typescript/tsup":"./src/plugins/typescript/tsup.js","./preset":"./src/generators/preset/preset.js","./base":"./src/base/index.js","./base/*":"./src/base/*.js","./utils":"./src/utils/index.js","./utils/*":"./src/utils/*.js"},"typings":"./declarations.d.ts","keywords":["monorepo","open-system","storm","storm-ops","storm-stack","stormstack","sullivanpj"],"peerDependencies":{"@microsoft/api-extractor":"^7.48.1","@nx/devkit":"^20.3.1","@samchon/openapi":"^2.3.0","nx":"^20.3.1","tsdown":"0.5.3","typescript":"^5.7.2"},"peerDependenciesMeta":{"@microsoft/api-extractor":{"optional":true},"@nx/devkit":{"optional":false},"@samchon/openapi":{"optional":true},"nx":{"optional":false},"tsdown":{"optional":true},"typescript":{"optional":false}},"dependencies":{"@ltd/j-toml":"1.38.0","@nx/devkit":"^20.3.1","@size-limit/esbuild":"11.1.4","@size-limit/esbuild-why":"11.1.4","@size-limit/file":"11.1.4","deep-clone":"4.0.0","defu":"6.1.4","fs-extra":"11.2.0","glob":"10.4.2","micromatch":"4.0.7","pkg-types":"^1.1.1","prettier":"^3.3.3","prettier-plugin-packagejson":"2.5.0","read-yaml-file":"2.1.0","semver":"7.6.2","size-limit":"11.1.4","tsdown":"0.5.3","tsup":"8.0.0","typia":"^7.5.0","zod":"^3.24.0","zod-to-json-schema":"3.23.1"},"devDependencies":{"@microsoft/api-extractor":"^7.48.1","@nx/esbuild":"^20.3.1","@types/micromatch":"4.0.9","@types/node":"^22.10.2","@types/semver":"7.5.8","nx":"^20.3.1","typescript":"^5.7.2"},"publishConfig":{"access":"public"},"executors":"./executors.json","generators":"./generators.json"}
1
+ {"name":"@storm-software/workspace-tools","version":"1.226.0","type":"commonjs","description":"Tools for managing a Storm workspace, including various Nx generators and executors for common development tasks.","repository":{"type":"github","url":"https://github.com/storm-software/storm-ops","directory":"packages/workspace-tools"},"homepage":"https://stormsoftware.com","bugs":"https://github.com/storm-software/storm-ops/issues","author":{"name":"Storm Software","email":"contact@stormsoftware.com","url":"https://stormsoftware.com"},"license":"Apache-2.0","private":false,"main":"./index.js","exports":{".":"./index.js","./package.json":"./package.json","./config/nx-default.json":"./config/nx-default.json","./config/nx-cloud.json":"./config/nx-cloud.json","./assets/cjs_shims":"./assets/cjs_shims.js","./assets/esm_shims":"./assets/esm_shims.js","./migrations.json":"./migrations.json","./generators.json":"./generators.json","./generators/*/schema.json":"./src/generators/*/schema.json","./executors.json":"./executors.json","./executors/*/schema.json":"./src/executors/*/schema.json","./plugins/rust":"./src/plugins/rust/index.js","./plugins/typescript":"./src/plugins/typescript/index.js","./plugins/typescript/tsup":"./src/plugins/typescript/tsup.js","./preset":"./src/generators/preset/preset.js","./base":"./src/base/index.js","./base/*":"./src/base/*.js","./utils":"./src/utils/index.js","./utils/*":"./src/utils/*.js"},"typings":"./declarations.d.ts","keywords":["monorepo","open-system","storm","storm-ops","storm-stack","stormstack","sullivanpj"],"peerDependencies":{"@microsoft/api-extractor":"^7.48.1","@nx/devkit":"^20.3.1","@samchon/openapi":"^2.3.0","nx":"^20.3.1","tsdown":"0.5.3","typescript":"^5.7.2"},"peerDependenciesMeta":{"@microsoft/api-extractor":{"optional":true},"@nx/devkit":{"optional":false},"@samchon/openapi":{"optional":true},"nx":{"optional":false},"tsdown":{"optional":true},"typescript":{"optional":false}},"dependencies":{"@ltd/j-toml":"1.38.0","@nx/devkit":"^20.3.1","@size-limit/esbuild":"11.1.4","@size-limit/esbuild-why":"11.1.4","@size-limit/file":"11.1.4","deep-clone":"4.0.0","defu":"6.1.4","fs-extra":"11.2.0","glob":"10.4.2","micromatch":"4.0.7","pkg-types":"^1.1.1","prettier":"^3.3.3","prettier-plugin-packagejson":"2.5.0","read-yaml-file":"2.1.0","semver":"7.6.2","size-limit":"11.1.4","tsdown":"0.5.3","tsup":"8.0.0","typia":"^7.5.0","zod":"^3.24.0","zod-to-json-schema":"3.23.1"},"devDependencies":{"@microsoft/api-extractor":"^7.48.1","@nx/esbuild":"^20.3.1","@types/micromatch":"4.0.9","@types/node":"^22.10.2","@types/semver":"7.5.8","nx":"^20.3.1","typescript":"^5.7.2"},"publishConfig":{"access":"public"},"executors":"./executors.json","generators":"./generators.json"}