47 lines
800 B
Markdown
47 lines
800 B
Markdown
|
# Cspell Ruby Dictionary
|
||
|
|
|
||
|
|
For ruby and ruby on rails
|
||
|
|
|
||
|
|
This is a pre-built dictionary for use with cspell.
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
Global Install and add to cspell global settings.
|
||
|
|
|
||
|
|
```sh
|
||
|
|
npm install -g @cspell/dict-ruby
|
||
|
|
cspell link add @cspell/dict-ruby
|
||
|
|
```
|
||
|
|
|
||
|
|
## Uninstall from cspell
|
||
|
|
|
||
|
|
```sh
|
||
|
|
cspell link remove @cspell/dict-ruby
|
||
|
|
```
|
||
|
|
|
||
|
|
## Manual Installation
|
||
|
|
|
||
|
|
The `cspell-ext.json` file in this package should be added to the import section in your cspell.json file.
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
{
|
||
|
|
// …
|
||
|
|
"import": ["@cspell/dict-ruby/cspell-ext.json"],
|
||
|
|
// …
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
## Building
|
||
|
|
|
||
|
|
Building is only necessary if you want to modify the contents of the dictionary. Note: Building will take a few minutes for large files.
|
||
|
|
|
||
|
|
```sh
|
||
|
|
npm run build
|
||
|
|
```
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
MIT
|
||
|
|
|
||
|
|
> Some packages may have other licenses included.
|