@dovenv/lint - API documentation

Classes

CommitLint

Extends

• LintSuper<CommitlintConfig>

Constructors

new CommitLint()

new CommitLint(opts: undefined | CommitlintConfig, utils: CommandSuper): CommitLint

Parameters

Parameter	Type
opts	undefined | CommitlintConfig
utils	CommandSuper

Returns

CommitLint

Inherited from

LintSuper<CommitlintConfig>.constructor

Methods

run()

run(userMsg?: string): Promise<undefined | void>

Parameters

Parameter	Type
userMsg?	string

Returns

Promise<undefined | void>

Properties

Property	Modifier	Type	Inherited from
opts	public	undefined | CommitlintConfig	LintSuper.opts
utils	public	CommandSuper	LintSuper.utils

---

Eslint

Extends

• LintSuper<EslintConfig>

Constructors

new Eslint()

new Eslint(opts: undefined | EslintConfig, utils: CommandSuper): Eslint

Parameters

Parameter	Type
opts	undefined | EslintConfig
utils	CommandSuper

Returns

Eslint

Inherited from

LintSuper<EslintConfig>.constructor

Methods

run()

run(flags?: string[]): Promise<undefined | void>

Parameters

Parameter	Type
flags?	string[]

Returns

Promise<undefined | void>

Properties

Property	Modifier	Type	Inherited from
opts	public	undefined | EslintConfig	LintSuper.opts
utils	public	CommandSuper	LintSuper.utils

---

Lint

Lint class with all lint functions.

Extends

• LintSuper<Config>

Constructors

new Lint()

new Lint(opts: undefined | Config, utils: CommandSuper): Lint

Parameters

Parameter	Type
opts	undefined | Config
utils	CommandSuper

Returns

Lint

Inherited from

LintSuper<Config>.constructor

Methods

commitlint()

commitlint(userMsg?: string): Promise<void>

Parameters

Parameter	Type
userMsg?	string

Returns

Promise<void>

custom()

custom(pattern?: string[]): Promise<void>

Parameters

Parameter	Type
pattern?	string[]

Returns

Promise<void>

eslint()

eslint(flags: string[]): Promise<undefined | void>

Parameters

Parameter	Type
flags	string[]

Returns

Promise<undefined | void>

publint()

publint(keys?: string[]): Promise<void>

Parameters

Parameter	Type
keys?	string[]

Returns

Promise<void>

staged()

staged(): Promise<void>

Returns

Promise<void>

stylelint()

stylelint(files?: string[], fix?: boolean): Promise<void>

Parameters

Parameter	Type
files?	string[]
fix?	boolean

Returns

Promise<void>

Properties

Property	Modifier	Type	Inherited from
opts	public	undefined | Config	LintSuper.opts
utils	public	CommandSuper	LintSuper.utils

---

PubLint

Extends

• LintSuper<PubLintConfig>

Constructors

new PubLint()

new PubLint(opts: undefined | PubLintConfig, utils: CommandSuper): PubLint

Parameters

Parameter	Type
opts	undefined | PubLintConfig
utils	CommandSuper

Returns

PubLint

Inherited from

LintSuper<PubLintConfig>.constructor

Methods

run()

run(keys?: string[]): Promise<void>

Parameters

Parameter	Type
keys?	string[]

Returns

Promise<void>

runOne()

runOne(opts?: PubLintOpts): Promise<void>

Parameters

Parameter	Type
opts?	PubLintOpts

Returns

Promise<void>

Properties

Property	Modifier	Type	Inherited from
opts	public	undefined | PubLintConfig	LintSuper.opts
utils	public	CommandSuper	LintSuper.utils

---

StagedLint

Extends

• LintSuper<LintStagedConfig>

Constructors

new StagedLint()

new StagedLint(opts: undefined | LintStagedConfig, utils: CommandSuper): StagedLint

Parameters

Parameter	Type
opts	undefined | LintStagedConfig
utils	CommandSuper

Returns

StagedLint

Inherited from

LintSuper<LintStagedConfig>.constructor

Methods

run()

run(): Promise<undefined | void>

Returns

Promise<undefined | void>

Properties

Property	Modifier	Type	Inherited from
opts	public	undefined | LintStagedConfig	LintSuper.opts
utils	public	CommandSuper	LintSuper.utils

---

StyleLint

Extends

• LintSuper<StylelintConfig>

Constructors

new StyleLint()

new StyleLint(opts: undefined | LinterOptions, utils: CommandSuper): StyleLint

Parameters

Parameter	Type
opts	undefined | LinterOptions
utils	CommandSuper

Returns

StyleLint

Inherited from

LintSuper<StylelintConfig>.constructor

Methods

run()

run(files?: string[], fix?: boolean): Promise<undefined | void>

Parameters

Parameter	Type
files?	string[]
fix?	boolean

Returns

Promise<undefined | void>

Properties

Property	Modifier	Type	Inherited from
opts	public	undefined | LinterOptions	LintSuper.opts
utils	public	CommandSuper	LintSuper.utils

Functions

lintPlugin()

function lintPlugin(conf?: Config): Config

Configures and returns a DovenvConfig object for linting tools.

Parameters

Parameter	Type	Description
conf?	Config	Optional configuration object for linting.

Returns

Config

A configuration object with custom lint commands and descriptions.

                           Provides linting commands for different file types and commit messages:
                           - `staged`: Lints staged git files.
                           - `stylelint`: Lints CSS/SCSS/LESS/SASS/PostCSS files with options to fix errors and specify files.
                           - `eslint`: Lints JS/TS/MD/JSON/YAML files.
                           - `commitlint`: Lints commit messages, either the last commit message or a specified message.

                           Examples include linting CSS files, JS files, commit messages, and staged files.

Type Aliases

Config

type Config: {
  commitlint: CommitlintConfig;
  custom: { [key in string]: Function };
  eslint: EslintConfig;
  publint: PubLintConfig;
  staged: LintStagedConfig;
  stylelint: StylelintConfig;
};

Type declaration

Name	Type	Description
commitlint?	CommitlintConfig	Config for lint commit messages
custom?	{ [key in string]: Function }	Custom lint
eslint?	EslintConfig	Config for lint JS/TS/MD/JSON/YAML.. Files
publint?	PubLintConfig	Config for publint
staged?	LintStagedConfig	Config for lint staged GIT files
stylelint?	StylelintConfig	Config for lint CSS/SCSS/LESS/SASS/PostCSS files

References

default

Renames and re-exports lintPlugin