@storm-software/config
Advanced tools
⚡The Storm-Ops monorepo contains utility applications, tools, and various libraries to create modern and scalable web applications.
[!IMPORTANT] 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.
A package containing the definition and Zod validation schema for the custom workspace configuration used by the Storm Software organization.
Below is a list of the available configuration values that can be set through environment variables:
| Name | Description | Default |
|---|---|---|
| STORM_COLOR_BACKGROUND | The workspace's background theme color | #1d232a |
| STORM_COLOR_ERROR | The workspace's error theme color | #990000 |
| STORM_COLOR_FATAL | The workspace's fatal theme color | #7d1a1a |
| STORM_COLOR_INFO | The workspace's info theme color | #0ea5e9 |
| STORM_COLOR_PRIMARY | The workspace's primary theme color | #1fb2a6 |
| STORM_COLOR_SUCCESS | The workspace's success theme color | #087f5b |
| STORM_COLOR_WARNING | The workspace's warning theme color | #fcc419 |
| STORM_ENV | The current runtime environment of the package | "production" |
| STORM_HOMEPAGE | The homepage URL for the workspace | https://stormsoftware.org |
| STORM_LICENSE | The license used by the workspace | "Apache License 2.0" |
| STORM_LOCALE | The default locale of the workspace | "en-US" |
| STORM_LOG_LEVEL | The current maximum level of messages to write to the logs | "info" |
| STORM_ORGANIZATION | The organization of the workspace | "storm-software" |
| STORM_REPOSITORY | The repo URL of the workspace (i.e. GitHub URL) | |
| STORM_RUNTIME_DIRECTORY | The default directory of the storm runtime for storage/generation | "node_modules/.storm" |
| STORM_RUNTIME_VERSION | The global version of the Storm runtime | "1.0.0" |
| STORM_TIMEZONE | The default timezone of the workspace | "America/New_York" |
| STORM_WORKER | The worker of the package (this is the bot that will be used to perform various tasks) | "stormie-bot" |
Using pnpm:
pnpm add -D @storm-software/config
npm install -D @storm-software/config
yarn add -D @storm-software/config
This project uses tsup to package the source code due to its ability to remove unused code and ship smaller javascript files thanks to code splitting. This helps to greatly reduce the size of the package and to make it easier to use in other projects.
This project is built using Nx. As a result, many of the usual commands are available to assist in development.
Run nx build config to build the library.
Run nx test config to execute the unit tests via Jest.
Run nx lint config to run ESLint on the package.
Storm workspaces are built using Nx, 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.
See the open issues for a list of proposed features (and known issues).
Reach out to the maintainer at one of the following places:
This project is licensed under the Apache License 2.0. Feel free to edit and distribute this template as you like.
See LICENSE for more information.
This project adheres to Semantic Versioning. Every release, along with the migration instructions, is documented in the CHANGELOG file
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.
Please try to create bug reports that are:
Please adhere to this project's code of conduct.
You can use markdownlint-cli to check for common markdown style inconsistency.
Thanks goes to these wonderful people (emoji key):
 Patrick Sullivan 🎨 💻 🔧 📖 ⚠️ |  Tyler Benning 🎨 |  Stormie 🚧 |
Add your contributions
|
This project follows the all-contributors specification. Contributions of any kind welcome!
Fingerprint: 1BD2 7192 7770 2549 F4C9 F238 E6AD C420 DA5C 4C2D
FAQs
⚡The Storm-Ops monorepo contains utility applications, tools, and various libraries to create modern and scalable web applications.
The npm package @storm-software/config receives a total of 176 weekly downloads. As such, @storm-software/config popularity was classified as not popular.
We found that @storm-software/config demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.