@storm-software/config 1.28.0 → 1.30.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/CHANGELOG.md +337 -454
- package/README.md +90 -27
- package/index.cjs +1 -1
- package/index.js +1 -1
- package/meta.cjs.json +1 -1
- package/meta.esm.json +1 -1
- package/package.json +1 -1
- package/schemas/storm.schema.json +1 -0
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> •
|
|
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,14 +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
|
-
[](http://nx.dev/) [](https://nextjs.org/) [](http://commitizen.github.io/cz-cli/)  [](https://docusaurus.io/) 
|
|
24
|
+
[](https://prettier.io/) [](http://nx.dev/) [](https://nextjs.org/) [](http://commitizen.github.io/cz-cli/)  [](https://fumadocs.vercel.app/) 
|
|
26
25
|
|
|
27
|
-
|
|
26
|
+
<!-- prettier-ignore-start -->
|
|
27
|
+
<!-- markdownlint-disable -->
|
|
28
|
+
|
|
29
|
+
> [!IMPORTANT]
|
|
28
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.
|
|
29
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>
|
|
38
|
+
|
|
30
39
|
<br />
|
|
31
40
|
|
|
41
|
+
<!-- START doctoc -->
|
|
42
|
+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
|
|
43
|
+
## Table of Contents
|
|
44
|
+
|
|
45
|
+
- [Storm Configuration Package](#storm-configuration-package)
|
|
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 />
|
|
32
63
|
|
|
33
64
|
<!-- markdownlint-restore -->
|
|
34
65
|
<!-- prettier-ignore-end -->
|
|
@@ -64,9 +95,6 @@ environment variables:
|
|
|
64
95
|
| STORM_TIMEZONE | The default timezone of the workspace | "America/New_York" |
|
|
65
96
|
| STORM_BOT | The worker of the package (this is the bot that will be used to perform various tasks) | "stormie-bot" |
|
|
66
97
|
|
|
67
|
-
<!-- START doctoc -->
|
|
68
|
-
<!-- END doctoc -->
|
|
69
|
-
|
|
70
98
|
## Installing
|
|
71
99
|
|
|
72
100
|
Using [pnpm](http://pnpm.io):
|
|
@@ -124,17 +152,25 @@ Run `nx lint config` to run [ESLint](https://eslint.org/) on the package.
|
|
|
124
152
|
|
|
125
153
|
## Storm Workspaces
|
|
126
154
|
|
|
127
|
-
Storm workspaces are built using
|
|
155
|
+
Storm workspaces are built using
|
|
156
|
+
<a href="https://nx.dev/" target="_blank">Nx</a>, a set of extensible dev tools
|
|
157
|
+
for monorepos, which helps you develop like Google, Facebook, and Microsoft.
|
|
158
|
+
Building on top of Nx, the Open System provides a set of tools and patterns that
|
|
159
|
+
help you scale your monorepo to many teams while keeping the codebase
|
|
160
|
+
maintainable.
|
|
128
161
|
|
|
129
162
|
<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
|
|
130
163
|
<br />
|
|
131
164
|
|
|
132
165
|
## Roadmap
|
|
133
166
|
|
|
134
|
-
See the [open issues](https://github.com/storm-software/storm-ops/issues) for a
|
|
167
|
+
See the [open issues](https://github.com/storm-software/storm-ops/issues) for a
|
|
168
|
+
list of proposed features (and known issues).
|
|
135
169
|
|
|
136
|
-
- [Top Feature Requests](https://github.com/storm-software/storm-ops/issues?q=label%3Aenhancement+is%3Aopen+sort%3Areactions-%2B1-desc)
|
|
137
|
-
|
|
170
|
+
- [Top Feature Requests](https://github.com/storm-software/storm-ops/issues?q=label%3Aenhancement+is%3Aopen+sort%3Areactions-%2B1-desc)
|
|
171
|
+
(Add your votes using the 👍 reaction)
|
|
172
|
+
- [Top Bugs](https://github.com/storm-software/storm-ops/issues?q=is%3Aissue+is%3Aopen+label%3Abug+sort%3Areactions-%2B1-desc)
|
|
173
|
+
(Add your votes using the 👍 reaction)
|
|
138
174
|
- [Newest Bugs](https://github.com/storm-software/storm-ops/issues?q=is%3Aopen+is%3Aissue+label%3Abug)
|
|
139
175
|
|
|
140
176
|
<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
|
|
@@ -153,7 +189,8 @@ Reach out to the maintainer at one of the following places:
|
|
|
153
189
|
|
|
154
190
|
## License
|
|
155
191
|
|
|
156
|
-
This project is licensed under the **Apache License 2.0**. Feel free to edit and
|
|
192
|
+
This project is licensed under the **Apache License 2.0**. Feel free to edit and
|
|
193
|
+
distribute this template as you like.
|
|
157
194
|
|
|
158
195
|
See [LICENSE](LICENSE) for more information.
|
|
159
196
|
|
|
@@ -162,32 +199,42 @@ See [LICENSE](LICENSE) for more information.
|
|
|
162
199
|
|
|
163
200
|
## Changelog
|
|
164
201
|
|
|
165
|
-
This project adheres to
|
|
202
|
+
This project adheres to
|
|
203
|
+
[Semantic Versioning](https://semver.org/spec/v2.0.0.html). Every release, along
|
|
204
|
+
with the migration instructions, is documented in the [CHANGELOG](CHANGELOG.md)
|
|
205
|
+
file
|
|
166
206
|
|
|
167
207
|
<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
|
|
168
208
|
<br />
|
|
169
209
|
|
|
170
210
|
## Contributing
|
|
171
211
|
|
|
172
|
-
First off, thanks for taking the time to contribute! Contributions are what
|
|
212
|
+
First off, thanks for taking the time to contribute! Contributions are what
|
|
213
|
+
makes the open-source community such an amazing place to learn, inspire, and
|
|
214
|
+
create. Any contributions you make will benefit everybody else and are **greatly
|
|
215
|
+
appreciated**.
|
|
173
216
|
|
|
174
217
|
Please try to create bug reports that are:
|
|
175
218
|
|
|
176
219
|
- _Reproducible._ Include steps to reproduce the problem.
|
|
177
|
-
- _Specific._ Include as much detail as possible: which version, what
|
|
220
|
+
- _Specific._ Include as much detail as possible: which version, what
|
|
221
|
+
environment, etc.
|
|
178
222
|
- _Unique._ Do not duplicate existing opened issues.
|
|
179
223
|
- _Scoped to a Single Bug._ One bug per report.
|
|
180
224
|
|
|
181
225
|
Please adhere to this project's [code of conduct](.github/CODE_OF_CONDUCT.md).
|
|
182
226
|
|
|
183
|
-
You can use
|
|
227
|
+
You can use
|
|
228
|
+
[markdownlint-cli](https://github.com/storm-software/storm-ops/markdownlint-cli)
|
|
229
|
+
to check for common markdown style inconsistency.
|
|
184
230
|
|
|
185
231
|
<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
|
|
186
232
|
<br />
|
|
187
233
|
|
|
188
234
|
## Contributors
|
|
189
235
|
|
|
190
|
-
Thanks goes to these wonderful people
|
|
236
|
+
Thanks goes to these wonderful people
|
|
237
|
+
([emoji key](https://allcontributors.org/docs/en/emoji-key)):
|
|
191
238
|
|
|
192
239
|
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
|
|
193
240
|
|
|
@@ -212,7 +259,9 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
|
|
|
212
259
|
|
|
213
260
|
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
|
214
261
|
|
|
215
|
-
This project follows the
|
|
262
|
+
This project follows the
|
|
263
|
+
[all-contributors](https://github.com/all-contributors/all-contributors)
|
|
264
|
+
specification. Contributions of any kind welcome!
|
|
216
265
|
|
|
217
266
|
<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
|
|
218
267
|
<br />
|
|
@@ -226,9 +275,7 @@ This project follows the [all-contributors](https://github.com/all-contributors/
|
|
|
226
275
|
<br />
|
|
227
276
|
|
|
228
277
|
<div align="center">
|
|
229
|
-
<
|
|
230
|
-
<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>
|
|
231
|
-
</b>
|
|
278
|
+
<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>
|
|
232
279
|
</div>
|
|
233
280
|
|
|
234
281
|
<div align="center">
|
|
@@ -236,18 +283,34 @@ This project follows the [all-contributors](https://github.com/all-contributors/
|
|
|
236
283
|
</div>
|
|
237
284
|
<br />
|
|
238
285
|
|
|
239
|
-
Storm Software is an open source software development organization and creator
|
|
286
|
+
Storm Software is an open source software development organization and creator
|
|
287
|
+
of Acidic, StormStack and StormCloud.
|
|
288
|
+
|
|
289
|
+
Our mission is to make software development more accessible. Our ideal future is
|
|
290
|
+
one where anyone can create software without years of prior development
|
|
291
|
+
experience serving as a barrier to entry. We hope to achieve this via LLMs,
|
|
292
|
+
Generative AI, and intuitive, high-level data modeling/programming languages.
|
|
293
|
+
|
|
294
|
+
Join us on [Discord](https://discord.gg/MQ6YVzakM5) to chat with the team,
|
|
295
|
+
receive release notifications, ask questions, and get involved.
|
|
240
296
|
|
|
241
|
-
|
|
297
|
+
If this sounds interesting, and you would like to help us in creating the next
|
|
298
|
+
generation of development tools, please reach out on our
|
|
299
|
+
[website](https://stormsoftware.com/contact) or join our
|
|
300
|
+
[Slack](https://join.slack.com/t/storm-software/shared_invite/zt-2gsmk04hs-i6yhK_r6urq0dkZYAwq2pA)
|
|
301
|
+
channel!
|
|
242
302
|
|
|
243
|
-
|
|
303
|
+
<br />
|
|
244
304
|
|
|
305
|
+
<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>
|
|
245
306
|
<br />
|
|
246
|
-
<
|
|
307
|
+
<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>
|
|
247
308
|
|
|
248
309
|
<br />
|
|
310
|
+
|
|
249
311
|
<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
|
|
250
312
|
<br />
|
|
313
|
+
<br />
|
|
251
314
|
|
|
252
315
|
|
|
253
316
|
<!-- markdownlint-restore -->
|
package/index.cjs
CHANGED
|
@@ -4037,7 +4037,7 @@ var StormConfigSchema = z.object({
|
|
|
4037
4037
|
ci: z.boolean().default(true).describe(
|
|
4038
4038
|
"An indicator specifying if the current environment is a CI environment"
|
|
4039
4039
|
),
|
|
4040
|
-
workspaceRoot: z.string().trim().
|
|
4040
|
+
workspaceRoot: z.string().trim().default("").describe("The root directory of the workspace"),
|
|
4041
4041
|
packageDirectory: z.string().trim().optional().describe("The root directory of the package"),
|
|
4042
4042
|
externalPackagePatterns: z.array(z.string()).default([]).describe(
|
|
4043
4043
|
"The build will use these package patterns to determine if they should be external to the bundle"
|
package/index.js
CHANGED
|
@@ -4002,7 +4002,7 @@ var StormConfigSchema = z.object({
|
|
|
4002
4002
|
ci: z.boolean().default(true).describe(
|
|
4003
4003
|
"An indicator specifying if the current environment is a CI environment"
|
|
4004
4004
|
),
|
|
4005
|
-
workspaceRoot: z.string().trim().
|
|
4005
|
+
workspaceRoot: z.string().trim().default("").describe("The root directory of the workspace"),
|
|
4006
4006
|
packageDirectory: z.string().trim().optional().describe("The root directory of the package"),
|
|
4007
4007
|
externalPackagePatterns: z.array(z.string()).default([]).describe(
|
|
4008
4008
|
"The build will use these package patterns to determine if they should be external to the bundle"
|
package/meta.cjs.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"inputs":{"node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/index.mjs":{"bytes":149466,"imports":[],"format":"esm"},"packages/config/src/schema.ts":{"bytes":
|
|
1
|
+
{"inputs":{"node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/index.mjs":{"bytes":149466,"imports":[],"format":"esm"},"packages/config/src/schema.ts":{"bytes":9532,"imports":[{"path":"node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/index.mjs","kind":"import-statement","original":"zod"}],"format":"esm"},"packages/config/src/types.ts":{"bytes":1890,"imports":[],"format":"esm"},"packages/config/src/define-config.ts":{"bytes":313,"imports":[],"format":"esm"},"packages/config/src/index.ts":{"bytes":311,"imports":[{"path":"packages/config/src/schema.ts","kind":"import-statement","original":"./schema"},{"path":"packages/config/src/types.ts","kind":"import-statement","original":"./types"},{"path":"packages/config/src/define-config.ts","kind":"import-statement","original":"./define-config"}],"format":"esm"}},"outputs":{"dist/packages/config/index.cjs":{"imports":[],"exports":[],"entryPoint":"packages/config/src/index.ts","inputs":{"packages/config/src/index.ts":{"bytesInOutput":679},"node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/index.mjs":{"bytesInOutput":116969},"packages/config/src/schema.ts":{"bytesInOutput":7918},"packages/config/src/types.ts":{"bytesInOutput":133},"packages/config/src/define-config.ts":{"bytesInOutput":37}},"bytes":126727}}}
|
package/meta.esm.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"inputs":{"node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/index.mjs":{"bytes":149466,"imports":[],"format":"esm"},"packages/config/src/schema.ts":{"bytes":
|
|
1
|
+
{"inputs":{"node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/index.mjs":{"bytes":149466,"imports":[],"format":"esm"},"packages/config/src/schema.ts":{"bytes":9532,"imports":[{"path":"node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/index.mjs","kind":"import-statement","original":"zod"}],"format":"esm"},"packages/config/src/types.ts":{"bytes":1890,"imports":[],"format":"esm"},"packages/config/src/define-config.ts":{"bytes":313,"imports":[],"format":"esm"},"packages/config/src/index.ts":{"bytes":311,"imports":[{"path":"packages/config/src/schema.ts","kind":"import-statement","original":"./schema"},{"path":"packages/config/src/types.ts","kind":"import-statement","original":"./types"},{"path":"packages/config/src/define-config.ts","kind":"import-statement","original":"./define-config"}],"format":"esm"}},"outputs":{"dist/packages/config/index.js":{"imports":[],"exports":["COLOR_KEYS","ColorConfigMapSchema","ColorConfigSchema","DarkThemeColorConfigSchema","LightThemeColorConfigSchema","MultiThemeColorConfigSchema","RegistryConfigSchema","RegistryUrlConfigSchema","SingleThemeColorConfigSchema","StormConfigSchema","defineConfig"],"entryPoint":"packages/config/src/index.ts","inputs":{"node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/index.mjs":{"bytesInOutput":116969},"packages/config/src/schema.ts":{"bytesInOutput":7918},"packages/config/src/index.ts":{"bytesInOutput":0},"packages/config/src/types.ts":{"bytesInOutput":133},"packages/config/src/define-config.ts":{"bytesInOutput":37}},"bytes":125511}}}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@storm-software/config",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.30.0",
|
|
4
4
|
"description": "⚡The Storm-Ops monorepo contains utility applications, tools, and various libraries to create modern and scalable web applications.",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "github",
|