A package containing CSpell keyword dictionaries and shared configurations for Storm Software.
npm install @storm-software/cspell
This package is part of the ⚡Storm-Ops monorepo. The Storm-Ops packages include CLI utility applications, tools, and various libraries used to create modern, scalable web applications.
    !Semantic-Release  !GitHub Workflow Status (with event)
> [!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 available 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.
- Storm Software CSpell Dictionary
- Requirements
- Installing
- Manual Installation
- Building
- Running unit tests
- Storm Workspaces
- Roadmap
- Support
- License
- Changelog
- Contributing
- Contributors
Storm Software dictionary for cspell.
This is a pre-built dictionary for use with cspell.
| Tool | Version |
| ------------------------------------------------------------------------------------------------------------------------------------ | ------- |
| cspell | >= 6 |
| Code Spell Checker - Visual Studio Code | >= 2 |
Using pnpm:
``bash`
pnpm add -D @storm-software/cspell
cspell link add @storm-software/cspell
Using npm
`bash`
npm install -D @storm-software/cspell
cspell link add @storm-software/cspell
Using yarn
`bash`
yarn add -D @storm-software/cspell
cspell link add @storm-software/cspell
The cspell-ext.json file in this package should be added to the import section
in your cspell.json file.
`javascript`
{
// …
"import": ["@storm-software/cspell/cspell-ext.json"],
// …
}
Building is only necessary if you want to modify the contents of the dictionary.
Note: Building will take a few minutes for large files.
Run nx build cspell to build the library.
Run nx test cspell` to execute the unit tests via Jest.
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).
- Top Feature Requests
(Add your votes using the 👍 reaction)
- Top Bugs
(Add your votes using the 👍 reaction)
- Newest Bugs
Reach out to the maintainer at one of the following places:
- Contact
- GitHub discussions
-
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:
- _Reproducible._ Include steps to reproduce the problem.
- _Specific._ Include as much detail as possible: which version, what
environment, etc.
- _Unique._ Do not duplicate existing opened issues.
- _Scoped to a Single Bug._ One bug per report.
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!

Storm Software is an open source software development organization and creator
of Acidic, StormStack and StormCloud.
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.
Join us on Discord to chat with the team,
receive release notifications, ask questions, and get involved.
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 or join our
Slack
channel!