Logo for jsDocs.io

prettier-eslint

  • Version 17.1.1
  • Published
  • 76.4 kB
  • 10 dependencies
  • MIT license

Install

npm i prettier-eslint
yarn add prettier-eslint
pnpm add prettier-eslint

Overview

Formats your JavaScript using prettier followed by eslint --fix

Index

Variables

Functions

Interfaces

Type Aliases

Variables

variable DEFAULT_ESLINT_EXTENSIONS

const DEFAULT_ESLINT_EXTENSIONS: string[];

    variable DEFAULT_ESLINT_FILES

    const DEFAULT_ESLINT_FILES: string[];

      Functions

      function analyze

      analyze: (
          options: FormatOptions
      ) => Promise<{ output: string; messages: Linter.LintMessage[] }>;

        function format

        format: (options: FormatOptions) => Promise<string>;

          Interfaces

          interface ESLintConfig

          interface ESLintConfig extends Linter.Config, ESLintOptions {}

            interface FormatOptions

            interface FormatOptions {}

              property eslintConfig

              eslintConfig?: ESLintConfig;

                property eslintPath

                eslintPath?: string;

                  property fallbackPrettierOptions

                  fallbackPrettierOptions?: PrettierOptions;

                    property filePath

                    filePath?: string;

                      property logLevel

                      logLevel?: LogLevel;

                        property prettierLast

                        prettierLast?: boolean;

                          property prettierOptions

                          prettierOptions?: PrettierOptions;

                            property prettierPath

                            prettierPath?: string;

                              property text

                              text?: string;

                                interface OptionGetter

                                interface OptionGetter {}

                                  property ruleValue

                                  ruleValue: (
                                      rules?: Partial<Linter.RulesRecord>
                                  ) => StringLiteral<Linter.RuleEntry> | undefined;

                                    property ruleValueToPrettierOption

                                    ruleValueToPrettierOption: (...args: any[]) => unknown;

                                      interface PrettifyInput

                                      interface PrettifyInput {}

                                        property messages

                                        messages: Linter.LintMessage[];

                                          property output

                                          output: string;

                                            Type Aliases

                                            type ESLintConfigLanguageOptions

                                            type ESLintConfigLanguageOptions = NonNullable<Linter.Config['languageOptions']>;

                                              type ESLintOptions

                                              type ESLintOptions = Omit<
                                                  ESLint.Options,
                                                  'plugins' | 'reportUnusedDisableDirectives'
                                              >;

                                                type StringLiteral

                                                type StringLiteral<T> =
                                                    | T
                                                    | (string & {
                                                          _?: never;
                                                      });

                                                  type ValueOf

                                                  type ValueOf<T> = T[keyof T];

                                                    Package Files (2)

                                                    Dependencies (10)

                                                    Dev Dependencies (0)

                                                    No dev dependencies.

                                                    Peer Dependencies (2)

                                                    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/prettier-eslint.

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