Skip to main content

Cspell Types

Contains cspell types and json-schema.

This package contains no dependencies to avoid any security issues.

Support Future Development​

If our spell checkers save you time, please consider supporting their development.

Please show your support through one of the following sites:

GitHub Sponsor   PayPal   Open Collective   CSpell

Installation​

npm i -S @cspell/cspell-types

Usage​

Can be used to make writing cspell.config.js files easier.

'use strict';

/** @type { import("@cspell/cspell-types").CSpellUserSettings } */
const cspell = {
  description: 'cspell.config.js file in samples/js-config',
  languageSettings: [
    {
      languageId: 'cpp',
      allowCompoundWords: false,
      patterns: [
        {
          name: 'pound-includes',
          pattern: /^\s*#include.*/g
        }
      ],
      ignoreRegExpList: ['pound-includes']
    }
  ],
  dictionaryDefinitions: [
    {
      name: 'custom-words',
      path: './custom-words.txt'
    }
  ],
  dictionaries: ['custom-words']
};

module.exports = cspell;

API​

CSpellSettings (aliased as CSpellUserSettings) is the formal definition of the configuration that controls the spell checker.

CSpell for Enterprise​

Available as part of the Tidelift Subscription.

The maintainers of cspell and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source packages you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact packages you use. Learn more.


Brought to you byStreet Side Software Logo Street Side Software