@cspell/dict-en-gb

What is @cspell/dict-en-gb?

@cspell/dict-en-gb is a dictionary package for the CSpell spell checker that provides British English word lists. It is used to enhance the spell-checking capabilities of CSpell by adding support for British English.

What are @cspell/dict-en-gb's main functionalities?

Adding British English Dictionary to CSpell

This feature allows you to add the British English dictionary to your CSpell configuration. By including 'en-gb' in the dictionaries array, CSpell will use the British English word list for spell checking.

{
  "dictionaries": ["en-gb"]
}

Installation

This command installs the @cspell/dict-en-gb package as a development dependency in your project. This is the first step to enable British English spell checking in your project.

npm install -D @cspell/dict-en-gb

Configuration in cspell.json

This is an example of a cspell.json configuration file that sets the language to British English and includes the British English dictionary. This configuration ensures that CSpell uses the British English word list for spell checking.

{
  "version": "0.2",
  "language": "en-gb",
  "dictionaries": ["en-gb"]
}

Other packages similar to @cspell/dict-en-gb

cspell-dict-pt-br

cspell-dict-pt-br provides a Brazilian Portuguese dictionary for CSpell. It is similar to @cspell/dict-en-gb but focuses on Brazilian Portuguese word lists.

@cspell/dict-fr-fr

@cspell/dict-fr-fr provides a French dictionary for CSpell. It is similar to @cspell/dict-en-gb but focuses on French word lists.

README

CSpell en_GB Dictionary

British English dictionary for cspell.

This is a pre-built dictionary for use with cspell.

Requirements

Tool	Version
cspell	>= 8
Code Spell Checker - Visual Studio Code	>= 4

Local Installation

npm install -D @cspell/dict-en-gb

Configuration

VSCode Settings

Add the following to your VSCode settings:

.vscode/settings.json

{
  "cSpell.import": ["@cspell/dict-en-gb/cspell-ext.json"],
  "cSpell.language": "en-GB",
}

CSpell Settings cspell.json

cspell.json

{
  "import": ["@cspell/dict-en-gb/cspell-ext.json"],
  "language": "en-GB",
}

CSpell Settings cspell.config.yaml

cspell.config.yaml

import:
  - '@cspell/dict-en-gb/cspell-ext.json'
language: en-GB

Local Installation using CDN

CDN Configuration

VSCode Settings

Add the following to your VSCode settings:

.vscode/settings.json

{
  "cSpell.import": ["https://cdn.jsdelivr.net/npm/@cspell/dict-en-gb/cspell-ext.json"],
  "cSpell.language": "en-GB",
}

CSpell Settings cspell.json

cspell.json

{
  "import": ["https://cdn.jsdelivr.net/npm/@cspell/dict-en-gb/cspell-ext.json"],
  "language": "en-GB",
}

CSpell Settings cspell.config.yaml

cspell.config.yaml

import:
  - https://cdn.jsdelivr.net/npm/@cspell/dict-en-gb/cspell-ext.json
language: en-GB

Dictionary Information

Name	Enabled	Description
en-gb		British English Dictionary

Language Settings

Name	Locale	File Type
en-gb	en-GB	*

Contributing

Please help correct any mistakes in the dictionaries.

See: Contributing

Special thanks to all of our amazing contributors!

Dictionary Development

See: How to Create a New Dictionary

Adding Words

Contributions are welcomed and encouraged, please read src/README.md.

License

The code used to build this dictionary is licensed under MIT license.

But because of the sources it includes, the @cspell/dict-en-gb package is released under:

LGPL-3.0-or-later

Some packages may have other licenses included.

Brought to you by Street Side Software