@storm-software/config 1.24.0 β†’ 1.29.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 CHANGED
@@ -1,3 +1,40 @@
1
+ ## 1.29.0 (2024-07-17)
2
+
3
+
4
+ ### πŸš€ Features
5
+
6
+ - **git-tools:** Added README header template to include table of contents ([6841042e](https://github.com/storm-software/storm-ops/commit/6841042e))
7
+
8
+ ## 1.28.0 (2024-06-22)
9
+
10
+
11
+ ### πŸš€ Features
12
+
13
+ - **workspace-tools:** Upgrade the workspace pnpm-lock file ([d33c20cb](https://github.com/storm-software/storm-ops/commit/d33c20cb))
14
+
15
+ ## 1.27.0 (2024-06-22)
16
+
17
+
18
+ ### πŸš€ Features
19
+
20
+ - **storm-ops:** Updated pnpm-lock file ([22be1efd](https://github.com/storm-software/storm-ops/commit/22be1efd))
21
+
22
+ ## 1.26.0 (2024-06-22)
23
+
24
+
25
+ ### πŸš€ Features
26
+
27
+ - **config:** Added `$schema` field to Storm configuration schema ([b4b3323a](https://github.com/storm-software/storm-ops/commit/b4b3323a))
28
+
29
+ - **workspace-tools:** Added `lint` and `format` tasks and improved cache input management ([f2ade202](https://github.com/storm-software/storm-ops/commit/f2ade202))
30
+
31
+ ## 1.25.0 (2024-06-21)
32
+
33
+
34
+ ### πŸš€ Features
35
+
36
+ - **eslint-plugin:** Resolve issues with eslint module types ([ca513974](https://github.com/storm-software/storm-ops/commit/ca513974))
37
+
1
38
  ## 1.24.0 (2024-06-05)
2
39
 
3
40
 
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,14 +21,46 @@ 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.23.0-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;
25
- [![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.28.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)
26
25
 
27
- > [!IMPORTANT]
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
+ - [πŸ’» Visit stormsoftware.com to stay up to date with this developer](#-visit-stormsoftwarecom-to-stay-up-to-date-with-this-developer)
60
+
61
+ <!-- END doctoc -->
62
+
63
+ <br />
32
64
 
33
65
  <!-- markdownlint-restore -->
34
66
  <!-- prettier-ignore-end -->
@@ -64,9 +96,6 @@ environment variables:
64
96
  | STORM_TIMEZONE | The default timezone of the workspace | "America/New_York" |
65
97
  | STORM_BOT | The worker of the package (this is the bot that will be used to perform various tasks) | "stormie-bot" |
66
98
 
67
- <!-- START doctoc -->
68
- <!-- END doctoc -->
69
-
70
99
  ## Installing
71
100
 
72
101
  Using [pnpm](http://pnpm.io):
package/index.cjs CHANGED
@@ -4004,7 +4004,7 @@ var RegistryConfigSchema = z.object({
4004
4004
  npm: RegistryUrlConfigSchema,
4005
4005
  cargo: RegistryUrlConfigSchema,
4006
4006
  cyclone: RegistryUrlConfigSchema
4007
- }).describe("A list of remote registry URLs used by Storm Software");
4007
+ }).default({}).describe("A list of remote registry URLs used by Storm Software");
4008
4008
  var ColorConfigSchema = SingleThemeColorConfigSchema.or(
4009
4009
  MultiThemeColorConfigSchema
4010
4010
  ).describe("Colors used for various workspace elements");
@@ -4013,6 +4013,11 @@ var ColorConfigMapSchema = z.union([
4013
4013
  z.record(z.string(), ColorConfigSchema)
4014
4014
  ]);
4015
4015
  var StormConfigSchema = z.object({
4016
+ $schema: z.string().trim().default(
4017
+ "https://cdn.jsdelivr.net/npm/@storm-software/config/schemas/storm.schema.json"
4018
+ ).describe(
4019
+ "The URL to the JSON schema file that describes the Storm configuration file"
4020
+ ),
4016
4021
  extends: z.string().trim().optional().describe(
4017
4022
  "The path to a base JSON file to use as a configuration preset file"
4018
4023
  ),
package/index.js CHANGED
@@ -3969,7 +3969,7 @@ var RegistryConfigSchema = z.object({
3969
3969
  npm: RegistryUrlConfigSchema,
3970
3970
  cargo: RegistryUrlConfigSchema,
3971
3971
  cyclone: RegistryUrlConfigSchema
3972
- }).describe("A list of remote registry URLs used by Storm Software");
3972
+ }).default({}).describe("A list of remote registry URLs used by Storm Software");
3973
3973
  var ColorConfigSchema = SingleThemeColorConfigSchema.or(
3974
3974
  MultiThemeColorConfigSchema
3975
3975
  ).describe("Colors used for various workspace elements");
@@ -3978,6 +3978,11 @@ var ColorConfigMapSchema = z.union([
3978
3978
  z.record(z.string(), ColorConfigSchema)
3979
3979
  ]);
3980
3980
  var StormConfigSchema = z.object({
3981
+ $schema: z.string().trim().default(
3982
+ "https://cdn.jsdelivr.net/npm/@storm-software/config/schemas/storm.schema.json"
3983
+ ).describe(
3984
+ "The URL to the JSON schema file that describes the Storm configuration file"
3985
+ ),
3981
3986
  extends: z.string().trim().optional().describe(
3982
3987
  "The path to a base JSON file to use as a configuration preset file"
3983
3988
  ),
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":9247,"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":7682},"packages/config/src/types.ts":{"bytesInOutput":133},"packages/config/src/define-config.ts":{"bytesInOutput":37}},"bytes":126491}}}
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":9531,"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":7917},"packages/config/src/types.ts":{"bytesInOutput":133},"packages/config/src/define-config.ts":{"bytesInOutput":37}},"bytes":126726}}}
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":9247,"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":7682},"packages/config/src/index.ts":{"bytesInOutput":0},"packages/config/src/types.ts":{"bytesInOutput":133},"packages/config/src/define-config.ts":{"bytesInOutput":37}},"bytes":125275}}}
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":9531,"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":7917},"packages/config/src/index.ts":{"bytesInOutput":0},"packages/config/src/types.ts":{"bytesInOutput":133},"packages/config/src/define-config.ts":{"bytesInOutput":37}},"bytes":125510}}}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@storm-software/config",
3
- "version": "1.24.0",
3
+ "version": "1.29.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",
@@ -4,6 +4,11 @@
4
4
  "StormConfiguration": {
5
5
  "type": "object",
6
6
  "properties": {
7
+ "$schema": {
8
+ "type": "string",
9
+ "default": "https://cdn.jsdelivr.net/npm/@storm-software/config/schemas/storm.schema.json",
10
+ "description": "The URL to the JSON schema file that describes the Storm configuration file"
11
+ },
7
12
  "extends": {
8
13
  "type": "string",
9
14
  "description": "The path to a base JSON file to use as a configuration preset file"
@@ -174,6 +179,7 @@
174
179
  }
175
180
  },
176
181
  "additionalProperties": false,
182
+ "default": {},
177
183
  "description": "A list of remote registry URLs used by Storm Software"
178
184
  },
179
185
  "configFile": {
@@ -388,7 +394,7 @@
388
394
  "description": "Configuration of each used extension"
389
395
  }
390
396
  },
391
- "required": ["registry", "colors"],
397
+ "required": ["colors"],
392
398
  "additionalProperties": false,
393
399
  "description": "Storm Workspace config values used during various dev-ops processes. This type is a combination of the StormPackageConfig and StormProject types. It represents the config of the entire monorepo."
394
400
  }