Niche Portobello Mushroom

    @cspell/cspell-types
    TypeScript icon, indicating that this package has built-in type declarations

    6.15.0 • Public • Published

    Cspell Types

    Contains cspell types and json-schema.

    This package contains no dependencies to avoid any security issues.

    Support Future Development

    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.

    Installation

    npm i -SD @cspell/cspell-types
    

    Usage

    Can be use 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 alias CSpellUserSettings is the formal definition of the configuration that controls the spell checker.

    Keywords

    Install

    npm i @cspell/cspell-types

    DownloadsWeekly Downloads

    166,690

    Version

    6.15.0

    License

    MIT

    Unpacked Size

    125 kB

    Total Files

    29

    Last publish

    Collaborators

    • jason-dent