@dovenv/eslint-config - API documentation

Functions

includeGitIgnore()

function includeGitIgnore(gitIgnorePath?: string): Config

Include the contents of a .gitignore file in ESLint's ignore configuration.

Parameters

Parameter	Type	Description
gitIgnorePath?	string	The path to the .gitignore file. If not provided, the .gitignore file in the current working directory will be used.

Returns

Config

An object that ESLint can use to ignore files.

---

setIgnoreConfig()

function setIgnoreConfig(paths: string[]): Config

Set paths to ignore in ESLint.

Parameters

Parameter	Type	Description
paths	string[]	An array of paths to ignore.

Returns

Config

• An object with a single property, ignores, that is an array of paths to ignore.

Example

const config = setIgnoreConfig( [
	'./static/*',
	'./public/*',
])

---

setTsConfig()

function setTsConfig(tsconfigRootDir: string): Config

Parameters

Parameter	Type
tsconfigRootDir	string

Returns

Config

References

default

Renames and re-exports config

Variables

config

const config: Config[];

---

cssConfig

const cssConfig: Config[];

YAML Eslint config

See

https://github.com/aminya/eslint-plugin-yaml#readme

---

generalConfig

const generalConfig: Config[];

---

htmlConfig

const htmlConfig: Config[];

HTML Eslint config

See

https://www.npmjs.com/package/eslint-plugin-html

---

jsConfig

const jsConfig: Config[];

---

jsonConfig

const jsonConfig: Config[];

---

mdConfig

const mdConfig: Config[];

MARKDOWN eslint config

See

https://gitlab.com/pawelbbdrozd/eslint-plugin-markdownlint

---

schemaConfig

const schemaConfig: Config[];

---

tomlConfig

const tomlConfig: Config[];

---

tsConfig

const tsConfig: Config[];

---

vueConfig

const vueConfig: Config[];

---

yamlConfig

const yamlConfig: Config[];