@storm-software/config-tools 1.57.0 → 1.59.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.
package/README.md CHANGED
@@ -8,9 +8,9 @@
8
8
 
9
9
  <div align="center">
10
10
  <b>
11
- <a href="https://stormsoftware.com" target="_blank">Website</a> •
12
- <a href="https://github.com/storm-software/storm-ops" target="_blank">GitHub</a> •
13
- <a href="https://discord.gg/MQ6YVzakM5">Discord</a> • <a href="https://stormstack.github.io/stormstack/" target="_blank">Docs</a> • <a href="https://stormsoftware.com/contact" target="_blank">Contact</a> •
11
+ <a href="https://stormsoftware.com" target="_blank">Website</a> •
12
+ <a href="https://github.com/storm-software/storm-ops" target="_blank">GitHub</a> •
13
+ <a href="https://discord.gg/MQ6YVzakM5">Discord</a> • <a href="https://stormstack.github.io/stormstack/" target="_blank">Docs</a> • <a href="https://stormsoftware.com/contact" target="_blank">Contact</a> •
14
14
  <a href="https://github.com/storm-software/storm-ops/issues/new?assignees=&labels=bug&template=bug-report.yml&title=Bug Report%3A+">Report a Bug</a>
15
15
  </b>
16
16
  </div>
