cspell

  • Version 8.8.4
  • Published
  • 326 kB
  • 18 dependencies
  • MIT license

Install

npm i cspell
yarn add cspell
pnpm add cspell

Overview

A Spelling Checker for Code!

Index

Functions

function checkText

checkText: (
filename: string,
options: BaseOptions & LegacyOptions
) => Promise<CheckTextResult>;

    function createInit

    createInit: () => Promise<void>;

      function getDefaultReporter

      getDefaultReporter: (
      options: ReporterOptions,
      config?: ReporterConfiguration
      ) => CSpellReporter;

        function lint

        lint: (
        fileGlobs: string[],
        options: LinterCliOptions,
        reporter?: CSpellReporter
        ) => Promise<RunResult>;

          function parseApplicationFeatureFlags

          parseApplicationFeatureFlags: (flags: string[] | undefined) => FeatureFlags;

            function suggestions

            suggestions: (
            words: string[],
            options: SuggestionOptions
            ) => AsyncIterable<TimedSuggestionsForWordResult>;

              function trace

              trace: (
              words: string[],
              options: TraceOptions
              ) => AsyncIterableIterator<TraceWordResult>;

                Interfaces

                interface BaseOptions

                interface BaseOptions {}

                  property config

                  config?: string;
                  • Path to configuration file.

                  property defaultConfiguration

                  defaultConfiguration?: boolean;
                  • Load the default configuration true

                  property exitCode

                  exitCode?: boolean;
                  • Return an exit code if there are issues found. true

                  property flag

                  flag?: string[];
                  • Execution flags. Used primarily for releasing experimental features. Flags are of the form key:value

                  property languageId

                  languageId?: string;
                  • Programming Language ID.

                  property locale

                  locale?: string;
                  • Locale to use.

                  property validateDirectives

                  validateDirectives?: boolean;
                  • Check In-Document CSpell directives for correctness.

                  interface CSpellApplicationOptions

                  interface LinterCliOptions extends LinterOptions {}

                    property issues

                    issues?: boolean;
                    • Show issues

                    property issuesSummaryReport

                    issuesSummaryReport?: boolean;
                    • Generate a summary report of issues.

                    property legacy

                    legacy?: boolean;
                    • Show legacy output

                    property mustFindFiles

                    mustFindFiles?: boolean;
                    • Files must be found or cli will exit with an error.

                    property progress

                    progress?: boolean;
                    • Show progress

                    property relative

                    relative?: boolean;
                    • issues are shown with a relative path to the root or cwd

                    property showPerfSummary

                    showPerfSummary?: boolean;
                    • Generate a summary report of performance.

                    property silent

                    silent?: boolean;
                    • Run in silent mode. false

                    property summary

                    summary?: boolean;
                    • Show summary at the end

                    interface TraceOptions

                    interface TraceOptions extends BaseOptions {}

                      property all

                      all?: boolean;

                        property allowCompoundWords

                        allowCompoundWords?: boolean;

                          property dictionaryPath

                          dictionaryPath?: 'hide' | 'long' | 'short' | 'full';

                            property ignoreCase

                            ignoreCase?: boolean;

                              property onlyFound

                              onlyFound?: boolean;

                                property stdin

                                stdin?: boolean;

                                  Type Aliases

                                  type AppError

                                  type AppError = NodeJS.ErrnoException;

                                    type CheckTextResult

                                    type CheckTextResult = CheckTextInfo;

                                      Package Files (4)

                                      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>