Logo for jsDocs.io

cspell

  • Version 9.1.1
  • Published
  • 262 kB
  • 18 dependencies
  • MIT license

Install

npm i cspell
yarn add cspell
pnpm add cspell

Overview

A Spelling Checker for Code!

Index

Functions

Interfaces

Functions

function configInit

configInit: (options: InitOptions) => Promise<void>;

    Interfaces

    interface InitOptions

    interface InitOptions extends BaseConfigOptions {}

      property format

      format?: 'yaml' | 'yml' | 'json' | 'jsonc';

      • The format of the configuration file. config - If config is provided, the format will be inferred from the file extension.

      property output

      output?: string;

      • The path where the configuration file will be written, it can be a file path or a URL. If not provided, a default file name will be used based on the format. The default will be cspell.config.yaml or cspell.json based on the format. config - If config is provided, it will be used instead of output.

      Package Files (3)

      Dependencies (18)

      Dev Dependencies (6)

      Peer Dependencies (0)

      No peer dependencies.

      Badge

      To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

      You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/cspell.

      • Markdown
        [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/cspell)
      • HTML
        <a href="https://www.jsdocs.io/package/cspell"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>