Logo for jsDocs.io

@commitlint/resolve-extends

  • Version 20.1.0
  • Published
  • 17.3 kB
  • 6 dependencies
  • MIT license

Install

npm i @commitlint/resolve-extends
yarn add @commitlint/resolve-extends
pnpm add @commitlint/resolve-extends

Overview

Lint your commit messages

Index

Functions

Interfaces

Functions

function loadParserPreset

loadParserPreset: (
    resolvedParserPreset: string
) => Promise<Pick<ParserPreset, 'path' | 'parserOpts'>>;

  • Parameter resolvedParserPreset

    path resolved by resolveFrom

    Returns

    path and parserOpts function retrieved from resolvedParserPreset

function resolveExtends

resolveExtends: (
    config?: UserConfig,
    context?: ResolveExtendsContext
) => Promise<UserConfig>;

    function resolveFrom

    resolveFrom: (lookup: string, parent?: string) => string;

    • See Also

      • moduleResolve

    function resolveFromSilent

    resolveFromSilent: (specifier: string, parent: string) => string | void;

      function resolveGlobalSilent

      resolveGlobalSilent: (specifier: string) => string | void;

      • See Also

        • https://github.com/sindresorhus/resolve-global/blob/682a6bb0bd8192b74a6294219bb4c536b3708b65/index.js#L7

      Interfaces

      interface ResolveExtendsContext

      interface ResolveExtendsContext {}

        property cwd

        cwd?: string;

          property parserPreset

          parserPreset?: string | ParserPreset;

            property prefix

            prefix?: string;

              property resolveGlobal

              resolveGlobal?: (id: string) => string;

                method dynamicImport

                dynamicImport: <T>(id: string) => T | Promise<T>;

                  method resolve

                  resolve: (id: string, ctx?: { prefix?: string; cwd?: string }) => string;

                    Package Files (1)

                    Dependencies (6)

                    Dev Dependencies (2)

                    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/@commitlint/resolve-extends.

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