@cspell/dict-golang
Version:
Go Language dictionary for cspell.
127 lines (76 loc) • 2.96 kB
Markdown
# CSpell Go Language Dictionary
Go Language dictionary for cspell.
This is a pre-built dictionary for use with cspell.
Supports keywords and built-in library names up to Go 1.12.
This dictionary is included by default in CSpell.
<!--- @@inject: ../../static/requirements.md --->
## Requirements
| Tool | Version |
| ------------------------------------------------------------------------------------------------------------------------------------ | ------- |
| [cspell](https://github.com/streetsidesoftware/cspell) | `>= 8` |
| [Code Spell Checker - Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) | `>= 4` |
<!--- @@inject-end: ../../static/requirements.md --->
<!--- @@inject: ./static/install.md --->
## Local Installation
**This package is bundled with CSpell.**
## Configuration
<details>
<summary>VSCode Settings</summary>
Add the following to your VSCode settings:
**`.vscode/settings.json`**
```jsonc
{
"cSpell.dictionaries": ["golang"],
}
```
</details>
<details>
<summary>CSpell Settings <code>cspell.json</code></summary>
**`cspell.json`**
```jsonc
{
"dictionaries": ["golang"],
}
```
</details>
<details>
<summary>CSpell Settings <code>cspell.config.yaml</code></summary>
**`cspell.config.yaml`**
```yaml
dictionaries:
- golang
```
</details>
## Local Installation using CDN
> **NOTE:** This package is bundled with CSpell.
## Dictionary Information
| Name | Enabled | Description |
| -------- | ------- | ---------------------- |
| `golang` | | Go Language Dictionary |
## Language Settings
| Name | Locale | File Type |
| -------- | ------ | --------- |
| `golang` | `*` | `go` |
<!--- @@inject-end: ./static/install.md --->
<!--- @@inject: ../../static/contributing.md --->
## Contributing
Please help correct any mistakes in the dictionaries.
See: [Contributing](https://github.com/streetsidesoftware/cspell-dicts#contributing)
Special thanks to all of our amazing contributors!
### Dictionary Development
See: [How to Create a New Dictionary](https://github.com/streetsidesoftware/cspell-dicts#how-to-create-a-new-dictionary)
<!--- @@inject-end: ../../static/contributing.md --->
## Contributors
@AlekSi - Alexey Palazhchenko: [AlekSi/go-words](https://github.com/AlekSi/go-words)
## License
MIT
> Some packages may have other licenses included.
<!--- @@inject: ../../static/footer.md --->
<br/>
---
<p align="center">
Brought to you by <a href="https://streetsidesoftware.com" title="Street Side Software">
<img width="16" alt="Street Side Software Logo" src="https://i.imgur.com/CyduuVY.png" /> Street Side Software
</a>
</p>
<!--- @@inject-end: ../../static/footer.md --->