@@ -21,18 +21,45 @@ 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.56.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 docusaurus](https://img.shields.io/badge/documented_with-docusaurus-success.svg?style=for-the-badge&logo=readthedocs&color=1fb2a6)](https://docusaurus.io/)&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.58.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
- > [!IMPORTANT] This repository, and the apps, libraries, and tools contained in
27
- > it, are still in their initial development phase. As a result, bugs and issues
28
- > are expected with their usage. When the main development phase completes, a
29
- > proper release will be performed, and the packages will be available through
30
- > NPM (and other distributions). This message will be removed at that time.
31
- > However, in the meantime, please feel free to report any issues you may come
32
- > across.
26
+ <!-- prettier-ignore-start -->
27
+ <!-- markdownlint-disable -->
28
+
29
+ > [!IMPORTANT]
30
+ > 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.
31
+
32
+ <!-- markdownlint-restore -->
33
+ <!-- prettier-ignore-end -->
34
+
35
+ <div align="center">
36
+ <b>Be sure to ⭐ this repository on <a href="https://github.com/storm-software/storm-ops" target="_blank">GitHub</a> so you can keep up to date on any daily progress!</b>
37
+ </div>
33
38
 
34
39
  <br />
35
40
 
41
+ <!-- START doctoc -->
42
+ <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
43
+ ## Table of Contents
44
+
45
+ - [Storm Configuration Tools](#storm-configuration-tools)
46
+ - [Installing](#installing)
47
+ - [Reduced Package Size](#reduced-package-size)
48
+ - [Development](#development)
49
+ - [Building](#building)
50
+ - [Running unit tests](#running-unit-tests)
51
+ - [Linting](#linting)
52
+ - [Storm Workspaces](#storm-workspaces)
53
+ - [Roadmap](#roadmap)
54
+ - [Support](#support)
55
+ - [License](#license)
56
+ - [Changelog](#changelog)
57
+ - [Contributing](#contributing)
58
+ - [Contributors](#contributors)
59
+
60
+ <!-- END doctoc -->
61
+
62
+ <br />
36
63
 
37
64
  <!-- markdownlint-restore -->
38
65
  <!-- prettier-ignore-end -->
@@ -69,9 +96,6 @@ environment variables:
69
96
  | STORM_TIMEZONE | The default timezone of the workspace | "America/New_York" |
70
97
  | STORM_BOT | The worker of the package (this is the bot that will be used to perform various tasks) | "stormie-bot" |
71
98
 
72
- <!-- START doctoc -->
73
- <!-- END doctoc -->
74
-
75
99
  ## Installing
76
100
 
77
101
  Using [pnpm](http://pnpm.io):
@@ -130,17 +154,25 @@ Run `nx lint config-tools` to run [ESLint](https://eslint.org/) on the package.
130
154
 
131
155
  ## Storm Workspaces
132
156
 
133
- Storm workspaces are built using <a href="https://nx.dev/" target="_blank">Nx</a>, a set of extensible dev tools for monorepos, which helps you develop like Google, Facebook, and Microsoft. Building on top of Nx, the Open System provides a set of tools and patterns that help you scale your monorepo to many teams while keeping the codebase maintainable.
157
+ Storm workspaces are built using
158
+ <a href="https://nx.dev/" target="_blank">Nx</a>, a set of extensible dev tools
159
+ for monorepos, which helps you develop like Google, Facebook, and Microsoft.
160
+ Building on top of Nx, the Open System provides a set of tools and patterns that
161
+ help you scale your monorepo to many teams while keeping the codebase
162
+ maintainable.
134
163
 
135
164
  <div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
136
165
  <br />
137
166
 
138
167
  ## Roadmap
139
168
 
140
- See the [open issues](https://github.com/storm-software/storm-ops/issues) for a list of proposed features (and known issues).
169
+ See the [open issues](https://github.com/storm-software/storm-ops/issues) for a
170
+ list of proposed features (and known issues).
141
171
 
142
- - [Top Feature Requests](https://github.com/storm-software/storm-ops/issues?q=label%3Aenhancement+is%3Aopen+sort%3Areactions-%2B1-desc) (Add your votes using the 👍 reaction)
143
- - [Top Bugs](https://github.com/storm-software/storm-ops/issues?q=is%3Aissue+is%3Aopen+label%3Abug+sort%3Areactions-%2B1-desc) (Add your votes using the 👍 reaction)
172
+ - [Top Feature Requests](https://github.com/storm-software/storm-ops/issues?q=label%3Aenhancement+is%3Aopen+sort%3Areactions-%2B1-desc)
173
+ (Add your votes using the 👍 reaction)
174
+ - [Top Bugs](https://github.com/storm-software/storm-ops/issues?q=is%3Aissue+is%3Aopen+label%3Abug+sort%3Areactions-%2B1-desc)
175
+ (Add your votes using the 👍 reaction)
144
176
  - [Newest Bugs](https://github.com/storm-software/storm-ops/issues?q=is%3Aopen+is%3Aissue+label%3Abug)
145
177
 
146
178
  <div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
@@ -159,7 +191,8 @@ Reach out to the maintainer at one of the following places:
159
191
 
160
192
  ## License
161
193
 
162
- This project is licensed under the **Apache License 2.0**. Feel free to edit and distribute this template as you like.
194
+ This project is licensed under the **Apache License 2.0**. Feel free to edit and
195
+ distribute this template as you like.
163
196
 
164
197
  See [LICENSE](LICENSE) for more information.
165
198
 
@@ -168,32 +201,42 @@ See [LICENSE](LICENSE) for more information.
168
201
 
169
202
  ## Changelog
170
203
 
171
- This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). Every release, along with the migration instructions, is documented in the [CHANGELOG](CHANGELOG.md) file
204
+ This project adheres to
205
+ [Semantic Versioning](https://semver.org/spec/v2.0.0.html). Every release, along
206
+ with the migration instructions, is documented in the [CHANGELOG](CHANGELOG.md)
207
+ file
172
208
 
173
209
  <div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
174
210
  <br />
175
211
 
176
212
  ## Contributing
177
213
 
178
- First off, thanks for taking the time to contribute! Contributions are what makes the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are **greatly appreciated**.
214
+ First off, thanks for taking the time to contribute! Contributions are what
215
+ makes the open-source community such an amazing place to learn, inspire, and
216
+ create. Any contributions you make will benefit everybody else and are **greatly
217
+ appreciated**.
179
218
 
180
219
  Please try to create bug reports that are:
181
220
 
182
221
  - _Reproducible._ Include steps to reproduce the problem.
183
- - _Specific._ Include as much detail as possible: which version, what environment, etc.
222
+ - _Specific._ Include as much detail as possible: which version, what
223
+ environment, etc.
184
224
  - _Unique._ Do not duplicate existing opened issues.
185
225
  - _Scoped to a Single Bug._ One bug per report.
186
226
 
187
227
  Please adhere to this project's [code of conduct](.github/CODE_OF_CONDUCT.md).
188
228
 
189
- You can use [markdownlint-cli](https://github.com/storm-software/storm-ops/markdownlint-cli) to check for common markdown style inconsistency.
229
+ You can use
230
+ [markdownlint-cli](https://github.com/storm-software/storm-ops/markdownlint-cli)
231
+ to check for common markdown style inconsistency.
190
232
 
191
233
  <div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
192
234
  <br />
193
235
 
194
236
  ## Contributors
195
237
 
196
- Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
238
+ Thanks goes to these wonderful people
239
+ ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
197
240
 
198
241
  <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
199
242
 
@@ -218,7 +261,9 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
218
261
 
219
262
  <!-- ALL-CONTRIBUTORS-LIST:END -->
220
263
 
221
- This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
264
+ This project follows the
265
+ [all-contributors](https://github.com/all-contributors/all-contributors)
266
+ specification. Contributions of any kind welcome!
222
267
 
223
268
  <div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
224
269
  <br />
@@ -232,9 +277,7 @@ This project follows the [all-contributors](https://github.com/all-contributors/
232
277
  <br />
233
278
 
234
279
  <div align="center">
235
- <b>
236
- <a href="https://stormsoftware.com" target="_blank">Website</a> • <a href="https://stormsoftware.com/contact" target="_blank">Contact</a> • <a href="https://discord.gg/MQ6YVzakM5">Discord</a> • <a href="https://linkedin.com/in/pat-sullivan-dev" target="_blank">LinkedIn</a> • <a href="https://medium.com/@pat.joseph.sullivan" target="_blank">Medium</a> • <a href="https://github.com/storm-software" target="_blank">GitHub</a> • <a href="https://keybase.io/sullivanp" target="_blank">OpenPGP Key</a>
237
- </b>
280
+ <a href="https://stormsoftware.com" target="_blank">Website</a> • <a href="https://stormsoftware.com/contact" target="_blank">Contact</a> • <a href="https://linkedin.com/in/patrick-sullivan-865526b0" target="_blank">LinkedIn</a> • <a href="https://medium.com/@pat.joseph.sullivan" target="_blank">Medium</a> • <a href="https://github.com/storm-software" target="_blank">GitHub</a> • <a href="https://keybase.io/sullivanp" target="_blank">OpenPGP Key</a>
238
281
  </div>
239
282
 
240
283
  <div align="center">
@@ -242,18 +285,34 @@ This project follows the [all-contributors](https://github.com/all-contributors/
242
285
  </div>
243
286
  <br />
244
287
 
245
- Storm Software is an open source software development organization and creator of Acidic, StormStack and StormCloud.
288
+ Storm Software is an open source software development organization and creator
289
+ of Acidic, StormStack and StormCloud.
290
+
291
+ Our mission is to make software development more accessible. Our ideal future is
292
+ one where anyone can create software without years of prior development
293
+ experience serving as a barrier to entry. We hope to achieve this via LLMs,
294
+ Generative AI, and intuitive, high-level data modeling/programming languages.
295
+
296
+ Join us on [Discord](https://discord.gg/MQ6YVzakM5) to chat with the team,
297
+ receive release notifications, ask questions, and get involved.
246
298
 
247
- Our mission is to make software development more accessible. Our ideal future is one where anyone can create software without years of prior development experience serving as a barrier to entry. We hope to achieve this via LLMs, Generative AI, and intuitive, high-level data modeling/programming languages.
299
+ If this sounds interesting, and you would like to help us in creating the next
300
+ generation of development tools, please reach out on our
301
+ [website](https://stormsoftware.com/contact) or join our
302
+ [Slack](https://join.slack.com/t/storm-software/shared_invite/zt-2gsmk04hs-i6yhK_r6urq0dkZYAwq2pA)
303
+ channel!
248
304
 
249
- If this sounds interesting, and you would like to help us in creating the next generation of development tools, please reach out on our website!
305
+ <br />
250
306
 
307
+ <div align="center"><a href="https://stormsoftware.com" target="_blank"><img src="https://pub-761b436209f44a4d886487c917806c08.r2.dev/icon-fill.png" alt="Storm Software" width="200px"/></a></div>
251
308
  <br />
252
- <h3 align="center">💻 Visit <a href="https://stormsoftware.com" target="_blank">stormsoftware.com</a> to stay up to date with this developer</h3>
309
+ <div align="center"><a href="https://stormsoftware.com" target="_blank"><img src="https://pub-761b436209f44a4d886487c917806c08.r2.dev/visit-us-text.svg" alt="Visit us at stormsoftware.com" height="90px"/></a></div>
253
310
 
254
311
  <br />
312
+
255
313
  <div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
256
314
  <br />
315
+ <br />
257
316
 
258
317
 
259
318
  <!-- markdownlint-restore -->
package/index.cjs CHANGED
@@ -66944,7 +66944,7 @@ var StormConfigSchema = z2.object({
66944
66944
  ci: z2.boolean().default(true).describe(
66945
66945
  "An indicator specifying if the current environment is a CI environment"
66946
66946
  ),
66947
- workspaceRoot: z2.string().trim().optional().describe("The root directory of the workspace"),
66947
+ workspaceRoot: z2.string().trim().default("").describe("The root directory of the workspace"),
66948
66948
  packageDirectory: z2.string().trim().optional().describe("The root directory of the package"),
66949
66949
  externalPackagePatterns: z2.array(z2.string()).default([]).describe(
66950
66950
  "The build will use these package patterns to determine if they should be external to the bundle"
@@ -67910,6 +67910,7 @@ var createStormConfig = (extensionName, schema, workspaceRoot) => {
67910
67910
  ...config.colors
67911
67911
  }
67912
67912
  });
67913
+ result.workspaceRoot ??= defaultConfig.workspaceRoot ? defaultConfig.workspaceRoot : findWorkspaceRoot(workspaceRoot);
67913
67914
  } else {
67914
67915
  result = _static_cache;
67915
67916
  }
package/index.js CHANGED
@@ -66901,7 +66901,7 @@ var StormConfigSchema = z2.object({
66901
66901
  ci: z2.boolean().default(true).describe(
66902
66902
  "An indicator specifying if the current environment is a CI environment"
66903
66903
  ),
66904
- workspaceRoot: z2.string().trim().optional().describe("The root directory of the workspace"),
66904
+ workspaceRoot: z2.string().trim().default("").describe("The root directory of the workspace"),
66905
66905
  packageDirectory: z2.string().trim().optional().describe("The root directory of the package"),
66906
66906
  externalPackagePatterns: z2.array(z2.string()).default([]).describe(
66907
66907
  "The build will use these package patterns to determine if they should be external to the bundle"
@@ -67867,6 +67867,7 @@ var createStormConfig = (extensionName, schema, workspaceRoot) => {
67867
67867
  ...config.colors
67868
67868
  }
67869
67869
  });
67870
+ result.workspaceRoot ??= defaultConfig.workspaceRoot ? defaultConfig.workspaceRoot : findWorkspaceRoot(workspaceRoot);
67870
67871
  } else {
67871
67872
  result = _static_cache;
67872
67873
  }