Discover modules > cue.dev/x/npmpackage
v0.3.0
#Schema: ¶

JSON schema for NPM package.json files

#dependency: [string]: string ¶

Dependencies are specified with a simple hash of package name to version range. The version range is a string which has one or more space-separated descriptors. Dependencies can also be identified with a tarball or git URL.

#devDependency: [string]: string ¶

Specifies dependencies that are required for the development and testing of the project. These dependencies are not needed in the production environment.

#devEngineDependency: ¶

Specifies requirements for development environment components such as operating systems, runtimes, or package managers. Used to ensure consistent development environments across the team.

name!: string ¶

The name of the dependency, with allowed values depending on the parent field

version?: string ¶

The version range for the dependency

onFail?: "ignore" | "warn" | "error" | "download" ¶

What action to take if validation fails

#fundingUrl: net.AbsURL ¶

URL to a website with details about how to fund the package.

#fundingWay: ¶

Used to inform about ways to help fund development of the package.

url!: #fundingUrl ¶
type?: string ¶

The type of funding or the platform through which funding can be provided, e.g. patreon, opencollective, tidelift or github.

#license:
click to see definition
matchN(>=1, [string, "AGPL-3.0-only" | "Apache-2.0" | "BSD-2-Clause" | "BSD-3-Clause" | "BSL-1.0" | "CC0-1.0" | "CDDL-1.0" | "CDDL-1.1" | "EPL-1.0" | "EPL-2.0" | "GPL-2.0-only" | "GPL-3.0-only" | "ISC" | "LGPL-2.0-only" | "LGPL-2.1-only" | "LGPL-2.1-or-later" | "LGPL-3.0-only" | "LGPL-3.0-or-later" | "MIT" | "MPL-2.0" | "MS-PL" | "UNLICENSED"])
¶
#optionalDependency: [string]: string ¶

Specifies dependencies that are optional for your project. These dependencies are attempted to be installed during the npm install process, but if they fail to install, the installation process will not fail.

#packageExportsEntry: matchN(1, [#packageExportsEntryPath, #packageExportsEntryObject]) ¶
#packageExportsEntryObject: ¶

Used to specify conditional exports, note that Conditional exports are unsupported in older environments, so it's recommended to use the fallback array option if support for those environments is a concern.

require?: #packageExportsEntryOrFallback ¶
import?: #packageExportsEntryOrFallback ¶
"module-sync"?: #packageExportsEntryOrFallback ¶
node?: #packageExportsEntryOrFallback ¶
default?: #packageExportsEntryOrFallback ¶
types?: #packageExportsEntryOrFallback ¶
#packageExportsEntryOrFallback: matchN(1, [#packageExportsEntry, #packageExportsFallback]) ¶
#packageExportsEntryPath: null | =~"^\\./" ¶

The module path that is resolved when this specifier is imported. Set to `null` to disallow importing this module.

#packageExportsFallback: [...#packageExportsEntry] ¶

Used to allow fallbacks in case this environment doesn't support the preceding entries.

#packageImportsEntry: matchN(1, [#packageImportsEntryPath, #packageImportsEntryObject]) ¶
#packageImportsEntryObject: ¶

Used to specify conditional exports, note that Conditional exports are unsupported in older environments, so it's recommended to use the fallback array option if support for those environments is a concern.

require?: #packageImportsEntryOrFallback ¶
import?: #packageImportsEntryOrFallback ¶
node?: #packageImportsEntryOrFallback ¶
default?: #packageImportsEntryOrFallback ¶
types?: #packageImportsEntryOrFallback ¶
#packageImportsEntryOrFallback: matchN(1, [#packageImportsEntry, #packageImportsFallback]) ¶
#packageImportsEntryPath: null | string ¶

The module path that is resolved when this specifier is imported. Set to `null` to disallow importing this module.

#packageImportsFallback: [...#packageImportsEntry] ¶

Used to allow fallbacks in case this environment doesn't support the preceding entries.

#peerDependency: [string]: string ¶

Specifies dependencies that are required by the package but are expected to be provided by the consumer of the package.

#peerDependencyMeta:
click to see definition
{
	[string]: {
		optional?: bool
		...
	}
}
¶

When a user installs your package, warnings are emitted if packages specified in "peerDependencies" are not already installed. The "peerDependenciesMeta" field serves to provide more information on how your peer dependencies are utilized. Most commonly, it allows peer dependencies to be marked as optional. Metadata for this field is specified with a simple hash of the package name to a metadata object.

#person:
click to see definition
string | {
	name!:  string
	url?:   net.AbsURL
	email?: string
	...
}
¶

A person who has been involved in creating or maintaining this package.

#scriptsInstallAfter: string ¶

Run AFTER the package is installed.

#scriptsPublishAfter: string ¶

Run AFTER the package is published.

#scriptsRestart: string ¶

Run by the 'npm restart' command. Note: 'npm restart' will run the stop and start scripts if no restart script is provided.

#scriptsStart: string ¶

Run by the 'npm start' command.

#scriptsStop: string ¶

Run by the 'npm stop' command.

#scriptsTest: string ¶

Run by the 'npm test' command.

#scriptsUninstallBefore: string ¶

Run BEFORE the package is uninstalled.

#scriptsVersionBefore: string ¶

Run BEFORE bump the package version.

name?:
click to see definition
strings.MaxRunes(214) & strings.MinRunes(1) & {
	=~"^(?:(?:@(?:[a-z0-9-*~][a-z0-9-*._~]*)?/[a-z0-9-._~])|[a-z0-9-~])[a-z0-9-._~]*$"
}
¶

The name of the package.

version?: string ¶

Version must be parsable by node-semver, which is bundled with npm as a dependency.

description?: string ¶

This helps people discover your package, as it's listed in 'npm search'.

keywords?: [...string] ¶

This helps people discover your package as it's listed in 'npm search'.

homepage?: string ¶

The url to the project homepage.

bugs?:
click to see definition
string | {
	url?:   net.AbsURL
	email?: string
	...
}
¶

The url to your project's issue tracker and / or the email address to which issues should be reported. These are helpful for people who encounter issues with your package.

license?: #license ¶
licenses?:
click to see definition
[...{
	type?: #license
	url?:  net.AbsURL
	...
}]
¶

DEPRECATED: Instead, use SPDX expressions, like this: { "license": "ISC" } or { "license": "(MIT OR Apache-2.0)" } see: 'https://docs.npmjs.com/files/package.json#license'.

author?: #person ¶
contributors?: [...#person] ¶

A list of people who contributed to this package.

maintainers?: [...#person] ¶

A list of people who maintains this package.

files?: [...string] ¶

The 'files' field is an array of files to include in your project. If you name a folder in the array, then it will also include the files inside that folder.

main?: string ¶

The main field is a module ID that is the primary entry point to your program.

exports?:
click to see definition
matchN(1, [#packageExportsEntryPath, close({
	{
		[=~"^\\./.+" & !~"^(\\.)$"]: #packageExportsEntryOrFallback
	}
	"."?: #packageExportsEntryOrFallback
}), #packageExportsEntryObject, #packageExportsFallback])
¶

The "exports" field is used to restrict external access to non-exported module files, also enables a module to import itself using "name".

imports?: close({ [=~"^#.+$"]: #packageImportsEntryOrFallback }) ¶

The "imports" field is used to create private mappings that only apply to import specifiers from within the package itself.

bin?: string | { [string]: string } ¶
type?: "commonjs" | "module" ¶

When set to "module", the type field allows a package to specify all .js files within are ES modules. If the "type" field is omitted or set to "commonjs", all .js files are treated as CommonJS.

types?: string ¶

Set the types property to point to your bundled declaration file.

typings?: string ¶

Note that the "typings" field is synonymous with "types", and could be used as well.

typesVersions?:
click to see definition
{
	[string]: close({
		{
			[=~"^[^*]+$" & !~"^(\\*)$"]: [...string]
		}
		{
			[=~"^[^*]*\\*[^*]*$" & !~"^(\\*)$"]: [...=~"^[^*]*(?:\\*[^*]*)?$"]
		}
		"*"?: [...=~"^[^*]*(?:\\*[^*]*)?$"]
	})
}
¶

The "typesVersions" field is used since TypeScript 3.1 to support features that were only made available in newer TypeScript versions.

man?: string | [...string] ¶

Specify either a single file or an array of filenames to put in place for the man program to find.

directories?: ¶
bin?: string ¶

If you specify a 'bin' directory, then all the files in that folder will be used as the 'bin' hash.

doc?: string ¶

Put markdown files in here. Eventually, these will be displayed nicely, maybe, someday.

example?: string ¶

Put example scripts in here. Someday, it might be exposed in some clever way.

lib?: string ¶

Tell people where the bulk of your library is. Nothing special is done with the lib folder in any way, but it's useful meta info.

man?: string ¶

A folder that is full of man pages. Sugar to generate a 'man' array by walking the folder.

test?: string ¶
repository?:
click to see definition
string | {
	type?:      string
	url?:       string
	directory?: string
	...
}
¶

Specify the place where your code lives. This is helpful for people who want to contribute.

funding?: matchN(1, [#fundingUrl, #fundingWay, list.UniqueItems() & [...matchN(1, [#fundingUrl, #fundingWay])] & [_, ...]]) ¶
scripts?: ¶

The 'scripts' member is an object hash of script commands that are run at various times in the lifecycle of your package. The key is the lifecycle event, and the value is the command to run at that point.

lint?: string ¶

Run code quality tools, e.g. ESLint, TSLint, etc.

prepublish?: string ¶

Run BEFORE the package is published (Also run on local npm install without any arguments).

prepare?: string ¶

Runs BEFORE the package is packed, i.e. during "npm publish" and "npm pack", and on local "npm install" without any arguments. This is run AFTER "prepublish", but BEFORE "prepublishOnly".

prepublishOnly?: string ¶

Run BEFORE the package is prepared and packed, ONLY on npm publish.

prepack?: string ¶

run BEFORE a tarball is packed (on npm pack, npm publish, and when installing git dependencies).

postpack?: string ¶

Run AFTER the tarball has been generated and moved to its final destination.

publish?: string ¶

Publishes a package to the registry so that it can be installed by name. See https://docs.npmjs.com/cli/v8/commands/npm-publish

postpublish?: #scriptsPublishAfter ¶
preinstall?: string ¶

Run BEFORE the package is installed.

install?: #scriptsInstallAfter ¶
postinstall?: #scriptsInstallAfter ¶
preuninstall?: #scriptsUninstallBefore ¶
uninstall?: #scriptsUninstallBefore ¶
postuninstall?: string ¶

Run AFTER the package is uninstalled.

preversion?: #scriptsVersionBefore ¶
version?: #scriptsVersionBefore ¶
postversion?: string ¶

Run AFTER bump the package version.

pretest?: #scriptsTest ¶
test?: #scriptsTest ¶
posttest?: #scriptsTest ¶
prestop?: #scriptsStop ¶
stop?: #scriptsStop ¶
poststop?: #scriptsStop ¶
prestart?: #scriptsStart ¶
start?: #scriptsStart ¶
poststart?: #scriptsStart ¶
prerestart?: #scriptsRestart ¶
restart?: #scriptsRestart ¶
postrestart?: #scriptsRestart ¶
serve?: string ¶

Start dev server to serve application files

config?: ... ¶

A 'config' hash can be used to set configuration parameters used in package scripts that persist across upgrades.

dependencies?: #dependency ¶
devDependencies?: #devDependency ¶
optionalDependencies?: #optionalDependency ¶
peerDependencies?: #peerDependency ¶
peerDependenciesMeta?: #peerDependencyMeta ¶
bundleDependencies?: matchN(1, [[...string], bool]) ¶

Array of package names that will be bundled when publishing the package.

bundledDependencies?: matchN(1, [[...string], bool]) ¶

DEPRECATED: This field is honored, but "bundleDependencies" is the correct field name.

resolutions?: ... ¶

Resolutions is used to support selective version resolutions using yarn, which lets you define custom package versions or ranges inside your dependencies. For npm, use overrides instead. See: https://yarnpkg.com/configuration/manifest#resolutions

overrides?: ... ¶

Overrides is used to support selective version overrides using npm, which lets you define custom package versions or ranges inside your dependencies. For yarn, use resolutions instead. See: https://docs.npmjs.com/cli/v9/configuring-npm/package-json#overrides

packageManager?: =~"(npm|pnpm|yarn|bun)@\\d+\\.\\d+\\.\\d+(-.+)?" ¶

Defines which package manager is expected to be used when working on the current project. This field is currently experimental and needs to be opted-in; see https://nodejs.org/api/corepack.html

engines?: ¶
node?: string ¶
volta?: ¶

Defines which tools and versions are expected to be used when Volta is installed.

extends?: string ¶

The value of that entry should be a path to another JSON file which also has a "volta" section

engineStrict?: bool ¶
os?: [...string] ¶

Specify which operating systems your module will run on.

cpu?: [...string] ¶

Specify that your code only runs on certain cpu architectures.

devEngines?: ¶

Define the runtime and package manager for developing the current project.

os?: matchN(1, [#devEngineDependency, [...#devEngineDependency]]) ¶

Specifies which operating systems are supported for development

cpu?: matchN(1, [#devEngineDependency, [...#devEngineDependency]]) ¶

Specifies which CPU architectures are supported for development

libc?: matchN(1, [#devEngineDependency, [...#devEngineDependency]]) ¶

Specifies which C standard libraries are supported for development

runtime?: matchN(1, [#devEngineDependency, [...#devEngineDependency]]) ¶

Specifies which JavaScript runtimes (like Node.js, Deno, Bun) are supported for development. Values should use WinterCG Runtime Keys (see https://runtime-keys.proposal.wintercg.org/)

packageManager?: matchN(1, [#devEngineDependency, [...#devEngineDependency]]) ¶

Specifies which package managers are supported for development

preferGlobal?: bool ¶

DEPRECATED: This option used to trigger an npm warning, but it will no longer warn. It is purely there for informational purposes. It is now recommended that you install any binaries as local devDependencies wherever possible.

private?: matchN(1, [bool, "false" | "true"]) ¶

If set to true, then npm will refuse to publish it.

publishConfig?: ¶
access?: "public" | "restricted" ¶
tag?: string ¶
registry?: net.AbsURL ¶
provenance?: bool ¶
dist?: ¶
shasum?: string ¶
tarball?: string ¶
readme?: string ¶
module?: string ¶

An ECMAScript module ID that is the primary entry point to your program.

esnext?:
click to see definition
string | {
	{
		[!~"^(main|browser)$"]: string
	}
	main?:    string
	browser?: string
}
¶

A module ID with untranspiled code that is the primary entry point to your program.

workspaces?:
click to see definition
matchN(>=1, [[...string], {
	packages?: [...string]
	nohoist?: [...string]
	...
}])
¶

Allows packages within a directory to depend on one another using direct linking of local files. Additionally, dependencies within a workspace are hoisted to the workspace root when possible to reduce duplication. Note: It's also a good idea to set "private" to true when using this feature.

jspm?: ¶
name?:
click to see definition
strings.MaxRunes(214) & strings.MinRunes(1) & {
	=~"^(?:(?:@(?:[a-z0-9-*~][a-z0-9-*._~]*)?/[a-z0-9-._~])|[a-z0-9-~])[a-z0-9-._~]*$"
}
¶

The name of the package.

version?: string ¶

Version must be parsable by node-semver, which is bundled with npm as a dependency.

description?: string ¶

This helps people discover your package, as it's listed in 'npm search'.

keywords?: [...string] ¶

This helps people discover your package as it's listed in 'npm search'.

homepage?: string ¶

The url to the project homepage.

bugs?:
click to see definition
string | {
	url?:   net.AbsURL
	email?: string
	...
}
¶

The url to your project's issue tracker and / or the email address to which issues should be reported. These are helpful for people who encounter issues with your package.

license?: #license ¶
licenses?:
click to see definition
[...{
	type?: #license
	url?:  net.AbsURL
	...
}]
¶

DEPRECATED: Instead, use SPDX expressions, like this: { "license": "ISC" } or { "license": "(MIT OR Apache-2.0)" } see: 'https://docs.npmjs.com/files/package.json#license'.

author?: #person ¶
contributors?: [...#person] ¶

A list of people who contributed to this package.

maintainers?: [...#person] ¶

A list of people who maintains this package.

files?: [...string] ¶

The 'files' field is an array of files to include in your project. If you name a folder in the array, then it will also include the files inside that folder.

main?: string ¶

The main field is a module ID that is the primary entry point to your program.

exports?:
click to see definition
matchN(1, [#packageExportsEntryPath, close({
	{
		[=~"^\\./.+" & !~"^(\\.)$"]: #packageExportsEntryOrFallback
	}
	"."?: #packageExportsEntryOrFallback
}), #packageExportsEntryObject, #packageExportsFallback])
¶

The "exports" field is used to restrict external access to non-exported module files, also enables a module to import itself using "name".

imports?: close({ [=~"^#.+$"]: #packageImportsEntryOrFallback }) ¶

The "imports" field is used to create private mappings that only apply to import specifiers from within the package itself.

bin?: string | { [string]: string } ¶
type?: "commonjs" | "module" ¶

When set to "module", the type field allows a package to specify all .js files within are ES modules. If the "type" field is omitted or set to "commonjs", all .js files are treated as CommonJS.

types?: string ¶

Set the types property to point to your bundled declaration file.

typings?: string ¶

Note that the "typings" field is synonymous with "types", and could be used as well.

typesVersions?:
click to see definition
{
	[string]: close({
		{
			[=~"^[^*]+$" & !~"^(\\*)$"]: [...string]
		}
		{
			[=~"^[^*]*\\*[^*]*$" & !~"^(\\*)$"]: [...=~"^[^*]*(?:\\*[^*]*)?$"]
		}
		"*"?: [...=~"^[^*]*(?:\\*[^*]*)?$"]
	})
}
¶

The "typesVersions" field is used since TypeScript 3.1 to support features that were only made available in newer TypeScript versions.

man?: string | [...string] ¶

Specify either a single file or an array of filenames to put in place for the man program to find.

directories?: ¶
bin?: string ¶

If you specify a 'bin' directory, then all the files in that folder will be used as the 'bin' hash.

doc?: string ¶

Put markdown files in here. Eventually, these will be displayed nicely, maybe, someday.

example?: string ¶

Put example scripts in here. Someday, it might be exposed in some clever way.

lib?: string ¶

Tell people where the bulk of your library is. Nothing special is done with the lib folder in any way, but it's useful meta info.

man?: string ¶

A folder that is full of man pages. Sugar to generate a 'man' array by walking the folder.

test?: string ¶
repository?:
click to see definition
string | {
	type?:      string
	url?:       string
	directory?: string
	...
}
¶

Specify the place where your code lives. This is helpful for people who want to contribute.

funding?: matchN(1, [#fundingUrl, #fundingWay, list.UniqueItems() & [...matchN(1, [#fundingUrl, #fundingWay])] & [_, ...]]) ¶
scripts?: ¶

The 'scripts' member is an object hash of script commands that are run at various times in the lifecycle of your package. The key is the lifecycle event, and the value is the command to run at that point.

lint?: string ¶

Run code quality tools, e.g. ESLint, TSLint, etc.

prepublish?: string ¶

Run BEFORE the package is published (Also run on local npm install without any arguments).

prepare?: string ¶

Runs BEFORE the package is packed, i.e. during "npm publish" and "npm pack", and on local "npm install" without any arguments. This is run AFTER "prepublish", but BEFORE "prepublishOnly".

prepublishOnly?: string ¶

Run BEFORE the package is prepared and packed, ONLY on npm publish.

prepack?: string ¶

run BEFORE a tarball is packed (on npm pack, npm publish, and when installing git dependencies).

postpack?: string ¶

Run AFTER the tarball has been generated and moved to its final destination.

publish?: string ¶

Publishes a package to the registry so that it can be installed by name. See https://docs.npmjs.com/cli/v8/commands/npm-publish

postpublish?: #scriptsPublishAfter ¶
preinstall?: string ¶

Run BEFORE the package is installed.

install?: #scriptsInstallAfter ¶
postinstall?: #scriptsInstallAfter ¶
preuninstall?: #scriptsUninstallBefore ¶
uninstall?: #scriptsUninstallBefore ¶
postuninstall?: string ¶

Run AFTER the package is uninstalled.

preversion?: #scriptsVersionBefore ¶
version?: #scriptsVersionBefore ¶
postversion?: string ¶

Run AFTER bump the package version.

pretest?: #scriptsTest ¶
test?: #scriptsTest ¶
posttest?: #scriptsTest ¶
prestop?: #scriptsStop ¶
stop?: #scriptsStop ¶
poststop?: #scriptsStop ¶
prestart?: #scriptsStart ¶
start?: #scriptsStart ¶
poststart?: #scriptsStart ¶
prerestart?: #scriptsRestart ¶
restart?: #scriptsRestart ¶
postrestart?: #scriptsRestart ¶
serve?: string ¶

Start dev server to serve application files

config?: ... ¶

A 'config' hash can be used to set configuration parameters used in package scripts that persist across upgrades.

dependencies?: #dependency ¶
devDependencies?: #devDependency ¶
optionalDependencies?: #optionalDependency ¶
peerDependencies?: #peerDependency ¶
peerDependenciesMeta?: #peerDependencyMeta ¶
bundleDependencies?: matchN(1, [[...string], bool]) ¶

Array of package names that will be bundled when publishing the package.

bundledDependencies?: matchN(1, [[...string], bool]) ¶

DEPRECATED: This field is honored, but "bundleDependencies" is the correct field name.

resolutions?: ... ¶

Resolutions is used to support selective version resolutions using yarn, which lets you define custom package versions or ranges inside your dependencies. For npm, use overrides instead. See: https://yarnpkg.com/configuration/manifest#resolutions

overrides?: ... ¶

Overrides is used to support selective version overrides using npm, which lets you define custom package versions or ranges inside your dependencies. For yarn, use resolutions instead. See: https://docs.npmjs.com/cli/v9/configuring-npm/package-json#overrides

packageManager?: =~"(npm|pnpm|yarn|bun)@\\d+\\.\\d+\\.\\d+(-.+)?" ¶

Defines which package manager is expected to be used when working on the current project. This field is currently experimental and needs to be opted-in; see https://nodejs.org/api/corepack.html

engines?: ¶
node?: string ¶
volta?: ¶

Defines which tools and versions are expected to be used when Volta is installed.

extends?: string ¶

The value of that entry should be a path to another JSON file which also has a "volta" section

engineStrict?: bool ¶
os?: [...string] ¶

Specify which operating systems your module will run on.

cpu?: [...string] ¶

Specify that your code only runs on certain cpu architectures.

devEngines?: ¶

Define the runtime and package manager for developing the current project.

os?: matchN(1, [#devEngineDependency, [...#devEngineDependency]]) ¶

Specifies which operating systems are supported for development

cpu?: matchN(1, [#devEngineDependency, [...#devEngineDependency]]) ¶

Specifies which CPU architectures are supported for development

libc?: matchN(1, [#devEngineDependency, [...#devEngineDependency]]) ¶

Specifies which C standard libraries are supported for development

runtime?: matchN(1, [#devEngineDependency, [...#devEngineDependency]]) ¶

Specifies which JavaScript runtimes (like Node.js, Deno, Bun) are supported for development. Values should use WinterCG Runtime Keys (see https://runtime-keys.proposal.wintercg.org/)

packageManager?: matchN(1, [#devEngineDependency, [...#devEngineDependency]]) ¶

Specifies which package managers are supported for development

preferGlobal?: bool ¶

DEPRECATED: This option used to trigger an npm warning, but it will no longer warn. It is purely there for informational purposes. It is now recommended that you install any binaries as local devDependencies wherever possible.

private?: matchN(1, [bool, "false" | "true"]) ¶

If set to true, then npm will refuse to publish it.

publishConfig?: ¶
access?: "public" | "restricted" ¶
tag?: string ¶
registry?: net.AbsURL ¶
provenance?: bool ¶
dist?: ¶
shasum?: string ¶
tarball?: string ¶
readme?: string ¶
module?: string ¶

An ECMAScript module ID that is the primary entry point to your program.

esnext?:
click to see definition
string | {
	{
		[!~"^(main|browser)$"]: string
	}
	main?:    string
	browser?: string
}
¶

A module ID with untranspiled code that is the primary entry point to your program.

workspaces?:
click to see definition
matchN(>=1, [[...string], {
	packages?: [...string]
	nohoist?: [...string]
	...
}])
¶

Allows packages within a directory to depend on one another using direct linking of local files. Additionally, dependencies within a workspace are hoisted to the workspace root when possible to reduce duplication. Note: It's also a good idea to set "private" to true when using this feature.

jspm?: _schema ¶
eslintConfig?: ¶
ecmaFeatures?: ¶

By default, ESLint supports only ECMAScript 5 syntax. You can override that setting to enable support for ECMAScript 6 as well as JSX by using configuration settings.

arrowFunctions?: bool ¶
binaryLiterals?: bool ¶
blockBindings?: bool ¶
classes?: bool ¶
defaultParams?: bool ¶
destructuring?: bool ¶
experimentalObjectRestSpread?: bool ¶

Enables support for the experimental object rest/spread properties (IMPORTANT: This is an experimental feature that may change significantly in the future. It's recommended that you do not write rules relying on this functionality unless you are willing to incur maintenance cost when it changes.)

forOf?: bool ¶
generators?: bool ¶
globalReturn?: bool ¶

allow return statements in the global scope

impliedStrict?: bool ¶

enable global strict mode (if ecmaVersion is 5 or greater)

jsx?: bool ¶

enable JSX

modules?: bool ¶
objectLiteralComputedProperties?: bool ¶
objectLiteralDuplicateProperties?: bool ¶
objectLiteralShorthandMethods?: bool ¶
objectLiteralShorthandProperties?: bool ¶
octalLiterals?: bool ¶
regexUFlag?: bool ¶
regexYFlag?: bool ¶
restParams?: bool ¶
spread?: bool ¶
superInFunctions?: bool ¶
templateStrings?: bool ¶
unicodeCodePointEscapes?: bool ¶
env?: ¶

An environment defines global variables that are predefined.

amd?: bool ¶

defines require() and define() as global variables as per the amd spec

applescript?: bool ¶

AppleScript global variables

atomtest?: bool ¶

Atom test helper globals

browser?: bool ¶

browser global variables

commonjs?: bool ¶

CommonJS global variables and CommonJS scoping (use this for browser-only code that uses Browserify/WebPack)

"shared-node-browser"?: bool ¶

Globals common to both Node and Browser

embertest?: bool ¶

Ember test helper globals

es6?: bool ¶

enable all ECMAScript 6 features except for modules

greasemonkey?: bool ¶

GreaseMonkey globals

jasmine?: bool ¶

adds all of the Jasmine testing global variables for version 1.3 and 2.0

jest?: bool ¶

Jest global variables

jquery?: bool ¶

jQuery global variables

meteor?: bool ¶

Meteor global variables

mocha?: bool ¶

adds all of the Mocha test global variables

mongo?: bool ¶

MongoDB global variables

nashorn?: bool ¶

Java 8 Nashorn global variables

node?: bool ¶

Node.js global variables and Node.js scoping

phantomjs?: bool ¶

PhantomJS global variables

prototypejs?: bool ¶

Prototype.js global variables

protractor?: bool ¶

Protractor global variables

qunit?: bool ¶

QUnit global variables

serviceworker?: bool ¶

Service Worker global variables

shelljs?: bool ¶

ShellJS global variables

webextensions?: bool ¶

WebExtensions globals

worker?: bool ¶

web workers global variables

extends?: #stringOrStringArray ¶
globals?: _#defs."/properties/globals" ¶

Set each global variable name equal to true to allow the variable to be overwritten or false to disallow overwriting.

noInlineConfig?: bool ¶

Prevent comments from changing config or rules

reportUnusedDisableDirectives?: bool ¶

Report unused eslint-disable comments

parser?: _#defs."/properties/parser" ¶
parserOptions?: ¶

The JavaScript language options to be supported

ecmaFeatures?: ¶
arrowFunctions?: bool ¶
binaryLiterals?: bool ¶
blockBindings?: bool ¶
classes?: bool ¶
defaultParams?: bool ¶
destructuring?: bool ¶
experimentalObjectRestSpread?: bool ¶

Enables support for the experimental object rest/spread properties (IMPORTANT: This is an experimental feature that may change significantly in the future. It's recommended that you do not write rules relying on this functionality unless you are willing to incur maintenance cost when it changes.)

forOf?: bool ¶
generators?: bool ¶
globalReturn?: bool ¶

allow return statements in the global scope

impliedStrict?: bool ¶

enable global strict mode (if ecmaVersion is 5 or greater)

jsx?: bool ¶

enable JSX

modules?: bool ¶
objectLiteralComputedProperties?: bool ¶
objectLiteralDuplicateProperties?: bool ¶
objectLiteralShorthandMethods?: bool ¶
objectLiteralShorthandProperties?: bool ¶
octalLiterals?: bool ¶
regexUFlag?: bool ¶
regexYFlag?: bool ¶
restParams?: bool ¶
spread?: bool ¶
superInFunctions?: bool ¶
templateStrings?: bool ¶
unicodeCodePointEscapes?: bool ¶
ecmaVersion?:
click to see definition
3 | 5 | 6 | 2015 | 7 | 2016 | 8 | 2017 | 9 | 2018 | 10 | 2019 | 11 | 2020 | 12 | 2021 | 13 | 2022 | 14 | 2023 | 15 | 2024 | "latest"
¶

Set to 3, 5 (default), 6, 7, 8, 9, 10, 11, 12, 13, 14, or 15 to specify the version of ECMAScript syntax you want to use. You can also set it to 2015 (same as 6), 2016 (same as 7), 2017 (same as 8), 2018 (same as 9), 2019 (same as 10), 2020 (same as 11), 2021 (same as 12), 2022 (same as 13), 2023 (same as 14), or 2024 (same as 15) to use the year-based naming. You can also set "latest" to use the most recently supported version.

sourceType?: "script" | "module" | "commonjs" ¶

set to "script" (default), "commonjs", or "module" if your code is in ECMAScript modules

plugins?: _#defs."/properties/plugins" ¶

ESLint supports the use of third-party plugins. Before using the plugin, you have to install it using npm.

root?: bool ¶

By default, ESLint will look for configuration files in all parent folders up to the root directory. This can be useful if you want all of your projects to follow a certain convention, but can sometimes lead to unexpected results. To limit ESLint to a specific project, set this to `true` in a configuration in the root of your project.

ignorePatterns?: #stringOrStringArray ¶
rules?: _#defs."/properties/rules" ¶

ESLint comes with a large number of rules. You can modify which rules your project uses either using configuration comments or configuration files.

settings?: _#defs."/properties/settings" ¶

ESLint supports adding shared settings into configuration file. You can add settings object to ESLint configuration file and it will be supplied to every rule that will be executed. This may be useful if you are adding custom rules and want them to have access to the same information and be easily configurable.

overrides?: _#defs."/properties/overrides" ¶

Allows to override configuration for files and folders, specified by glob patterns

#bestPractices: ¶
"accessor-pairs"?: #rule ¶
"array-callback-return"?: #rule ¶
"block-scoped-var"?: #rule ¶
"class-methods-use-this"?: #rule ¶
complexity?: #rule ¶
"consistent-return"?: #rule ¶
curly?: #rule ¶
"default-case"?: #rule ¶
"dot-location"?: #rule ¶
"dot-notation"?: #rule ¶
eqeqeq?: #rule ¶
"guard-for-in"?: #rule ¶
"no-alert"?: #rule ¶
"no-caller"?: #rule ¶
"no-case-declarations"?: #rule ¶
"no-div-regex"?: #rule ¶
"no-else-return"?: #rule ¶
"no-empty-function"?: #rule ¶
"no-empty-pattern"?: #rule ¶
"no-eq-null"?: #rule ¶
"no-eval"?: #rule ¶
"no-extend-native"?: #rule ¶
"no-extra-bind"?: #rule ¶
"no-extra-label"?: #rule ¶
"no-fallthrough"?: #rule ¶
"no-floating-decimal"?: #rule ¶
"no-global-assign"?: #rule ¶
"no-implicit-coercion"?: #rule ¶
"no-implicit-globals"?: #rule ¶
"no-implied-eval"?: #rule ¶
"no-invalid-this"?: #rule ¶
"no-iterator"?: #rule ¶
"no-labels"?: #rule ¶
"no-lone-blocks"?: #rule ¶
"no-loop-func"?: #rule ¶
"no-magic-numbers"?: #rule ¶
"no-multi-spaces"?: #rule ¶
"no-multi-str"?: #rule ¶
"no-native-reassign"?: #rule ¶
"no-new"?: #rule ¶
"no-new-func"?: #rule ¶
"no-new-wrappers"?: #rule ¶
"no-octal"?: #rule ¶
"no-octal-escape"?: #rule ¶
"no-param-reassign"?: #rule ¶
"no-proto"?: #rule ¶
"no-redeclare"?: #rule ¶
"no-restricted-properties"?: #rule ¶
"no-return-assign"?: #rule ¶
"no-return-await"?: #rule ¶
"no-script-url"?: #rule ¶
"no-self-assign"?: #rule ¶
"no-self-compare"?: #rule ¶
"no-sequences"?: #rule ¶
"no-throw-literal"?: #rule ¶
"no-unmodified-loop-condition"?: #rule ¶
"no-unused-expressions"?: #rule ¶
"no-unused-labels"?: #rule ¶
"no-useless-call"?: #rule ¶
"no-useless-concat"?: #rule ¶
"no-useless-escape"?: #rule ¶
"no-useless-return"?: #rule ¶
"no-void"?: #rule ¶
"no-warning-comments"?: #rule ¶
"no-with"?: #rule ¶
"prefer-promise-reject-errors"?: #rule ¶
radix?: #rule ¶
"require-await"?: #rule ¶
"vars-on-top"?: #rule ¶
"wrap-iife"?: #rule ¶
yoda?: #rule ¶
#ecmaScript6: ¶
"arrow-body-style"?: #rule ¶
"arrow-parens"?: #rule ¶
"arrow-spacing"?: #rule ¶
"constructor-super"?: #rule ¶
"generator-star-spacing"?: #rule ¶
"no-class-assign"?: #rule ¶
"no-confusing-arrow"?: #rule ¶
"no-const-assign"?: #rule ¶
"no-dupe-class-members"?: #rule ¶
"no-duplicate-imports"?: #rule ¶
"no-new-symbol"?: #rule ¶
"no-restricted-imports"?: #rule ¶
"no-this-before-super"?: #rule ¶
"no-useless-computed-key"?: #rule ¶
"no-useless-constructor"?: #rule ¶
"no-useless-rename"?: #rule ¶
"no-var"?: #rule ¶
"object-shorthand"?: #rule ¶
"prefer-arrow-callback"?: #rule ¶
"prefer-const"?: #rule ¶
"prefer-destructuring"?: #rule ¶
"prefer-numeric-literals"?: #rule ¶
"prefer-reflect"?: #rule ¶
"prefer-rest-params"?: #rule ¶
"prefer-spread"?: #rule ¶
"prefer-template"?: #rule ¶
"require-yield"?: #rule ¶
"rest-spread-spacing"?: #rule ¶
"sort-imports"?: #rule ¶
"symbol-description"?: #rule ¶
"template-curly-spacing"?: #rule ¶
"yield-star-spacing"?: #rule ¶
#legacy: ¶
"max-depth"?: #rule ¶
"max-len"?: #rule ¶
"max-params"?: #rule ¶
"max-statements"?: #rule ¶
"no-bitwise"?: #rule ¶
"no-plusplus"?: #rule ¶
#nodeAndCommonJs: ¶
"callback-return"?: #rule ¶
"global-require"?: #rule ¶
"handle-callback-err"?: #rule ¶
"no-buffer-constructor"?: #rule ¶
"no-mixed-requires"?: #rule ¶
"no-new-require"?: #rule ¶
"no-path-concat"?: #rule ¶
"no-process-env"?: #rule ¶
"no-process-exit"?: #rule ¶
"no-restricted-modules"?: #rule ¶
"no-sync"?: #rule ¶
#possibleErrors: ¶
"comma-dangle"?: #rule ¶
"for-direction"?: #rule ¶
"getter-return"?: #rule ¶
"no-await-in-loop"?: #rule ¶
"no-compare-neg-zero"?: #rule ¶
"no-cond-assign"?: #rule ¶
"no-console"?: #rule ¶
"no-constant-condition"?: #rule ¶
"no-control-regex"?: #rule ¶
"no-debugger"?: #rule ¶
"no-dupe-args"?: #rule ¶
"no-dupe-keys"?: #rule ¶
"no-duplicate-case"?: #rule ¶
"no-empty"?: #rule ¶
"no-empty-character-class"?: #rule ¶
"no-ex-assign"?: #rule ¶
"no-extra-boolean-cast"?: #rule ¶
"no-extra-parens"?: #rule ¶
"no-extra-semi"?: #rule ¶
"no-func-assign"?: #rule ¶
"no-inner-declarations"?: #rule ¶
"no-invalid-regexp"?: #rule ¶
"no-irregular-whitespace"?: #rule ¶
"no-negated-in-lhs"?: #rule ¶
"no-obj-calls"?: #rule ¶
"no-prototype-builtins"?: #rule ¶
"no-regex-spaces"?: #rule ¶
"no-sparse-arrays"?: #rule ¶
"no-template-curly-in-string"?: #rule ¶
"no-unexpected-multiline"?: #rule ¶
"no-unreachable"?: #rule ¶
"no-unsafe-finally"?: #rule ¶
"no-unsafe-negation"?: #rule ¶
"use-isnan"?: #rule ¶
"valid-jsdoc"?: #rule ¶
"valid-typeof"?: #rule ¶
#rule: matchN(1, [int & >=0 & <=2, "off" | "warn" | "error", [...]]) ¶
#strictMode: ¶
strict?: #rule ¶
#stringOrStringArray: matchN(1, [string, [...string]]) ¶
#stylisticIssues: ¶
"array-bracket-newline"?: #rule ¶
"array-bracket-spacing"?: #rule ¶
"array-element-newline"?: #rule ¶
"block-spacing"?: #rule ¶
"brace-style"?: #rule ¶
camelcase?: #rule ¶
"capitalized-comments"?: #rule ¶
"comma-dangle"?: #rule ¶
"comma-spacing"?: #rule ¶
"comma-style"?: #rule ¶
"computed-property-spacing"?: #rule ¶
"consistent-this"?: #rule ¶
"eol-last"?: #rule ¶
"func-call-spacing"?: #rule ¶
"func-name-matching"?: #rule ¶
"func-names"?: #rule ¶
"func-style"?: #rule ¶
"function-call-argument-newline"?: #rule ¶
"function-paren-newline"?: #rule ¶
"id-blacklist"?: #rule ¶
"id-length"?: #rule ¶
"id-match"?: #rule ¶
"implicit-arrow-linebreak"?: #rule ¶
indent?: #rule ¶
"indent-legacy"?: #rule ¶
"jsx-quotes"?: #rule ¶
"key-spacing"?: #rule ¶
"keyword-spacing"?: #rule ¶
"line-comment-position"?: #rule ¶
"lines-between-class-members"?: #rule ¶
"linebreak-style"?: #rule ¶
"lines-around-comment"?: #rule ¶
"lines-around-directive"?: #rule ¶
"max-depth"?: #rule ¶
"max-len"?: #rule ¶
"max-lines"?: #rule ¶
"max-nested-callbacks"?: #rule ¶
"max-params"?: #rule ¶
"max-statements"?: #rule ¶
"max-statements-per-line"?: #rule ¶
"multiline-comment-style"?: #rule ¶
"multiline-ternary"?: #rule ¶
"new-cap"?: #rule ¶
"newline-after-var"?: #rule ¶
"newline-before-return"?: #rule ¶
"newline-per-chained-call"?: #rule ¶
"new-parens"?: #rule ¶
"no-array-constructor"?: #rule ¶
"no-bitwise"?: #rule ¶
"no-continue"?: #rule ¶
"no-inline-comments"?: #rule ¶
"no-lonely-if"?: #rule ¶
"no-mixed-operators"?: #rule ¶
"no-mixed-spaces-and-tabs"?: #rule ¶
"no-multi-assign"?: #rule ¶
"no-multiple-empty-lines"?: #rule ¶
"no-negated-condition"?: #rule ¶
"no-nested-ternary"?: #rule ¶
"no-new-object"?: #rule ¶
"no-plusplus"?: #rule ¶
"no-restricted-syntax"?: #rule ¶
"no-spaced-func"?: #rule ¶
"no-tabs"?: #rule ¶
"no-ternary"?: #rule ¶
"no-trailing-spaces"?: #rule ¶
"no-underscore-dangle"?: #rule ¶
"no-unneeded-ternary"?: #rule ¶
"no-whitespace-before-property"?: #rule ¶
"nonblock-statement-body-position"?: #rule ¶
"object-curly-newline"?: #rule ¶
"object-curly-spacing"?: #rule ¶
"object-property-newline"?: #rule ¶
"object-shorthand"?: #rule ¶
"one-var"?: #rule ¶
"one-var-declaration-per-line"?: #rule ¶
"operator-assignment"?: #rule ¶
"operator-linebreak"?: #rule ¶
"padded-blocks"?: #rule ¶
"padding-line-between-statements"?: #rule ¶
"quote-props"?: #rule ¶
quotes?: #rule ¶
"require-jsdoc"?: #rule ¶
semi?: #rule ¶
"semi-spacing"?: #rule ¶
"semi-style"?: #rule ¶
"sort-keys"?: #rule ¶
"sort-vars"?: #rule ¶
"space-before-blocks"?: #rule ¶
"space-before-function-paren"?: #rule ¶
"spaced-comment"?: #rule ¶
"space-infix-ops"?: #rule ¶
"space-in-parens"?: #rule ¶
"space-unary-ops"?: #rule ¶
"switch-colon-spacing"?: #rule ¶
"template-tag-spacing"?: #rule ¶
"unicode-bom"?: #rule ¶
"wrap-regex"?: #rule ¶
#variables: ¶
"init-declarations"?: #rule ¶
"no-catch-shadow"?: #rule ¶
"no-delete-var"?: #rule ¶
"no-label-var"?: #rule ¶
"no-restricted-globals"?: #rule ¶
"no-shadow"?: #rule ¶
"no-shadow-restricted-names"?: #rule ¶
"no-undef"?: #rule ¶
"no-undefined"?: #rule ¶
"no-undef-init"?: #rule ¶
"no-unused-vars"?: #rule ¶
"no-use-before-define"?: #rule ¶
prettier?: prettier.#Schema ¶
#optionsDefinition: ¶
arrowParens?: matchN(1, ["always", "avoid"]) ¶

Include parentheses around a sole arrow function parameter.

bracketSameLine?: bool ¶

Put > of opening tags on the last line instead of on a new line.

bracketSpacing?: bool ¶

Print spaces between brackets.

checkIgnorePragma?: bool ¶

Check whether the file's first docblock comment contains '@noprettier' or '@noformat' to determine if it should be formatted.

cursorOffset?: int ¶

Print (to stderr) where a cursor at the given position would move to after formatting.

embeddedLanguageFormatting?: matchN(1, ["auto", "off"]) ¶

Control how Prettier formats quoted code embedded in the file.

endOfLine?: matchN(1, ["lf", "crlf", "cr", "auto"]) ¶

Which end of line characters to apply.

experimentalOperatorPosition?: matchN(1, ["start", "end"]) ¶

Where to print operators when binary expressions wrap lines.

experimentalTernaries?: bool ¶

Use curious ternaries, with the question mark after the condition.

filepath?: string ¶

Specify the input filepath. This will be used to do parser inference.

htmlWhitespaceSensitivity?: matchN(1, ["css", "strict", "ignore"]) ¶

How to handle whitespaces in HTML.

insertPragma?: bool ¶

Insert @format pragma into file's first docblock comment.

jsxSingleQuote?: bool ¶

Use single quotes in JSX.

objectWrap?: matchN(1, ["preserve", "collapse"]) ¶

How to wrap object literals.

parser?:
click to see definition
matchN(>=1, ["flow", "babel", "babel-flow", "babel-ts", "typescript", "acorn", "espree", "meriyah", "css", "less", "scss", "json", "json5", "jsonc", "json-stringify", "graphql", "markdown", "mdx", "vue", "yaml", "glimmer", "html", "angular", "lwc", "mjml", string])
¶

Which parser to use.

plugins?: [...string] ¶

Add a plugin. Multiple plugins can be passed as separate `--plugin`s.

printWidth?: int ¶

The line length where Prettier will try wrap.

proseWrap?: matchN(1, ["always", "never", "preserve"]) ¶

How to wrap prose.

quoteProps?: matchN(1, ["as-needed", "consistent", "preserve"]) ¶

Change when properties in objects are quoted.

rangeEnd?: int ¶

Format code ending at a given character offset (exclusive). The range will extend forwards to the end of the selected statement.

rangeStart?: int ¶

Format code starting at a given character offset. The range will extend backwards to the start of the first line containing the selected statement.

requirePragma?: bool ¶

Require either '@prettier' or '@format' to be present in the file's first docblock comment in order for it to be formatted.

semi?: bool ¶

Print semicolons.

singleAttributePerLine?: bool ¶

Enforce single attribute per line in HTML, Vue and JSX.

singleQuote?: bool ¶

Use single quotes instead of double quotes.

tabWidth?: int ¶

Number of spaces per indentation level.

trailingComma?: matchN(1, ["all", "es5", "none"]) ¶

Print trailing commas wherever possible when multi-line.

useTabs?: bool ¶

Indent with tabs instead of spaces.

vueIndentScriptAndStyle?: bool ¶

Indent script and style tags in Vue files.

#overridesDefinition: ¶
overrides?:
click to see definition
[...close({
	files!: matchN(1, [string, [...string]])
	excludeFiles?: matchN(1, [string, [...string]])
	options?: #optionsDefinition
})]
¶

Provide a list of patterns to override prettier configuration.

stylelint?: ¶
extends?: #simpleStringOrArrayStringRule ¶
plugins?: #simpleArrayStringRule ¶
customSyntax?: string ¶

Specify a custom syntax to use on your code.

overrides?:
click to see definition
[...{
	files?: [...string]
	customSyntax?: string
	rules?:        #allRules
	...
}]
¶

Provide rule and behavior overrides for files that match particular glob patterns.

processors?: [...matchN(>=1, [string, [string, ...{ ... }]])] ¶

Processors are functions that hook into stylelint's pipeline, modifying code on its way into stylelint and modifying results on their way out

ignoreDisables?: bool ¶

Ignore stylelint-disable (e.g. /* stylelint-disable block-no-empty */) comments.

ignoreFiles?: #simpleStringOrArrayStringRule ¶
defaultSeverity?: "warning" | "error" ¶

The default severity level for all rules that do not have a severity specified in their secondary options

reportDescriptionlessDisables?: #booleanRule ¶
reportInvalidScopeDisables?: #booleanRule ¶
reportNeedlessDisables?: #booleanRule ¶
rules?: #allRules ¶
#allRules:
click to see definition
matchN(30, [#atRule & {
	...
}, #block & {
	...
}, #color & {
	...
}, #comment & {
	...
}, #customMedia & {
	...
}, #customProperty & {
	...
}, #declaration & {
	...
}, #declarationBlock & {
	...
}, #font & {
	...
}, #function & {
	...
}, #generalSheet & {
	...
}, #keyframeDeclaration & {
	...
}, #length & {
	...
}, #lightness & {
	...
}, #mediaFeature & {
	...
}, #mediaQuery & {
	...
}, #mediaQueryList & {
	...
}, #number & {
	...
}, #property & {
	...
}, #rootRule & {
	...
}, #rule & {
	...
}, #selector & {
	...
}, #selectorList & {
	...
}, #shorthandProperty & {
	...
}, #string & {
	...
}, #stylelintDisableComment & {
	...
}, #time & {
	...
}, #unit & {
	...
}, #value & {
	...
}, #valueList & {
	...
}])
¶
#alwaysMultiLineRule:
click to see definition
matchN(1, [null, "always" | "always-multi-line", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["always" | "always-multi-line", #coreRule & (string | {
	...
})])]])
¶
#alwaysNeverRule:
click to see definition
matchN(1, [null, "always" | "never", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["always" | "never", #coreRule & (string | {
	...
})])]])
¶
#arrayStringRule:
click to see definition
matchN(1, [null | string, list.UniqueItems() & [_, ...] & [...matchN(>=1, [#simpleArrayStringRule & (string | [...] | {
	...
}), #coreRule & (string | [...] | {
	...
})])]])
¶
#atRule:
click to see definition
null | bool | number | string | [...] | {
	"at-rule-blacklist"?: #arrayStringRule
	"at-rule-empty-line-before"?: matchN(1, [null, "always" | "never", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["always" | "never", #coreRule & {
		...
	} & {
		except?: list.UniqueItems() & [_, ...] & [..."all-nested" | "after-same-name" | "inside-block" | "blockless-after-same-name-blockless" | "blockless-after-blockless" | "first-nested"]
		ignore?: list.UniqueItems() & [_, ...] & [..."after-comment" | "first-nested" | "inside-block" | "blockless-after-same-name-blockless" | "blockless-after-blockless"]
		ignoreAtRules?: #simpleStringOrArrayStringRule
		...
	}])]])
	"at-rule-name-case"?:          #lowerUpperRule
	"at-rule-name-newline-after"?: #alwaysMultiLineRule
	"at-rule-name-space-after"?: matchN(1, [null, "always" | "always-single-line", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["always" | "always-single-line", #coreRule & (string | {
		...
	})])]])
	"at-rule-no-unknown"?: matchN(1, [null, true, list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, [true, #coreRule & {
		...
	} & {
		ignoreAtRules?: #simpleArrayStringRule
		...
	}])]])
	"at-rule-no-vendor-prefix"?: #booleanRule
	"at-rule-semicolon-newline-after"?: matchN(1, [null, "always", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["always", #coreRule & (string | {
		...
	})])]])
	"at-rule-semicolon-space-before"?: _
	"at-rule-whitelist"?:              #arrayStringRule
	...
}
¶
#block:
click to see definition
null | bool | number | string | [...] | {
	"block-closing-brace-empty-line-before"?: matchN(1, [null, "always-multi-line" | "never", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["always-multi-line" | "never", #coreRule & (string | {
		...
	})])]])
	"block-closing-brace-newline-after"?:  #newlineSpaceWithIgnoreRule
	"block-closing-brace-newline-before"?: #newlineRule
	"block-closing-brace-space-after"?:    #newlineSpaceRule
	"block-closing-brace-space-before"?:   #newlineSpaceRule
	"block-no-empty"?:                     #booleanRule
	"block-no-single-line"?:               #booleanRule
	"block-opening-brace-newline-after"?:  #newlineRule
	"block-opening-brace-newline-before"?: matchN(1, [null, "always" | "always-single-line" | "never-single-line" | "always-multi-line" | "never-multi-line", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["always" | "always-single-line" | "never-single-line" | "always-multi-line" | "never-multi-line", #coreRule & (string | {
		...
	})])]])
	"block-opening-brace-space-after"?:  #newlineSpaceRule
	"block-opening-brace-space-before"?: #newlineSpaceWithIgnoreRule
	...
}
¶
#booleanRule:
click to see definition
matchN(1, [null, bool, list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, [bool, #coreRule & (bool | {
	...
})])]])
¶
#color:
click to see definition
null | bool | number | string | [...] | {
	"color-hex-case"?: #lowerUpperRule
	"color-hex-length"?: matchN(1, [null, "short" | "long", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["short" | "long", #coreRule & (string | {
		...
	})])]])
	"color-named"?: matchN(1, [null, "always-where-possible" | "never", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["always-where-possible" | "never", #coreRule & {
		...
	} & {
		ignore?: #simpleArrayStringRule
		...
	}])]])
	"color-no-hex"?:         #booleanRule
	"color-no-invalid-hex"?: #booleanRule
	...
}
¶
#comment:
click to see definition
null | bool | number | string | [...] | {
	"comment-empty-line-before"?: matchN(1, [null, "always" | "never", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["always" | "never", #coreRule & {
		...
	} & {
		except?: list.UniqueItems() & [_, ...] & [..."first-nested"]
		ignore?: list.UniqueItems() & [_, ...] & [..."between-comments" | "after-comment" | "stylelint-command" | "stylelint-commands"]
		...
	}])]])
	"comment-no-empty"?:          #booleanRule
	"comment-whitespace-inside"?: #alwaysNeverRule
	"comment-word-blacklist"?:    #arrayStringRule
	...
}
¶
#coreRule: ¶
disableFix?: bool ¶
message?: string ¶

Custom message that will be used in errors and warnings

reportDisables?: bool ¶
severity?: "warning" | "error" ¶

Message status

url?: net.AbsURL ¶
#customMedia:
click to see definition
null | bool | number | string | [...] | {
	"custom-media-pattern"?: #stringRule
	"no-unknown-custom-media"?: matchN(1, [matchN(1, [true, null]), list.MaxItems(2) & [_, ...] & [matchN(1, [true, null]), #coreRule, ...]])
	...
}
¶
#customProperty:
click to see definition
null | bool | number | string | [...] | {
	"custom-property-empty-line-before"?: matchN(1, [null, "always" | "never", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["always" | "never", #coreRule & {
		...
	} & {
		except?: list.UniqueItems() & [_, ...] & [..."after-comment" | "after-custom-property" | "first-nested"]
		ignore?: list.UniqueItems() & [_, ...] & [..."after-comment" | "inside-single-line-block"]
		...
	}])]])
	"custom-property-no-outside-root"?: #booleanRule
	"custom-property-pattern"?:         #stringRule
	"no-unknown-custom-properties"?: matchN(1, [matchN(1, [true, null]), list.MaxItems(2) & [_, ...] & [matchN(1, [true, null]), #coreRule, ...]])
	...
}
¶
#declaration:
click to see definition
null | bool | number | string | [...] | {
	"declaration-bang-space-after"?:    #alwaysNeverRule
	"declaration-bang-space-before"?:   #alwaysNeverRule
	"declaration-colon-newline-after"?: #alwaysMultiLineRule
	"declaration-colon-space-after"?: matchN(1, [null, "always" | "never" | "always-single-line", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["always" | "never" | "always-single-line", #coreRule & (string | {
		...
	})])]])
	"declaration-colon-space-before"?: #alwaysNeverRule
	"declaration-empty-line-before"?: matchN(1, [null, "always" | "never", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["always" | "never", #coreRule & {
		...
	} & {
		except?: list.UniqueItems() & [_, ...] & [..."after-comment" | "after-declaration" | "first-nested"]
		ignore?: list.UniqueItems() & [_, ...] & [..."after-comment" | "after-declaration" | "first-nested" | "inside-single-line-block"]
		...
	}])]])
	"declaration-no-important"?:             #booleanRule
	"declaration-property-unit-blacklist"?:  #objectRule
	"declaration-property-unit-whitelist"?:  #objectRule
	"declaration-property-value-blacklist"?: #objectRule
	"declaration-property-value-no-unknown"?: matchN(1, [matchN(1, [true, null]), list.MaxItems(2) & [_, ...] & [matchN(1, [true, null]), #coreRule & {
		...
	} & {
		ignoreProperties?: {
			[string]: matchN(>=1, [matchN(1, [string, [...string]]), matchN(1, [matchN(1, [{
				...
			}, =~"^\\/.+\\/i?$"]), [...matchN(>=1, [{
				...
			}, =~"^\\/.+\\/i?$"])]])])
		}
		propertiesSyntax?: {
			[string]: matchN(1, [string, [...string]])
		}
		typesSyntax?: {
			[string]: matchN(1, [string, [...string]])
		}
		...
	}, ...]])
	"declaration-property-value-whitelist"?: #objectRule
	...
}
¶
#declarationBlock:
click to see definition
null | bool | number | string | [...] | {
	"declaration-block-no-duplicate-properties"?: matchN(1, [null, true, list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, [true, #coreRule & {
		...
	} & {
		ignore?: list.UniqueItems() & [_, ...] & [..."consecutive-duplicates" | "consecutive-duplicates-with-different-values" | "consecutive-duplicates-with-different-syntaxes" | "consecutive-duplicates-with-same-prefixless-values"]
		ignoreProperties?: #simpleArrayStringRule
		...
	}])]])
	"declaration-block-no-ignored-properties"?: #booleanRule
	"declaration-block-no-redundant-longhand-properties"?: matchN(1, [null, true, list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, [true, #coreRule & {
		...
	} & {
		ignoreShorthands?: #simpleArrayStringRule
		...
	}])]])
	"declaration-block-no-shorthand-property-overrides"?: #booleanRule
	"declaration-block-properties-order"?: matchN(1, [null, "alphabetical", list.UniqueItems() & [_, ...] & [...matchN(>=1, ["alphabetical", string, #simpleArrayStringRule & (string | [...] | {
		...
	}), #coreRule & {
		...
	} & {
		order?: _
		if order != _|_ // explicit error (_|_ literal) in source
		{
			properties!: _
		}
		properties?: _
		if properties != _|_ // explicit error (_|_ literal) in source
		{
			order!: _
		}
		{}
		unspecified?: "top" | "bottom" | "bottomAlphabetical" | "ignore"
		order?:       "strict" | "flexible"
		properties?:  #simpleArrayStringRule
		...
	}])]])
	"declaration-block-semicolon-newline-after"?:      #newlineRule
	"declaration-block-semicolon-newline-before"?:     #newlineRule
	"declaration-block-semicolon-space-after"?:        #spaceRule
	"declaration-block-semicolon-space-before"?:       #spaceRule
	"declaration-block-single-line-max-declarations"?: #integerRule
	"declaration-block-trailing-semicolon"?:           #alwaysNeverRule
	...
}
¶
#font:
click to see definition
null | bool | number | string | [...] | {
	"font-family-name-quotes"?: matchN(1, [null, "always-where-required" | "always-where-recommended" | "always-unless-keyword", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["always-where-required" | "always-where-recommended" | "always-unless-keyword", #coreRule & (string | {
		...
	})])]])
	"font-weight-notation"?: matchN(1, [null, "numeric" | "named-where-possible", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["numeric" | "named-where-possible", #coreRule & {
		...
	} & {
		ignore?: list.UniqueItems() & [_, ...] & [..."relative"]
		...
	}])]])
	...
}
¶
#function:
click to see definition
null | bool | number | string | [...] | {
	"function-blacklist"?:                                #arrayStringRule
	"function-calc-no-unspaced-operator"?:                #booleanRule
	"function-comma-newline-after"?:                      #newlineRule
	"function-comma-newline-before"?:                     #newlineRule
	"function-comma-space-after"?:                        #spaceRule
	"function-comma-space-before"?:                       #spaceRule
	"function-linear-gradient-no-nonstandard-direction"?: #booleanRule
	"function-max-empty-lines"?:                          #integerRule
	"function-name-case"?: matchN(1, [null, "lower" | "upper", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["lower" | "upper", #coreRule & {
		...
	} & {
		ignoreFunctions?: #simpleArrayStringRule
		...
	}])]])
	"function-parentheses-newline-inside"?: #newlineRule
	"function-parentheses-space-inside"?:   #spaceRule
	"function-url-data-uris"?:              #alwaysNeverRule
	"function-url-no-scheme-relative"?:     #booleanRule
	"function-url-quotes"?:                 #alwaysNeverRule
	"function-url-scheme-whitelist"?:       #arrayStringRule
	"function-whitelist"?:                  #arrayStringRule
	"function-whitespace-after"?:           #alwaysNeverRule
	...
}
¶
#generalSheet:
click to see definition
null | bool | number | string | [...] | {
	indentation?: matchN(1, [null | int, "tab", list.UniqueItems() & [_, ...] & [...int], list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, [int, "tab", #coreRule & {
		...
	} & {
		indentInsideParens?: "twice" | "once-at-root-twice-in-block"
		except?: list.UniqueItems() & [_, ...] & [..."block" | "param" | "value"]
		ignore?: list.UniqueItems() & [_, ...] & [..."inside-parens" | "param" | "value"]
		...
	}]) & (int | string | {
		...
	})]]) & (null | int | string | [...])
	linebreaks?:        _
	"max-empty-lines"?: #integerRule
	"max-line-length"?: matchN(1, [null | int, list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, [int, #coreRule & {
		...
	} & {
		ignore?: matchN(>=1, ["non-comments" | "comments", list.UniqueItems() & [_, ...] & [..."non-comments" | "comments"]])
		...
	}]) & (int | {
		...
	})]]) & (null | int | [...])
	"max-nesting-depth"?: matchN(1, [null | int, list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, [int, #coreRule & {
		...
	} & {
		ignore?: list.UniqueItems() & [_, ...] & [..."at-rules-without-declaration-blocks" | "blockless-at-rules" | "pseudo-classes"]
		ignoreAtRules?: #simpleArrayStringRule
		...
	}]) & (int | {
		...
	})]]) & (null | int | [...])
	"no-browser-hacks"?: matchN(1, [null, true, list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, [true, #coreRule & {
		...
	} & {
		browsers?: #simpleStringOrArrayStringRule
		...
	}])]])
	"no-descending-specificity"?: #booleanRule
	"no-duplicate-selectors"?:    #booleanRule
	"no-empty-first-line"?:       _
	"no-empty-source"?:           #booleanRule
	"no-eol-whitespace"?: matchN(1, [null, true, list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, [true, #coreRule & {
		...
	} & {
		ignore?: list.UniqueItems() & [_, ...] & [..."empty-lines"]
		...
	}])]])
	"no-extra-semicolons"?: #booleanRule
	"no-indistinguishable-colors"?: matchN(1, [null, true, list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, [true, #coreRule & {
		...
	} & {
		threshold?: int & >=0 & <=100
		ignore?:    #simpleArrayStringRule
		whitelist?: list.UniqueItems() & [_, ...] & [...#simpleArrayStringRule]
		...
	}])]])
	"no-invalid-double-slash-comments"?: #booleanRule
	"no-missing-end-of-source-newline"?: #booleanRule
	"no-unknown-animations"?:            #booleanRule
	"unicode-bom"?:                      #alwaysNeverRule
	"no-unsupported-browser-features"?: matchN(1, [null, true, list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, [true, #coreRule & {
		...
	} & {
		browsers?: string
		ignore?:   #simpleStringOrArrayStringRule
		...
	}])]])
	...
}
¶
#integerRule:
click to see definition
matchN(1, [null | int, list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...#coreRule & (number | {
	...
}) & (int | {
	...
})]]) & (null | int | [...])
¶
#keyframeDeclaration: null | bool | number | string | [...] | { "keyframe-declaration-no-important"?: #booleanRule ... } ¶
#length: null | bool | number | string | [...] | { "length-zero-no-unit"?: #booleanRule ... } ¶
#lightness:
click to see definition
null | bool | number | string | [...] | {
	"lightness-notation"?: matchN(1, [matchN(1, ["percentage" | "number", null]), list.MaxItems(2) & [_, ...] & [matchN(1, ["percentage" | "number", null]), #coreRule, ...]])
	...
}
¶
#lowerUpperRule:
click to see definition
matchN(1, [null, "lower" | "upper", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["lower" | "upper", #coreRule & (string | {
	...
})])]])
¶
#mediaFeature:
click to see definition
null | bool | number | string | [...] | {
	"media-feature-colon-space-after"?:  #alwaysNeverRule
	"media-feature-colon-space-before"?: #alwaysNeverRule
	"media-feature-name-case"?:          #lowerUpperRule
	"media-feature-name-no-unknown"?: matchN(1, [null, true, list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, [true, #coreRule & {
		...
	} & {
		ignoreMediaFeatureNames?: #simpleArrayStringRule
		...
	}])]])
	"media-feature-name-value-no-unknown"?: matchN(1, [matchN(1, [true, null]), list.MaxItems(2) & [_, ...] & [matchN(1, [true, null]), #coreRule, ...]])
	"media-feature-name-no-vendor-prefix"?: #booleanRule
	"media-feature-name-unit-allowed-list"?: matchN(1, [matchN(1, [{
		[string]: matchN(1, [string, [...string]])
	}, null]), list.MaxItems(2) & [_, ...] & [matchN(1, [{
		[string]: matchN(1, [string, [...string]])
	}, null]), #coreRule, ...]])
	"media-feature-no-missing-punctuation"?:   #booleanRule
	"media-feature-parentheses-space-inside"?: #alwaysNeverRule
	"media-feature-range-notation"?: matchN(1, [matchN(1, ["prefix" | "context", null]), list.MaxItems(2) & [_, ...] & [matchN(1, ["prefix" | "context", null]), #coreRule, ...]])
	"media-feature-range-operator-space-after"?:  #alwaysNeverRule
	"media-feature-range-operator-space-before"?: #alwaysNeverRule
	...
}
¶
#mediaQuery:
click to see definition
null | bool | number | string | [...] | {
	"media-query-no-invalid"?: matchN(1, [matchN(1, [true, null]), list.MaxItems(2) & [_, ...] & [matchN(1, [true, null]), #coreRule, ...]])
	...
}
¶
#mediaQueryList:
click to see definition
null | bool | number | string | [...] | {
	"media-query-list-comma-newline-after"?:  #newlineRule
	"media-query-list-comma-newline-before"?: #newlineRule
	"media-query-list-comma-space-after"?:    #spaceRule
	"media-query-list-comma-space-before"?:   #spaceRule
	...
}
¶
#newlineRule:
click to see definition
matchN(1, [null, "always" | "always-multi-line" | "never-multi-line", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["always" | "always-multi-line" | "never-multi-line", #coreRule & (string | {
	...
})])]])
¶
#newlineSpaceRule:
click to see definition
matchN(1, [null, "always" | "never" | "always-single-line" | "never-single-line" | "always-multi-line" | "never-multi-line", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["always" | "never" | "always-single-line" | "never-single-line" | "always-multi-line" | "never-multi-line", #coreRule & (string | {
	...
})])]])
¶
#newlineSpaceWithIgnoreRule:
click to see definition
matchN(1, [null, "always" | "never" | "always-single-line" | "never-single-line" | "always-multi-line" | "never-multi-line", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["always" | "always-single-line" | "never-single-line" | "always-multi-line" | "never-multi-line", #coreRule & {
	...
} & {
	ignoreAtRules?: #simpleStringOrArrayStringRule
	...
}])]])
¶
#number:
click to see definition
null | bool | number | string | [...] | {
	"number-leading-zero"?:      #alwaysNeverRule
	"number-max-precision"?:     #integerRule
	"number-no-trailing-zeros"?: #booleanRule
	...
}
¶
#objectRule:
click to see definition
matchN(1, [null, {
	[string]: #simpleStringOrArrayStringRule
}, list.MaxItems(2) & [_, _, ...] & [{
	[string]: #simpleStringOrArrayStringRule
}, #coreRule, ...]])
¶
#property:
click to see definition
null | bool | number | string | [...] | {
	"property-blacklist"?: #arrayStringRule
	"property-case"?:      #lowerUpperRule
	"property-no-unknown"?: matchN(1, [null, true, list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, [true, #coreRule & {
		...
	} & {
		ignoreProperties?: #simpleArrayStringRule
		checkPrefixed?:    bool
		...
	}])]])
	"property-no-vendor-prefix"?: #booleanRule
	"property-whitelist"?:        #arrayStringRule
	...
}
¶
#rootRule: null | bool | number | string | [...] | { "root-no-standard-properties"?: #booleanRule ... } ¶
#rule:
click to see definition
null | bool | number | string | [...] | {
	"rule-nested-empty-line-before"?: matchN(1, [null, "always" | "never" | "always-multi-line" | "never-multi-line", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["always" | "never" | "always-multi-line" | "never-multi-line", #coreRule & {
		...
	} & {
		except?: list.UniqueItems() & [_, ...] & [..."first-nested"]
		ignore?: list.UniqueItems() & [_, ...] & [..."after-comment"]
		...
	}])]])
	"rule-non-nested-empty-line-before"?: matchN(1, [null, "always" | "never" | "always-multi-line" | "never-multi-line", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["always" | "never" | "always-multi-line" | "never-multi-line", #coreRule & {
		...
	} & {
		except?: list.UniqueItems() & [_, ...] & [..."after-single-line-comment"]
		ignore?: list.UniqueItems() & [_, ...] & [..."after-comment"]
		...
	}])]])
	...
}
¶
#selector:
click to see definition
null | bool | number | string | [...] | {
	"selector-anb-no-unmatchable"?: matchN(1, [matchN(1, [true, null]), list.MaxItems(2) & [_, ...] & [matchN(1, [true, null]), #coreRule, ...]])
	"selector-attribute-brackets-space-inside"?: #alwaysNeverRule
	"selector-attribute-operator-blacklist"?:    #arrayStringRule
	"selector-attribute-operator-space-after"?:  #alwaysNeverRule
	"selector-attribute-operator-space-before"?: #alwaysNeverRule
	"selector-attribute-operator-whitelist"?:    #arrayStringRule
	"selector-attribute-quotes"?:                #alwaysNeverRule
	"selector-class-pattern"?: matchN(1, [null | string, list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, [string, #coreRule & {
		...
	} & {
		resolveNestedSelectors?: bool
		...
	}])]])
	"selector-combinator-space-after"?:             #alwaysNeverRule
	"selector-combinator-space-before"?:            #alwaysNeverRule
	"selector-descendant-combinator-no-non-space"?: #booleanRule
	"selector-id-pattern"?:                         #stringRule
	"selector-max-compound-selectors"?:             #integerRule
	"selector-max-specificity"?:                    #stringRule
	"selector-nested-pattern"?:                     #stringRule
	"selector-no-attribute"?:                       #booleanRule
	"selector-no-combinator"?:                      #booleanRule
	"selector-no-id"?:                              #booleanRule
	"selector-no-qualifying-type"?: matchN(1, [null, true, list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, [true, #coreRule & {
		...
	} & {
		ignore?: list.UniqueItems() & [_, ...] & [..."attribute" | "class" | "id"]
		...
	}])]])
	"selector-no-type"?: matchN(1, [null, true, list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, [true, #coreRule & {
		...
	} & {
		ignore?: list.UniqueItems() & [_, ...] & [..."compounded" | "descendant"]
		ignoreTypes?: #simpleArrayStringRule
		...
	}])]])
	"selector-no-universal"?:      #booleanRule
	"selector-no-vendor-prefix"?:  #booleanRule
	"selector-pseudo-class-case"?: #lowerUpperRule
	"selector-pseudo-class-no-unknown"?: matchN(1, [null, true, list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, [true, #coreRule & {
		...
	} & {
		ignorePseudoClasses?: #simpleArrayStringRule
		...
	}])]])
	"selector-pseudo-class-parentheses-space-inside"?: #alwaysNeverRule
	"selector-pseudo-class-whitelist"?:                #arrayStringRule
	"selector-pseudo-element-case"?:                   #lowerUpperRule
	"selector-pseudo-element-colon-notation"?:         #singleDoubleRule
	"selector-pseudo-element-no-unknown"?: matchN(1, [null, true, list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, [true, #coreRule & {
		...
	} & {
		ignorePseudoElements?: #simpleArrayStringRule
		...
	}])]])
	"selector-root-no-composition"?: #booleanRule
	"selector-type-case"?:           #lowerUpperRule
	"selector-type-no-unknown"?: matchN(1, [null, true, list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, [true, #coreRule & {
		...
	} & {
		ignoreTypes?: #simpleArrayStringRule
		...
	}])]])
	"selector-max-empty-lines"?: #integerRule
	...
}
¶
#selectorList:
click to see definition
null | bool | number | string | [...] | {
	"selector-list-comma-newline-after"?:  #newlineRule
	"selector-list-comma-newline-before"?: #newlineRule
	"selector-list-comma-space-after"?:    #spaceRule
	"selector-list-comma-space-before"?:   #spaceRule
	...
}
¶
#shorthandProperty: null | bool | number | string | [...] | { "shorthand-property-no-redundant-values"?: #booleanRule ... } ¶
#simpleArrayStringRule: list.UniqueItems() & [...string] ¶
#simpleStringOrArrayStringRule: matchN(1, [string, #simpleArrayStringRule & (string | [...])]) ¶
#singleDoubleRule:
click to see definition
matchN(1, [null, "single" | "double", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["single" | "double", #coreRule & (string | {
	...
})])]])
¶
#spaceRule:
click to see definition
matchN(1, [null, "always" | "never" | "always-single-line" | "never-single-line", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["always" | "never" | "always-single-line" | "never-single-line", #coreRule & (string | {
	...
})])]])
¶
#string:
click to see definition
null | bool | number | string | [...] | {
	"string-no-newline"?: #booleanRule
	"string-quotes"?:     #singleDoubleRule
	...
}
¶
#stringRule:
click to see definition
matchN(1, [null | string, list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, [string, #coreRule & (string | {
	...
})])]])
¶
#stylelintDisableComment:
click to see definition
null | bool | number | string | [...] | {
	"stylelint-disable-reason"?: matchN(1, [null, "always-before" | "always-after", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["always-before" | "always-after", #coreRule & (string | {
		...
	})])]])
	...
}
¶
#time: null | bool | number | string | [...] | { "time-no-imperceptible"?: #booleanRule ... } ¶
#unit:
click to see definition
null | bool | number | string | [...] | {
	"unit-blacklist"?: #unitRule
	"unit-case"?:      #lowerUpperRule
	"unit-no-unknown"?: matchN(1, [null, true, list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, [true, #coreRule & {
		...
	} & {
		ignoreUnits?: #simpleArrayStringRule
		...
	}])]])
	"unit-whitelist"?: #unitRule
	...
}
¶
#unitRule:
click to see definition
matchN(1, [null, "em" | "ex" | "px" | "%" | "rem" | "vw" | "vh" | "vm" | "vmin" | "vmax" | "ch" | "in" | "cm" | "mm" | "q" | "pt" | "pc" | "deg" | "grad" | "rad" | "turn" | "ms" | "s" | "Hz" | "kHz" | "dpi" | "dpcm" | "dppx" | "fr", list.UniqueItems() & [_, ...] & [...matchN(>=1, ["em" | "ex" | "px" | "%" | "rem" | "vw" | "vh" | "vm" | "vmin" | "vmax" | "ch" | "in" | "cm" | "mm" | "q" | "pt" | "pc" | "deg" | "grad" | "rad" | "turn" | "ms" | "s" | "Hz" | "kHz" | "dpi" | "dpcm" | "dppx" | "fr", list.UniqueItems() & [_, ...] & [..."em" | "ex" | "px" | "%" | "rem" | "vw" | "vh" | "vm" | "vmin" | "vmax" | "ch" | "in" | "cm" | "mm" | "q" | "pt" | "pc" | "deg" | "grad" | "rad" | "turn" | "ms" | "s" | "Hz" | "kHz" | "dpi" | "dpcm" | "dppx" | "fr"], #coreRule & {
	...
} & {
	ignoreProperties?: {
		{
			[=~"(em|ex|ch|vw|vh|cm|mm|in|pt|pc|px|rem|vmin|vmax|%)"]: #simpleArrayStringRule
		}
		...
	}
	...
}])]])
¶
#value:
click to see definition
null | bool | number | string | [...] | {
	"value-keyword-case"?: matchN(1, [null, "lower" | "upper", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["lower" | "upper", #coreRule & {
		...
	} & {
		ignoreKeywords?: #simpleArrayStringRule
		...
	}])]])
	"value-no-vendor-prefix"?: #booleanRule
	...
}
¶
#valueList:
click to see definition
null | bool | number | string | [...] | {
	"value-list-comma-newline-after"?:  #newlineRule
	"value-list-comma-newline-before"?: #newlineRule
	"value-list-comma-space-after"?:    #spaceRule
	"value-list-comma-space-before"?:   #spaceRule
	"value-list-max-empty-lines"?:      #integerRule
	...
}
¶
ava?: ¶
files?: #."array-of-paths" ¶
ignoredByWatcher?: #."array-of-paths" ¶
match?: #."array-of-paths" ¶
cache?: bool ¶

Defaults to `true` to cache compiled files under `node_modules/.cache/ava.` If `false`, files are cached in a temporary directory instead

concurrency?: number ¶

Max number of test files running at the same time (default: CPU cores)

workerThreads?: bool ¶

Use worker threads to run tests (enabled by default). If `false`, tests will run in child processes

failFast?: bool ¶

Stop running further tests once a test fails

failWithoutAssertions?: bool ¶

If `false`, does not fail a test if it doesn't run assertions

environmentVariables?: [string]: string ¶

environment variables

Specifies environment variables to be made available to the tests. The environment variables defined here override the ones from `process.env`

serial?: bool ¶

if `true`, prevents parallel execution of tests within a file

tap?: bool ¶

If `true`, enables the TAP reporter

verbose?: bool ¶

If `true`, enables verbose output (though currently non-verbose output is not supported)

snapshotDir?: #path ¶
extensions?:
click to see definition
matchN(>=1, [#."array-of-strings", {
	{
		[=~"^(c|m)?js$"]: true
	}
	{
		[!~"^(c|m)?js$" & !~"^()$"]: "commonjs" | "module"
	}
}])
¶

Extensions of test files. Setting this overrides the default `["cjs", "mjs", "js"]` value, so make sure to include those extensions in the list. Experimentally you can configure how files are loaded

require?: #."array-of-paths" ¶
timeout?: matchN(>=1, [>=0, =~"^(\\d+)(s|m)$"]) ¶

Timeouts in AVA behave differently than in other test frameworks. AVA resets a timer after each test, forcing tests to quit if no new test results were received within the specified timeout. This can be used to handle stalled tests. See our timeout documentation for more options

nodeArguments?: #."array-of-strings" ¶
utilizeParallelBuilds?: bool ¶

If `false`, disable parallel builds (default: `true`)

typescript?: ¶

configuration

Configures @ava/typescript for projects that precompile TypeScript. Alternatively, you can use `ts-node` to do live testing without transpiling, in which case you shouldn't use the `typescript` property

extensions?: #."array-of-paths" ¶
rewritePaths?:
click to see definition
{
	{
		[=~"/$"]: =~"/$"
	}
	...
}
¶

paths

AVA searches your entire project for `*.js`, `*.cjs`, `*.mjs` and `*.ts` files (or other extensions you've configured). It will ignore such files found in the `rewritePaths` targets (e.g. `build/`). If you use more specific paths, for instance `build/main/`, you may need to change AVA's `files` configuration to ignore other directories. Paths are relative to your project directory

compile?: false | "tsc" ¶

If `false`, AVA will assume you have already compiled your project. If set to `'tsc'`, AVA will run the TypeScript compiler before running your tests. This can be inefficient when using AVA in watch mode

#: ¶
"array-of-paths": [...#path] ¶
"array-of-strings": [...string] ¶
#path: strings.MinRunes(1) ¶
release?: ¶
extends?: matchN(1, [string, [...string]]) ¶

List of modules or file paths containing a shareable configuration. If multiple shareable configurations are set, they will be imported in the order defined with each configuration option taking precedence over the options defined in a previous shareable configuration

branches?: matchN(1, [string, #."branch-object", [...matchN(>=1, [string, #."branch-object"])]]) ¶

The branches on which releases should happen.

repositoryUrl?: string ¶

The git repository URL

tagFormat?: string ¶

The Git tag format used by semantic-release to identify releases. The tag name is generated with Lodash template and will be compiled with the version variable.

plugins?: [...matchN(>=1, [string, [...], { path!: string ... }])] ¶

Define the list of plugins to use. Plugins will run in series, in the order defined

dryRun?: bool ¶

The objective of the dry-run mode is to get a preview of the pending release. Dry-run mode skips the following steps: prepare, publish, success and fail. In addition to this it prints the next version and release notes to the console

ci?: bool ¶

Set to false to skip Continuous Integration environment verifications. This allows for making releases from a local machine

#: ¶
"branch-object": ¶
name!: string ¶
channel?: string ¶
range?: string ¶
prerelease?: bool | string ¶
jscpd?: ¶
minLines?: int ¶

minimum size of code block in lines to check for duplication

maxLines?: int ¶

maximum size of source file in lines to check for duplication

maxSize?: matchN(>=1, [=~"^\\+?[0-9]+(\\.[0-9]+)? *[kKmMgGtTpP][bB]$", int]) ¶

maximum size of source file in bytes to check for duplication (e.g.,: 1kb, 1mb, 120kb)

minTokens?: int ¶

minimum size of code block in tokens to check for duplication

threshold?: number ¶

maximum allowed duplicate lines expressed as a percentage; exit with error and exit code 1 when threshold exceeded

formatsExts?: [string]: [...string] ¶

custom mapping from formats to file extensions (default: https://github.com/kucherenko/jscpd/blob/master/packages/tokenizer/src/formats.ts); see https://github.com/kucherenko/jscpd/blob/master/supported_formats.md

output?: string ¶

path to directory for non-console reports

path?: [...string] ¶

paths that should be included in duplicate detection (default: [process.cwd()])

pattern?: string ¶

glob pattern for files that should be included in duplicate detection (e.g., **/*.txt); only used to filter directories configured via path option

ignorePattern?: [...string] ¶

ignore code blocks matching these regular expressions

mode?: "mild" | "strict" | "weak" ¶

mode of detection quality; see https://github.com/kucherenko/jscpd/blob/master/packages/jscpd/README.md#mode

ignore?: [...string] ¶

glob pattern for files that should be excluded from duplicate detection

format?: [...#format] ¶

list of formats for which to detect duplication (default: all); see https://github.com/kucherenko/jscpd/blob/master/supported_formats.md

store?: "leveldb" | "redis" ¶

store used to collect information about code (default: in-memory store); install @jscpd/leveldb-store and use leveldb for big repositories

reporters?: [..."xml" | "json" | "csv" | "markdown" | "consoleFull" | "html" | "console" | "silent" | "threshold" | "xcode"] ¶

a list of reporters to use to output information about duplication; see https://github.com/kucherenko/jscpd/blob/master/packages/jscpd/README.md#reporters

blame?: bool ¶

get information about authors and dates of duplicated blocks from Git

silent?: bool ¶

do not write duplicate detection progress and result to console

verbose?: bool ¶

show full information during duplicate detection

absolute?: bool ¶

use absolute paths in reports

noSymlinks?: bool ¶

do not follow symlinks

skipLocal?: bool ¶

skip duplicates within folders; just detect cross-folder duplicates

ignoreCase?: bool ¶

ignore case of symbols in code (experimental)

gitignore?: bool ¶

ignore all files from .gitignore file

reportersOptions?: ¶
badge?: ¶
path?: string ¶

output path for duplication level badge (default: path.join(output, 'jscpd-badge.svg'))

label?: string ¶

badge subject text (URL-encoding needed for spaces or special characters)

labelColor?: #color ¶
status?: string ¶

badge value text (URL-encoding needed for spaces or special characters, default: duplication %)

color?: #color ¶
style?: "flat" | "classic" ¶

badge look: flat or classic

icon?: string ¶

URL for icon to display in front of badge subject text (e.g., data:image/svg+xml;base64,...)

iconWidth?: number ¶

SVG width of icon to display in front of badge subject text; set this if icon is not square

scale?: number ¶

size of badge relative to default of 1

exitCode?: int ¶

exit code to use when at least one duplicate code block is detected but threshold is not exceeded

#color: matchN(1, [#colorPreset, #colorHex]) ¶
#colorHex: =~"([0-9a-fA-F]{3}){1,2}" ¶
#colorPreset: "green" | "blue" | "red" | "yellow" | "orange" | "purple" | "pink" | "grey" | "gray" | "cyan" | "black" ¶
#format:
click to see definition
"abap" | "actionscript" | "ada" | "apacheconf" | "apl" | "applescript" | "arduino" | "arff" | "asciidoc" | "asm6502" | "aspnet" | "autohotkey" | "autoit" | "bash" | "basic" | "batch" | "bison" | "brainfuck" | "bro" | "c" | "c-header" | "clike" | "clojure" | "coffeescript" | "comments" | "cpp" | "cpp-header" | "crystal" | "csharp" | "csp" | "css-extras" | "css" | "d" | "dart" | "diff" | "django" | "docker" | "eiffel" | "elixir" | "elm" | "erb" | "erlang" | "flow" | "fortran" | "fsharp" | "gedcom" | "gherkin" | "git" | "glsl" | "go" | "graphql" | "groovy" | "haml" | "handlebars" | "haskell" | "haxe" | "hpkp" | "hsts" | "http" | "ichigojam" | "icon" | "inform7" | "ini" | "io" | "j" | "java" | "javascript" | "jolie" | "json" | "jsx" | "julia" | "keymap" | "kotlin" | "latex" | "less" | "liquid" | "lisp" | "livescript" | "lolcode" | "lua" | "makefile" | "markdown" | "markup" | "matlab" | "mel" | "mizar" | "monkey" | "n4js" | "nasm" | "nginx" | "nim" | "nix" | "nsis" | "objectivec" | "ocaml" | "opencl" | "oz" | "parigp" | "pascal" | "perl" | "php" | "plsql" | "powershell" | "processing" | "prolog" | "properties" | "protobuf" | "pug" | "puppet" | "pure" | "python" | "q" | "qore" | "r" | "reason" | "renpy" | "rest" | "rip" | "roboconf" | "ruby" | "rust" | "sas" | "sass" | "scala" | "scheme" | "scss" | "smalltalk" | "smarty" | "soy" | "sql" | "stylus" | "swift" | "tap" | "tcl" | "textile" | "tsx" | "tt2" | "twig" | "typescript" | "vbnet" | "velocity" | "verilog" | "vhdl" | "vim" | "visual-basic" | "wasm" | "url" | "wiki" | "xeora" | "xojo" | "xquery" | "yaml"
¶
pnpm?: ¶

Defines pnpm specific configuration.

overrides?: ... ¶

Used to override any dependency in the dependency graph.

packageExtensions?:
click to see definition
close({
	[=~"^.+$"]: close({
		dependencies?:         #dependency
		optionalDependencies?: #optionalDependency
		peerDependencies?:     #peerDependency
		peerDependenciesMeta?: #peerDependencyMeta
	})
})
¶

Used to extend the existing package definitions with additional information.

peerDependencyRules?: ¶
ignoreMissing?: [...string] ¶

pnpm will not print warnings about missing peer dependencies from this list.

allowedVersions?: ... ¶

Unmet peer dependency warnings will not be printed for peer dependencies of the specified range.

allowAny?: [...string] ¶

Any peer dependency matching the pattern will be resolved from any version, regardless of the range specified in "peerDependencies".

neverBuiltDependencies?: [...string] ¶

A list of dependencies to run builds for.

onlyBuiltDependencies?: [...string] ¶

A list of package names that are allowed to be executed during installation.

onlyBuiltDependenciesFile?: string ¶

Specifies a JSON file that lists the only packages permitted to run installation scripts during the pnpm install process.

ignoredBuiltDependencies?: [...string] ¶

A list of package names that should not be built during installation.

allowedDeprecatedVersions?: ... ¶

A list of deprecated versions that the warnings are suppressed.

patchedDependencies?: ... ¶

A list of dependencies that are patched.

allowNonAppliedPatches?: bool ¶

When true, installation won't fail if some of the patches from the "patchedDependencies" field were not applied.

allowUnusedPatches?: bool ¶

When true, installation won't fail if some of the patches from the "patchedDependencies" field were not applied.

updateConfig?: ¶
ignoreDependencies?: [...string] ¶

A list of packages that should be ignored when running "pnpm outdated" or "pnpm update --latest".

configDependencies?: ... ¶

Configurational dependencies are installed before all the other types of dependencies (before 'dependencies', 'devDependencies', 'optionalDependencies').

auditConfig?: ¶
ignoreCves?: [...=~"^CVE-\\d{4}-\\d{4,7}$"] ¶

A list of CVE IDs that will be ignored by "pnpm audit".

ignoreGhsas?: [...=~"^GHSA(-[23456789cfghjmpqrvwx]{4}){3}$"] ¶

A list of GHSA Codes that will be ignored by "pnpm audit".

requiredScripts?: [...string] ¶

A list of scripts that must exist in each project.

supportedArchitectures?: ¶

Specifies architectures for which you'd like to install optional dependencies, even if they don't match the architecture of the system running the install.

os?: [...string] ¶
cpu?: [...string] ¶
libc?: [...string] ¶
ignoredOptionalDependencies?: [...string] ¶

A list of optional dependencies that the install should be skipped.

executionEnv?: ¶
nodeVersion?: string ¶

Specifies which exact Node.js version should be used for the project's runtime.

stackblitz?: ¶

Defines the StackBlitz configuration for the project.

installDependencies?: bool ¶

StackBlitz automatically installs npm dependencies when opening a project.

startCommand?: bool | string ¶

A terminal command to be executed when opening the project, after installing npm dependencies.

compileTrigger?: "auto" | "keystroke" | "save" ¶

The compileTrigger option controls how file changes in the editor are written to the WebContainers in-memory filesystem.

env?: ... ¶

A map of default environment variables that will be set in each top-level shell process.

#dependency: [string]: string ¶

Dependencies are specified with a simple hash of package name to version range. The version range is a string which has one or more space-separated descriptors. Dependencies can also be identified with a tarball or git URL.

#devDependency: [string]: string ¶

Specifies dependencies that are required for the development and testing of the project. These dependencies are not needed in the production environment.

#devEngineDependency: ¶

Specifies requirements for development environment components such as operating systems, runtimes, or package managers. Used to ensure consistent development environments across the team.

name!: string ¶

The name of the dependency, with allowed values depending on the parent field

version?: string ¶

The version range for the dependency

onFail?: "ignore" | "warn" | "error" | "download" ¶

What action to take if validation fails

#fundingUrl: net.AbsURL ¶

URL to a website with details about how to fund the package.

#fundingWay: ¶

Used to inform about ways to help fund development of the package.

url!: #fundingUrl ¶
type?: string ¶

The type of funding or the platform through which funding can be provided, e.g. patreon, opencollective, tidelift or github.

#license:
click to see definition
matchN(>=1, [string, "AGPL-3.0-only" | "Apache-2.0" | "BSD-2-Clause" | "BSD-3-Clause" | "BSL-1.0" | "CC0-1.0" | "CDDL-1.0" | "CDDL-1.1" | "EPL-1.0" | "EPL-2.0" | "GPL-2.0-only" | "GPL-3.0-only" | "ISC" | "LGPL-2.0-only" | "LGPL-2.1-only" | "LGPL-2.1-or-later" | "LGPL-3.0-only" | "LGPL-3.0-or-later" | "MIT" | "MPL-2.0" | "MS-PL" | "UNLICENSED"])
¶
#optionalDependency: [string]: string ¶

Specifies dependencies that are optional for your project. These dependencies are attempted to be installed during the npm install process, but if they fail to install, the installation process will not fail.

#packageExportsEntry: matchN(1, [#packageExportsEntryPath, #packageExportsEntryObject]) ¶
#packageExportsEntryObject: ¶

Used to specify conditional exports, note that Conditional exports are unsupported in older environments, so it's recommended to use the fallback array option if support for those environments is a concern.

require?: #packageExportsEntryOrFallback ¶
import?: #packageExportsEntryOrFallback ¶
"module-sync"?: #packageExportsEntryOrFallback ¶
node?: #packageExportsEntryOrFallback ¶
default?: #packageExportsEntryOrFallback ¶
types?: #packageExportsEntryOrFallback ¶
#packageExportsEntryOrFallback: matchN(1, [#packageExportsEntry, #packageExportsFallback]) ¶
#packageExportsEntryPath: null | =~"^\\./" ¶

The module path that is resolved when this specifier is imported. Set to `null` to disallow importing this module.

#packageExportsFallback: [...#packageExportsEntry] ¶

Used to allow fallbacks in case this environment doesn't support the preceding entries.

#packageImportsEntry: matchN(1, [#packageImportsEntryPath, #packageImportsEntryObject]) ¶
#packageImportsEntryObject: ¶

Used to specify conditional exports, note that Conditional exports are unsupported in older environments, so it's recommended to use the fallback array option if support for those environments is a concern.

require?: #packageImportsEntryOrFallback ¶
import?: #packageImportsEntryOrFallback ¶
node?: #packageImportsEntryOrFallback ¶
default?: #packageImportsEntryOrFallback ¶
types?: #packageImportsEntryOrFallback ¶
#packageImportsEntryOrFallback: matchN(1, [#packageImportsEntry, #packageImportsFallback]) ¶
#packageImportsEntryPath: null | string ¶

The module path that is resolved when this specifier is imported. Set to `null` to disallow importing this module.

#packageImportsFallback: [...#packageImportsEntry] ¶

Used to allow fallbacks in case this environment doesn't support the preceding entries.

#peerDependency: [string]: string ¶

Specifies dependencies that are required by the package but are expected to be provided by the consumer of the package.

#peerDependencyMeta:
click to see definition
{
	[string]: {
		optional?: bool
		...
	}
}
¶

When a user installs your package, warnings are emitted if packages specified in "peerDependencies" are not already installed. The "peerDependenciesMeta" field serves to provide more information on how your peer dependencies are utilized. Most commonly, it allows peer dependencies to be marked as optional. Metadata for this field is specified with a simple hash of the package name to a metadata object.

#person:
click to see definition
string | {
	name!:  string
	url?:   net.AbsURL
	email?: string
	...
}
¶

A person who has been involved in creating or maintaining this package.

#scriptsInstallAfter: string ¶

Run AFTER the package is installed.

#scriptsPublishAfter: string ¶

Run AFTER the package is published.

#scriptsRestart: string ¶

Run by the 'npm restart' command. Note: 'npm restart' will run the stop and start scripts if no restart script is provided.

#scriptsStart: string ¶

Run by the 'npm start' command.

#scriptsStop: string ¶

Run by the 'npm stop' command.

#scriptsTest: string ¶

Run by the 'npm test' command.

#scriptsUninstallBefore: string ¶

Run BEFORE the package is uninstalled.

#scriptsVersionBefore: string ¶

Run BEFORE bump the package version.

eslintConfig?: ¶
ecmaFeatures?: ¶

By default, ESLint supports only ECMAScript 5 syntax. You can override that setting to enable support for ECMAScript 6 as well as JSX by using configuration settings.

arrowFunctions?: bool ¶
binaryLiterals?: bool ¶
blockBindings?: bool ¶
classes?: bool ¶
defaultParams?: bool ¶
destructuring?: bool ¶
experimentalObjectRestSpread?: bool ¶

Enables support for the experimental object rest/spread properties (IMPORTANT: This is an experimental feature that may change significantly in the future. It's recommended that you do not write rules relying on this functionality unless you are willing to incur maintenance cost when it changes.)

forOf?: bool ¶
generators?: bool ¶
globalReturn?: bool ¶

allow return statements in the global scope

impliedStrict?: bool ¶

enable global strict mode (if ecmaVersion is 5 or greater)

jsx?: bool ¶

enable JSX

modules?: bool ¶
objectLiteralComputedProperties?: bool ¶
objectLiteralDuplicateProperties?: bool ¶
objectLiteralShorthandMethods?: bool ¶
objectLiteralShorthandProperties?: bool ¶
octalLiterals?: bool ¶
regexUFlag?: bool ¶
regexYFlag?: bool ¶
restParams?: bool ¶
spread?: bool ¶
superInFunctions?: bool ¶
templateStrings?: bool ¶
unicodeCodePointEscapes?: bool ¶
env?: ¶

An environment defines global variables that are predefined.

amd?: bool ¶

defines require() and define() as global variables as per the amd spec

applescript?: bool ¶

AppleScript global variables

atomtest?: bool ¶

Atom test helper globals

browser?: bool ¶

browser global variables

commonjs?: bool ¶

CommonJS global variables and CommonJS scoping (use this for browser-only code that uses Browserify/WebPack)

"shared-node-browser"?: bool ¶

Globals common to both Node and Browser

embertest?: bool ¶

Ember test helper globals

es6?: bool ¶

enable all ECMAScript 6 features except for modules

greasemonkey?: bool ¶

GreaseMonkey globals

jasmine?: bool ¶

adds all of the Jasmine testing global variables for version 1.3 and 2.0

jest?: bool ¶

Jest global variables

jquery?: bool ¶

jQuery global variables

meteor?: bool ¶

Meteor global variables

mocha?: bool ¶

adds all of the Mocha test global variables

mongo?: bool ¶

MongoDB global variables

nashorn?: bool ¶

Java 8 Nashorn global variables

node?: bool ¶

Node.js global variables and Node.js scoping

phantomjs?: bool ¶

PhantomJS global variables

prototypejs?: bool ¶

Prototype.js global variables

protractor?: bool ¶

Protractor global variables

qunit?: bool ¶

QUnit global variables

serviceworker?: bool ¶

Service Worker global variables

shelljs?: bool ¶

ShellJS global variables

webextensions?: bool ¶

WebExtensions globals

worker?: bool ¶

web workers global variables

extends?: #stringOrStringArray ¶
globals?: _#defs."/properties/globals" ¶

Set each global variable name equal to true to allow the variable to be overwritten or false to disallow overwriting.

noInlineConfig?: bool ¶

Prevent comments from changing config or rules

reportUnusedDisableDirectives?: bool ¶

Report unused eslint-disable comments

parser?: _#defs."/properties/parser" ¶
parserOptions?: ¶

The JavaScript language options to be supported

ecmaFeatures?: ¶
arrowFunctions?: bool ¶
binaryLiterals?: bool ¶
blockBindings?: bool ¶
classes?: bool ¶
defaultParams?: bool ¶
destructuring?: bool ¶
experimentalObjectRestSpread?: bool ¶

Enables support for the experimental object rest/spread properties (IMPORTANT: This is an experimental feature that may change significantly in the future. It's recommended that you do not write rules relying on this functionality unless you are willing to incur maintenance cost when it changes.)

forOf?: bool ¶
generators?: bool ¶
globalReturn?: bool ¶

allow return statements in the global scope

impliedStrict?: bool ¶

enable global strict mode (if ecmaVersion is 5 or greater)

jsx?: bool ¶

enable JSX

modules?: bool ¶
objectLiteralComputedProperties?: bool ¶
objectLiteralDuplicateProperties?: bool ¶
objectLiteralShorthandMethods?: bool ¶
objectLiteralShorthandProperties?: bool ¶
octalLiterals?: bool ¶
regexUFlag?: bool ¶
regexYFlag?: bool ¶
restParams?: bool ¶
spread?: bool ¶
superInFunctions?: bool ¶
templateStrings?: bool ¶
unicodeCodePointEscapes?: bool ¶
ecmaVersion?:
click to see definition
3 | 5 | 6 | 2015 | 7 | 2016 | 8 | 2017 | 9 | 2018 | 10 | 2019 | 11 | 2020 | 12 | 2021 | 13 | 2022 | 14 | 2023 | 15 | 2024 | "latest"
¶

Set to 3, 5 (default), 6, 7, 8, 9, 10, 11, 12, 13, 14, or 15 to specify the version of ECMAScript syntax you want to use. You can also set it to 2015 (same as 6), 2016 (same as 7), 2017 (same as 8), 2018 (same as 9), 2019 (same as 10), 2020 (same as 11), 2021 (same as 12), 2022 (same as 13), 2023 (same as 14), or 2024 (same as 15) to use the year-based naming. You can also set "latest" to use the most recently supported version.

sourceType?: "script" | "module" | "commonjs" ¶

set to "script" (default), "commonjs", or "module" if your code is in ECMAScript modules

plugins?: _#defs."/properties/plugins" ¶

ESLint supports the use of third-party plugins. Before using the plugin, you have to install it using npm.

root?: bool ¶

By default, ESLint will look for configuration files in all parent folders up to the root directory. This can be useful if you want all of your projects to follow a certain convention, but can sometimes lead to unexpected results. To limit ESLint to a specific project, set this to `true` in a configuration in the root of your project.

ignorePatterns?: #stringOrStringArray ¶
rules?: _#defs."/properties/rules" ¶

ESLint comes with a large number of rules. You can modify which rules your project uses either using configuration comments or configuration files.

settings?: _#defs."/properties/settings" ¶

ESLint supports adding shared settings into configuration file. You can add settings object to ESLint configuration file and it will be supplied to every rule that will be executed. This may be useful if you are adding custom rules and want them to have access to the same information and be easily configurable.

overrides?: _#defs."/properties/overrides" ¶

Allows to override configuration for files and folders, specified by glob patterns

#bestPractices: ¶
"accessor-pairs"?: #rule ¶
"array-callback-return"?: #rule ¶
"block-scoped-var"?: #rule ¶
"class-methods-use-this"?: #rule ¶
complexity?: #rule ¶
"consistent-return"?: #rule ¶
curly?: #rule ¶
"default-case"?: #rule ¶
"dot-location"?: #rule ¶
"dot-notation"?: #rule ¶
eqeqeq?: #rule ¶
"guard-for-in"?: #rule ¶
"no-alert"?: #rule ¶
"no-caller"?: #rule ¶
"no-case-declarations"?: #rule ¶
"no-div-regex"?: #rule ¶
"no-else-return"?: #rule ¶
"no-empty-function"?: #rule ¶
"no-empty-pattern"?: #rule ¶
"no-eq-null"?: #rule ¶
"no-eval"?: #rule ¶
"no-extend-native"?: #rule ¶
"no-extra-bind"?: #rule ¶
"no-extra-label"?: #rule ¶
"no-fallthrough"?: #rule ¶
"no-floating-decimal"?: #rule ¶
"no-global-assign"?: #rule ¶
"no-implicit-coercion"?: #rule ¶
"no-implicit-globals"?: #rule ¶
"no-implied-eval"?: #rule ¶
"no-invalid-this"?: #rule ¶
"no-iterator"?: #rule ¶
"no-labels"?: #rule ¶
"no-lone-blocks"?: #rule ¶
"no-loop-func"?: #rule ¶
"no-magic-numbers"?: #rule ¶
"no-multi-spaces"?: #rule ¶
"no-multi-str"?: #rule ¶
"no-native-reassign"?: #rule ¶
"no-new"?: #rule ¶
"no-new-func"?: #rule ¶
"no-new-wrappers"?: #rule ¶
"no-octal"?: #rule ¶
"no-octal-escape"?: #rule ¶
"no-param-reassign"?: #rule ¶
"no-proto"?: #rule ¶
"no-redeclare"?: #rule ¶
"no-restricted-properties"?: #rule ¶
"no-return-assign"?: #rule ¶
"no-return-await"?: #rule ¶
"no-script-url"?: #rule ¶
"no-self-assign"?: #rule ¶
"no-self-compare"?: #rule ¶
"no-sequences"?: #rule ¶
"no-throw-literal"?: #rule ¶
"no-unmodified-loop-condition"?: #rule ¶
"no-unused-expressions"?: #rule ¶
"no-unused-labels"?: #rule ¶
"no-useless-call"?: #rule ¶
"no-useless-concat"?: #rule ¶
"no-useless-escape"?: #rule ¶
"no-useless-return"?: #rule ¶
"no-void"?: #rule ¶
"no-warning-comments"?: #rule ¶
"no-with"?: #rule ¶
"prefer-promise-reject-errors"?: #rule ¶
radix?: #rule ¶
"require-await"?: #rule ¶
"vars-on-top"?: #rule ¶
"wrap-iife"?: #rule ¶
yoda?: #rule ¶
#ecmaScript6: ¶
"arrow-body-style"?: #rule ¶
"arrow-parens"?: #rule ¶
"arrow-spacing"?: #rule ¶
"constructor-super"?: #rule ¶
"generator-star-spacing"?: #rule ¶
"no-class-assign"?: #rule ¶
"no-confusing-arrow"?: #rule ¶
"no-const-assign"?: #rule ¶
"no-dupe-class-members"?: #rule ¶
"no-duplicate-imports"?: #rule ¶
"no-new-symbol"?: #rule ¶
"no-restricted-imports"?: #rule ¶
"no-this-before-super"?: #rule ¶
"no-useless-computed-key"?: #rule ¶
"no-useless-constructor"?: #rule ¶
"no-useless-rename"?: #rule ¶
"no-var"?: #rule ¶
"object-shorthand"?: #rule ¶
"prefer-arrow-callback"?: #rule ¶
"prefer-const"?: #rule ¶
"prefer-destructuring"?: #rule ¶
"prefer-numeric-literals"?: #rule ¶
"prefer-reflect"?: #rule ¶
"prefer-rest-params"?: #rule ¶
"prefer-spread"?: #rule ¶
"prefer-template"?: #rule ¶
"require-yield"?: #rule ¶
"rest-spread-spacing"?: #rule ¶
"sort-imports"?: #rule ¶
"symbol-description"?: #rule ¶
"template-curly-spacing"?: #rule ¶
"yield-star-spacing"?: #rule ¶
#legacy: ¶
"max-depth"?: #rule ¶
"max-len"?: #rule ¶
"max-params"?: #rule ¶
"max-statements"?: #rule ¶
"no-bitwise"?: #rule ¶
"no-plusplus"?: #rule ¶
#nodeAndCommonJs: ¶
"callback-return"?: #rule ¶
"global-require"?: #rule ¶
"handle-callback-err"?: #rule ¶
"no-buffer-constructor"?: #rule ¶
"no-mixed-requires"?: #rule ¶
"no-new-require"?: #rule ¶
"no-path-concat"?: #rule ¶
"no-process-env"?: #rule ¶
"no-process-exit"?: #rule ¶
"no-restricted-modules"?: #rule ¶
"no-sync"?: #rule ¶
#possibleErrors: ¶
"comma-dangle"?: #rule ¶
"for-direction"?: #rule ¶
"getter-return"?: #rule ¶
"no-await-in-loop"?: #rule ¶
"no-compare-neg-zero"?: #rule ¶
"no-cond-assign"?: #rule ¶
"no-console"?: #rule ¶
"no-constant-condition"?: #rule ¶
"no-control-regex"?: #rule ¶
"no-debugger"?: #rule ¶
"no-dupe-args"?: #rule ¶
"no-dupe-keys"?: #rule ¶
"no-duplicate-case"?: #rule ¶
"no-empty"?: #rule ¶
"no-empty-character-class"?: #rule ¶
"no-ex-assign"?: #rule ¶
"no-extra-boolean-cast"?: #rule ¶
"no-extra-parens"?: #rule ¶
"no-extra-semi"?: #rule ¶
"no-func-assign"?: #rule ¶
"no-inner-declarations"?: #rule ¶
"no-invalid-regexp"?: #rule ¶
"no-irregular-whitespace"?: #rule ¶
"no-negated-in-lhs"?: #rule ¶
"no-obj-calls"?: #rule ¶
"no-prototype-builtins"?: #rule ¶
"no-regex-spaces"?: #rule ¶
"no-sparse-arrays"?: #rule ¶
"no-template-curly-in-string"?: #rule ¶
"no-unexpected-multiline"?: #rule ¶
"no-unreachable"?: #rule ¶
"no-unsafe-finally"?: #rule ¶
"no-unsafe-negation"?: #rule ¶
"use-isnan"?: #rule ¶
"valid-jsdoc"?: #rule ¶
"valid-typeof"?: #rule ¶
#rule: matchN(1, [int & >=0 & <=2, "off" | "warn" | "error", [...]]) ¶
#strictMode: ¶
strict?: #rule ¶
#stringOrStringArray: matchN(1, [string, [...string]]) ¶
#stylisticIssues: ¶
"array-bracket-newline"?: #rule ¶
"array-bracket-spacing"?: #rule ¶
"array-element-newline"?: #rule ¶
"block-spacing"?: #rule ¶
"brace-style"?: #rule ¶
camelcase?: #rule ¶
"capitalized-comments"?: #rule ¶
"comma-dangle"?: #rule ¶
"comma-spacing"?: #rule ¶
"comma-style"?: #rule ¶
"computed-property-spacing"?: #rule ¶
"consistent-this"?: #rule ¶
"eol-last"?: #rule ¶
"func-call-spacing"?: #rule ¶
"func-name-matching"?: #rule ¶
"func-names"?: #rule ¶
"func-style"?: #rule ¶
"function-call-argument-newline"?: #rule ¶
"function-paren-newline"?: #rule ¶
"id-blacklist"?: #rule ¶
"id-length"?: #rule ¶
"id-match"?: #rule ¶
"implicit-arrow-linebreak"?: #rule ¶
indent?: #rule ¶
"indent-legacy"?: #rule ¶
"jsx-quotes"?: #rule ¶
"key-spacing"?: #rule ¶
"keyword-spacing"?: #rule ¶
"line-comment-position"?: #rule ¶
"lines-between-class-members"?: #rule ¶
"linebreak-style"?: #rule ¶
"lines-around-comment"?: #rule ¶
"lines-around-directive"?: #rule ¶
"max-depth"?: #rule ¶
"max-len"?: #rule ¶
"max-lines"?: #rule ¶
"max-nested-callbacks"?: #rule ¶
"max-params"?: #rule ¶
"max-statements"?: #rule ¶
"max-statements-per-line"?: #rule ¶
"multiline-comment-style"?: #rule ¶
"multiline-ternary"?: #rule ¶
"new-cap"?: #rule ¶
"newline-after-var"?: #rule ¶
"newline-before-return"?: #rule ¶
"newline-per-chained-call"?: #rule ¶
"new-parens"?: #rule ¶
"no-array-constructor"?: #rule ¶
"no-bitwise"?: #rule ¶
"no-continue"?: #rule ¶
"no-inline-comments"?: #rule ¶
"no-lonely-if"?: #rule ¶
"no-mixed-operators"?: #rule ¶
"no-mixed-spaces-and-tabs"?: #rule ¶
"no-multi-assign"?: #rule ¶
"no-multiple-empty-lines"?: #rule ¶
"no-negated-condition"?: #rule ¶
"no-nested-ternary"?: #rule ¶
"no-new-object"?: #rule ¶
"no-plusplus"?: #rule ¶
"no-restricted-syntax"?: #rule ¶
"no-spaced-func"?: #rule ¶
"no-tabs"?: #rule ¶
"no-ternary"?: #rule ¶
"no-trailing-spaces"?: #rule ¶
"no-underscore-dangle"?: #rule ¶
"no-unneeded-ternary"?: #rule ¶
"no-whitespace-before-property"?: #rule ¶
"nonblock-statement-body-position"?: #rule ¶
"object-curly-newline"?: #rule ¶
"object-curly-spacing"?: #rule ¶
"object-property-newline"?: #rule ¶
"object-shorthand"?: #rule ¶
"one-var"?: #rule ¶
"one-var-declaration-per-line"?: #rule ¶
"operator-assignment"?: #rule ¶
"operator-linebreak"?: #rule ¶
"padded-blocks"?: #rule ¶
"padding-line-between-statements"?: #rule ¶
"quote-props"?: #rule ¶
quotes?: #rule ¶
"require-jsdoc"?: #rule ¶
semi?: #rule ¶
"semi-spacing"?: #rule ¶
"semi-style"?: #rule ¶
"sort-keys"?: #rule ¶
"sort-vars"?: #rule ¶
"space-before-blocks"?: #rule ¶
"space-before-function-paren"?: #rule ¶
"spaced-comment"?: #rule ¶
"space-infix-ops"?: #rule ¶
"space-in-parens"?: #rule ¶
"space-unary-ops"?: #rule ¶
"switch-colon-spacing"?: #rule ¶
"template-tag-spacing"?: #rule ¶
"unicode-bom"?: #rule ¶
"wrap-regex"?: #rule ¶
#variables: ¶
"init-declarations"?: #rule ¶
"no-catch-shadow"?: #rule ¶
"no-delete-var"?: #rule ¶
"no-label-var"?: #rule ¶
"no-restricted-globals"?: #rule ¶
"no-shadow"?: #rule ¶
"no-shadow-restricted-names"?: #rule ¶
"no-undef"?: #rule ¶
"no-undefined"?: #rule ¶
"no-undef-init"?: #rule ¶
"no-unused-vars"?: #rule ¶
"no-use-before-define"?: #rule ¶
prettier?: prettier.#Schema ¶
#optionsDefinition: ¶
arrowParens?: matchN(1, ["always", "avoid"]) ¶

Include parentheses around a sole arrow function parameter.

bracketSameLine?: bool ¶

Put > of opening tags on the last line instead of on a new line.

bracketSpacing?: bool ¶

Print spaces between brackets.

checkIgnorePragma?: bool ¶

Check whether the file's first docblock comment contains '@noprettier' or '@noformat' to determine if it should be formatted.

cursorOffset?: int ¶

Print (to stderr) where a cursor at the given position would move to after formatting.

embeddedLanguageFormatting?: matchN(1, ["auto", "off"]) ¶

Control how Prettier formats quoted code embedded in the file.

endOfLine?: matchN(1, ["lf", "crlf", "cr", "auto"]) ¶

Which end of line characters to apply.

experimentalOperatorPosition?: matchN(1, ["start", "end"]) ¶

Where to print operators when binary expressions wrap lines.

experimentalTernaries?: bool ¶

Use curious ternaries, with the question mark after the condition.

filepath?: string ¶

Specify the input filepath. This will be used to do parser inference.

htmlWhitespaceSensitivity?: matchN(1, ["css", "strict", "ignore"]) ¶

How to handle whitespaces in HTML.

insertPragma?: bool ¶

Insert @format pragma into file's first docblock comment.

jsxSingleQuote?: bool ¶

Use single quotes in JSX.

objectWrap?: matchN(1, ["preserve", "collapse"]) ¶

How to wrap object literals.

parser?:
click to see definition
matchN(>=1, ["flow", "babel", "babel-flow", "babel-ts", "typescript", "acorn", "espree", "meriyah", "css", "less", "scss", "json", "json5", "jsonc", "json-stringify", "graphql", "markdown", "mdx", "vue", "yaml", "glimmer", "html", "angular", "lwc", "mjml", string])
¶

Which parser to use.

plugins?: [...string] ¶

Add a plugin. Multiple plugins can be passed as separate `--plugin`s.

printWidth?: int ¶

The line length where Prettier will try wrap.

proseWrap?: matchN(1, ["always", "never", "preserve"]) ¶

How to wrap prose.

quoteProps?: matchN(1, ["as-needed", "consistent", "preserve"]) ¶

Change when properties in objects are quoted.

rangeEnd?: int ¶

Format code ending at a given character offset (exclusive). The range will extend forwards to the end of the selected statement.

rangeStart?: int ¶

Format code starting at a given character offset. The range will extend backwards to the start of the first line containing the selected statement.

requirePragma?: bool ¶

Require either '@prettier' or '@format' to be present in the file's first docblock comment in order for it to be formatted.

semi?: bool ¶

Print semicolons.

singleAttributePerLine?: bool ¶

Enforce single attribute per line in HTML, Vue and JSX.

singleQuote?: bool ¶

Use single quotes instead of double quotes.

tabWidth?: int ¶

Number of spaces per indentation level.

trailingComma?: matchN(1, ["all", "es5", "none"]) ¶

Print trailing commas wherever possible when multi-line.

useTabs?: bool ¶

Indent with tabs instead of spaces.

vueIndentScriptAndStyle?: bool ¶

Indent script and style tags in Vue files.

#overridesDefinition: ¶
overrides?:
click to see definition
[...close({
	files!: matchN(1, [string, [...string]])
	excludeFiles?: matchN(1, [string, [...string]])
	options?: #optionsDefinition
})]
¶

Provide a list of patterns to override prettier configuration.

stylelint?: ¶
extends?: #simpleStringOrArrayStringRule ¶
plugins?: #simpleArrayStringRule ¶
customSyntax?: string ¶

Specify a custom syntax to use on your code.

overrides?:
click to see definition
[...{
	files?: [...string]
	customSyntax?: string
	rules?:        #allRules
	...
}]
¶

Provide rule and behavior overrides for files that match particular glob patterns.

processors?: [...matchN(>=1, [string, [string, ...{ ... }]])] ¶

Processors are functions that hook into stylelint's pipeline, modifying code on its way into stylelint and modifying results on their way out

ignoreDisables?: bool ¶

Ignore stylelint-disable (e.g. /* stylelint-disable block-no-empty */) comments.

ignoreFiles?: #simpleStringOrArrayStringRule ¶
defaultSeverity?: "warning" | "error" ¶

The default severity level for all rules that do not have a severity specified in their secondary options

reportDescriptionlessDisables?: #booleanRule ¶
reportInvalidScopeDisables?: #booleanRule ¶
reportNeedlessDisables?: #booleanRule ¶
rules?: #allRules ¶
#allRules:
click to see definition
matchN(30, [#atRule & {
	...
}, #block & {
	...
}, #color & {
	...
}, #comment & {
	...
}, #customMedia & {
	...
}, #customProperty & {
	...
}, #declaration & {
	...
}, #declarationBlock & {
	...
}, #font & {
	...
}, #function & {
	...
}, #generalSheet & {
	...
}, #keyframeDeclaration & {
	...
}, #length & {
	...
}, #lightness & {
	...
}, #mediaFeature & {
	...
}, #mediaQuery & {
	...
}, #mediaQueryList & {
	...
}, #number & {
	...
}, #property & {
	...
}, #rootRule & {
	...
}, #rule & {
	...
}, #selector & {
	...
}, #selectorList & {
	...
}, #shorthandProperty & {
	...
}, #string & {
	...
}, #stylelintDisableComment & {
	...
}, #time & {
	...
}, #unit & {
	...
}, #value & {
	...
}, #valueList & {
	...
}])
¶
#alwaysMultiLineRule:
click to see definition
matchN(1, [null, "always" | "always-multi-line", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["always" | "always-multi-line", #coreRule & (string | {
	...
})])]])
¶
#alwaysNeverRule:
click to see definition
matchN(1, [null, "always" | "never", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["always" | "never", #coreRule & (string | {
	...
})])]])
¶
#arrayStringRule:
click to see definition
matchN(1, [null | string, list.UniqueItems() & [_, ...] & [...matchN(>=1, [#simpleArrayStringRule & (string | [...] | {
	...
}), #coreRule & (string | [...] | {
	...
})])]])
¶
#atRule:
click to see definition
null | bool | number | string | [...] | {
	"at-rule-blacklist"?: #arrayStringRule
	"at-rule-empty-line-before"?: matchN(1, [null, "always" | "never", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["always" | "never", #coreRule & {
		...
	} & {
		except?: list.UniqueItems() & [_, ...] & [..."all-nested" | "after-same-name" | "inside-block" | "blockless-after-same-name-blockless" | "blockless-after-blockless" | "first-nested"]
		ignore?: list.UniqueItems() & [_, ...] & [..."after-comment" | "first-nested" | "inside-block" | "blockless-after-same-name-blockless" | "blockless-after-blockless"]
		ignoreAtRules?: #simpleStringOrArrayStringRule
		...
	}])]])
	"at-rule-name-case"?:          #lowerUpperRule
	"at-rule-name-newline-after"?: #alwaysMultiLineRule
	"at-rule-name-space-after"?: matchN(1, [null, "always" | "always-single-line", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["always" | "always-single-line", #coreRule & (string | {
		...
	})])]])
	"at-rule-no-unknown"?: matchN(1, [null, true, list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, [true, #coreRule & {
		...
	} & {
		ignoreAtRules?: #simpleArrayStringRule
		...
	}])]])
	"at-rule-no-vendor-prefix"?: #booleanRule
	"at-rule-semicolon-newline-after"?: matchN(1, [null, "always", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["always", #coreRule & (string | {
		...
	})])]])
	"at-rule-semicolon-space-before"?: _
	"at-rule-whitelist"?:              #arrayStringRule
	...
}
¶
#block:
click to see definition
null | bool | number | string | [...] | {
	"block-closing-brace-empty-line-before"?: matchN(1, [null, "always-multi-line" | "never", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["always-multi-line" | "never", #coreRule & (string | {
		...
	})])]])
	"block-closing-brace-newline-after"?:  #newlineSpaceWithIgnoreRule
	"block-closing-brace-newline-before"?: #newlineRule
	"block-closing-brace-space-after"?:    #newlineSpaceRule
	"block-closing-brace-space-before"?:   #newlineSpaceRule
	"block-no-empty"?:                     #booleanRule
	"block-no-single-line"?:               #booleanRule
	"block-opening-brace-newline-after"?:  #newlineRule
	"block-opening-brace-newline-before"?: matchN(1, [null, "always" | "always-single-line" | "never-single-line" | "always-multi-line" | "never-multi-line", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["always" | "always-single-line" | "never-single-line" | "always-multi-line" | "never-multi-line", #coreRule & (string | {
		...
	})])]])
	"block-opening-brace-space-after"?:  #newlineSpaceRule
	"block-opening-brace-space-before"?: #newlineSpaceWithIgnoreRule
	...
}
¶
#booleanRule:
click to see definition
matchN(1, [null, bool, list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, [bool, #coreRule & (bool | {
	...
})])]])
¶
#color:
click to see definition
null | bool | number | string | [...] | {
	"color-hex-case"?: #lowerUpperRule
	"color-hex-length"?: matchN(1, [null, "short" | "long", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["short" | "long", #coreRule & (string | {
		...
	})])]])
	"color-named"?: matchN(1, [null, "always-where-possible" | "never", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["always-where-possible" | "never", #coreRule & {
		...
	} & {
		ignore?: #simpleArrayStringRule
		...
	}])]])
	"color-no-hex"?:         #booleanRule
	"color-no-invalid-hex"?: #booleanRule
	...
}
¶
#comment:
click to see definition
null | bool | number | string | [...] | {
	"comment-empty-line-before"?: matchN(1, [null, "always" | "never", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["always" | "never", #coreRule & {
		...
	} & {
		except?: list.UniqueItems() & [_, ...] & [..."first-nested"]
		ignore?: list.UniqueItems() & [_, ...] & [..."between-comments" | "after-comment" | "stylelint-command" | "stylelint-commands"]
		...
	}])]])
	"comment-no-empty"?:          #booleanRule
	"comment-whitespace-inside"?: #alwaysNeverRule
	"comment-word-blacklist"?:    #arrayStringRule
	...
}
¶
#coreRule: ¶
disableFix?: bool ¶
message?: string ¶

Custom message that will be used in errors and warnings

reportDisables?: bool ¶
severity?: "warning" | "error" ¶

Message status

url?: net.AbsURL ¶
#customMedia:
click to see definition
null | bool | number | string | [...] | {
	"custom-media-pattern"?: #stringRule
	"no-unknown-custom-media"?: matchN(1, [matchN(1, [true, null]), list.MaxItems(2) & [_, ...] & [matchN(1, [true, null]), #coreRule, ...]])
	...
}
¶
#customProperty:
click to see definition
null | bool | number | string | [...] | {
	"custom-property-empty-line-before"?: matchN(1, [null, "always" | "never", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["always" | "never", #coreRule & {
		...
	} & {
		except?: list.UniqueItems() & [_, ...] & [..."after-comment" | "after-custom-property" | "first-nested"]
		ignore?: list.UniqueItems() & [_, ...] & [..."after-comment" | "inside-single-line-block"]
		...
	}])]])
	"custom-property-no-outside-root"?: #booleanRule
	"custom-property-pattern"?:         #stringRule
	"no-unknown-custom-properties"?: matchN(1, [matchN(1, [true, null]), list.MaxItems(2) & [_, ...] & [matchN(1, [true, null]), #coreRule, ...]])
	...
}
¶
#declaration:
click to see definition
null | bool | number | string | [...] | {
	"declaration-bang-space-after"?:    #alwaysNeverRule
	"declaration-bang-space-before"?:   #alwaysNeverRule
	"declaration-colon-newline-after"?: #alwaysMultiLineRule
	"declaration-colon-space-after"?: matchN(1, [null, "always" | "never" | "always-single-line", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["always" | "never" | "always-single-line", #coreRule & (string | {
		...
	})])]])
	"declaration-colon-space-before"?: #alwaysNeverRule
	"declaration-empty-line-before"?: matchN(1, [null, "always" | "never", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["always" | "never", #coreRule & {
		...
	} & {
		except?: list.UniqueItems() & [_, ...] & [..."after-comment" | "after-declaration" | "first-nested"]
		ignore?: list.UniqueItems() & [_, ...] & [..."after-comment" | "after-declaration" | "first-nested" | "inside-single-line-block"]
		...
	}])]])
	"declaration-no-important"?:             #booleanRule
	"declaration-property-unit-blacklist"?:  #objectRule
	"declaration-property-unit-whitelist"?:  #objectRule
	"declaration-property-value-blacklist"?: #objectRule
	"declaration-property-value-no-unknown"?: matchN(1, [matchN(1, [true, null]), list.MaxItems(2) & [_, ...] & [matchN(1, [true, null]), #coreRule & {
		...
	} & {
		ignoreProperties?: {
			[string]: matchN(>=1, [matchN(1, [string, [...string]]), matchN(1, [matchN(1, [{
				...
			}, =~"^\\/.+\\/i?$"]), [...matchN(>=1, [{
				...
			}, =~"^\\/.+\\/i?$"])]])])
		}
		propertiesSyntax?: {
			[string]: matchN(1, [string, [...string]])
		}
		typesSyntax?: {
			[string]: matchN(1, [string, [...string]])
		}
		...
	}, ...]])
	"declaration-property-value-whitelist"?: #objectRule
	...
}
¶
#declarationBlock:
click to see definition
null | bool | number | string | [...] | {
	"declaration-block-no-duplicate-properties"?: matchN(1, [null, true, list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, [true, #coreRule & {
		...
	} & {
		ignore?: list.UniqueItems() & [_, ...] & [..."consecutive-duplicates" | "consecutive-duplicates-with-different-values" | "consecutive-duplicates-with-different-syntaxes" | "consecutive-duplicates-with-same-prefixless-values"]
		ignoreProperties?: #simpleArrayStringRule
		...
	}])]])
	"declaration-block-no-ignored-properties"?: #booleanRule
	"declaration-block-no-redundant-longhand-properties"?: matchN(1, [null, true, list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, [true, #coreRule & {
		...
	} & {
		ignoreShorthands?: #simpleArrayStringRule
		...
	}])]])
	"declaration-block-no-shorthand-property-overrides"?: #booleanRule
	"declaration-block-properties-order"?: matchN(1, [null, "alphabetical", list.UniqueItems() & [_, ...] & [...matchN(>=1, ["alphabetical", string, #simpleArrayStringRule & (string | [...] | {
		...
	}), #coreRule & {
		...
	} & {
		order?: _
		if order != _|_ // explicit error (_|_ literal) in source
		{
			properties!: _
		}
		properties?: _
		if properties != _|_ // explicit error (_|_ literal) in source
		{
			order!: _
		}
		{}
		unspecified?: "top" | "bottom" | "bottomAlphabetical" | "ignore"
		order?:       "strict" | "flexible"
		properties?:  #simpleArrayStringRule
		...
	}])]])
	"declaration-block-semicolon-newline-after"?:      #newlineRule
	"declaration-block-semicolon-newline-before"?:     #newlineRule
	"declaration-block-semicolon-space-after"?:        #spaceRule
	"declaration-block-semicolon-space-before"?:       #spaceRule
	"declaration-block-single-line-max-declarations"?: #integerRule
	"declaration-block-trailing-semicolon"?:           #alwaysNeverRule
	...
}
¶
#font:
click to see definition
null | bool | number | string | [...] | {
	"font-family-name-quotes"?: matchN(1, [null, "always-where-required" | "always-where-recommended" | "always-unless-keyword", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["always-where-required" | "always-where-recommended" | "always-unless-keyword", #coreRule & (string | {
		...
	})])]])
	"font-weight-notation"?: matchN(1, [null, "numeric" | "named-where-possible", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["numeric" | "named-where-possible", #coreRule & {
		...
	} & {
		ignore?: list.UniqueItems() & [_, ...] & [..."relative"]
		...
	}])]])
	...
}
¶
#function:
click to see definition
null | bool | number | string | [...] | {
	"function-blacklist"?:                                #arrayStringRule
	"function-calc-no-unspaced-operator"?:                #booleanRule
	"function-comma-newline-after"?:                      #newlineRule
	"function-comma-newline-before"?:                     #newlineRule
	"function-comma-space-after"?:                        #spaceRule
	"function-comma-space-before"?:                       #spaceRule
	"function-linear-gradient-no-nonstandard-direction"?: #booleanRule
	"function-max-empty-lines"?:                          #integerRule
	"function-name-case"?: matchN(1, [null, "lower" | "upper", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["lower" | "upper", #coreRule & {
		...
	} & {
		ignoreFunctions?: #simpleArrayStringRule
		...
	}])]])
	"function-parentheses-newline-inside"?: #newlineRule
	"function-parentheses-space-inside"?:   #spaceRule
	"function-url-data-uris"?:              #alwaysNeverRule
	"function-url-no-scheme-relative"?:     #booleanRule
	"function-url-quotes"?:                 #alwaysNeverRule
	"function-url-scheme-whitelist"?:       #arrayStringRule
	"function-whitelist"?:                  #arrayStringRule
	"function-whitespace-after"?:           #alwaysNeverRule
	...
}
¶
#generalSheet:
click to see definition
null | bool | number | string | [...] | {
	indentation?: matchN(1, [null | int, "tab", list.UniqueItems() & [_, ...] & [...int], list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, [int, "tab", #coreRule & {
		...
	} & {
		indentInsideParens?: "twice" | "once-at-root-twice-in-block"
		except?: list.UniqueItems() & [_, ...] & [..."block" | "param" | "value"]
		ignore?: list.UniqueItems() & [_, ...] & [..."inside-parens" | "param" | "value"]
		...
	}]) & (int | string | {
		...
	})]]) & (null | int | string | [...])
	linebreaks?:        _
	"max-empty-lines"?: #integerRule
	"max-line-length"?: matchN(1, [null | int, list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, [int, #coreRule & {
		...
	} & {
		ignore?: matchN(>=1, ["non-comments" | "comments", list.UniqueItems() & [_, ...] & [..."non-comments" | "comments"]])
		...
	}]) & (int | {
		...
	})]]) & (null | int | [...])
	"max-nesting-depth"?: matchN(1, [null | int, list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, [int, #coreRule & {
		...
	} & {
		ignore?: list.UniqueItems() & [_, ...] & [..."at-rules-without-declaration-blocks" | "blockless-at-rules" | "pseudo-classes"]
		ignoreAtRules?: #simpleArrayStringRule
		...
	}]) & (int | {
		...
	})]]) & (null | int | [...])
	"no-browser-hacks"?: matchN(1, [null, true, list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, [true, #coreRule & {
		...
	} & {
		browsers?: #simpleStringOrArrayStringRule
		...
	}])]])
	"no-descending-specificity"?: #booleanRule
	"no-duplicate-selectors"?:    #booleanRule
	"no-empty-first-line"?:       _
	"no-empty-source"?:           #booleanRule
	"no-eol-whitespace"?: matchN(1, [null, true, list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, [true, #coreRule & {
		...
	} & {
		ignore?: list.UniqueItems() & [_, ...] & [..."empty-lines"]
		...
	}])]])
	"no-extra-semicolons"?: #booleanRule
	"no-indistinguishable-colors"?: matchN(1, [null, true, list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, [true, #coreRule & {
		...
	} & {
		threshold?: int & >=0 & <=100
		ignore?:    #simpleArrayStringRule
		whitelist?: list.UniqueItems() & [_, ...] & [...#simpleArrayStringRule]
		...
	}])]])
	"no-invalid-double-slash-comments"?: #booleanRule
	"no-missing-end-of-source-newline"?: #booleanRule
	"no-unknown-animations"?:            #booleanRule
	"unicode-bom"?:                      #alwaysNeverRule
	"no-unsupported-browser-features"?: matchN(1, [null, true, list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, [true, #coreRule & {
		...
	} & {
		browsers?: string
		ignore?:   #simpleStringOrArrayStringRule
		...
	}])]])
	...
}
¶
#integerRule:
click to see definition
matchN(1, [null | int, list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...#coreRule & (number | {
	...
}) & (int | {
	...
})]]) & (null | int | [...])
¶
#keyframeDeclaration: null | bool | number | string | [...] | { "keyframe-declaration-no-important"?: #booleanRule ... } ¶
#length: null | bool | number | string | [...] | { "length-zero-no-unit"?: #booleanRule ... } ¶
#lightness:
click to see definition
null | bool | number | string | [...] | {
	"lightness-notation"?: matchN(1, [matchN(1, ["percentage" | "number", null]), list.MaxItems(2) & [_, ...] & [matchN(1, ["percentage" | "number", null]), #coreRule, ...]])
	...
}
¶
#lowerUpperRule:
click to see definition
matchN(1, [null, "lower" | "upper", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["lower" | "upper", #coreRule & (string | {
	...
})])]])
¶
#mediaFeature:
click to see definition
null | bool | number | string | [...] | {
	"media-feature-colon-space-after"?:  #alwaysNeverRule
	"media-feature-colon-space-before"?: #alwaysNeverRule
	"media-feature-name-case"?:          #lowerUpperRule
	"media-feature-name-no-unknown"?: matchN(1, [null, true, list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, [true, #coreRule & {
		...
	} & {
		ignoreMediaFeatureNames?: #simpleArrayStringRule
		...
	}])]])
	"media-feature-name-value-no-unknown"?: matchN(1, [matchN(1, [true, null]), list.MaxItems(2) & [_, ...] & [matchN(1, [true, null]), #coreRule, ...]])
	"media-feature-name-no-vendor-prefix"?: #booleanRule
	"media-feature-name-unit-allowed-list"?: matchN(1, [matchN(1, [{
		[string]: matchN(1, [string, [...string]])
	}, null]), list.MaxItems(2) & [_, ...] & [matchN(1, [{
		[string]: matchN(1, [string, [...string]])
	}, null]), #coreRule, ...]])
	"media-feature-no-missing-punctuation"?:   #booleanRule
	"media-feature-parentheses-space-inside"?: #alwaysNeverRule
	"media-feature-range-notation"?: matchN(1, [matchN(1, ["prefix" | "context", null]), list.MaxItems(2) & [_, ...] & [matchN(1, ["prefix" | "context", null]), #coreRule, ...]])
	"media-feature-range-operator-space-after"?:  #alwaysNeverRule
	"media-feature-range-operator-space-before"?: #alwaysNeverRule
	...
}
¶
#mediaQuery:
click to see definition
null | bool | number | string | [...] | {
	"media-query-no-invalid"?: matchN(1, [matchN(1, [true, null]), list.MaxItems(2) & [_, ...] & [matchN(1, [true, null]), #coreRule, ...]])
	...
}
¶
#mediaQueryList:
click to see definition
null | bool | number | string | [...] | {
	"media-query-list-comma-newline-after"?:  #newlineRule
	"media-query-list-comma-newline-before"?: #newlineRule
	"media-query-list-comma-space-after"?:    #spaceRule
	"media-query-list-comma-space-before"?:   #spaceRule
	...
}
¶
#newlineRule:
click to see definition
matchN(1, [null, "always" | "always-multi-line" | "never-multi-line", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["always" | "always-multi-line" | "never-multi-line", #coreRule & (string | {
	...
})])]])
¶
#newlineSpaceRule:
click to see definition
matchN(1, [null, "always" | "never" | "always-single-line" | "never-single-line" | "always-multi-line" | "never-multi-line", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["always" | "never" | "always-single-line" | "never-single-line" | "always-multi-line" | "never-multi-line", #coreRule & (string | {
	...
})])]])
¶
#newlineSpaceWithIgnoreRule:
click to see definition
matchN(1, [null, "always" | "never" | "always-single-line" | "never-single-line" | "always-multi-line" | "never-multi-line", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["always" | "always-single-line" | "never-single-line" | "always-multi-line" | "never-multi-line", #coreRule & {
	...
} & {
	ignoreAtRules?: #simpleStringOrArrayStringRule
	...
}])]])
¶
#number:
click to see definition
null | bool | number | string | [...] | {
	"number-leading-zero"?:      #alwaysNeverRule
	"number-max-precision"?:     #integerRule
	"number-no-trailing-zeros"?: #booleanRule
	...
}
¶
#objectRule:
click to see definition
matchN(1, [null, {
	[string]: #simpleStringOrArrayStringRule
}, list.MaxItems(2) & [_, _, ...] & [{
	[string]: #simpleStringOrArrayStringRule
}, #coreRule, ...]])
¶
#property:
click to see definition
null | bool | number | string | [...] | {
	"property-blacklist"?: #arrayStringRule
	"property-case"?:      #lowerUpperRule
	"property-no-unknown"?: matchN(1, [null, true, list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, [true, #coreRule & {
		...
	} & {
		ignoreProperties?: #simpleArrayStringRule
		checkPrefixed?:    bool
		...
	}])]])
	"property-no-vendor-prefix"?: #booleanRule
	"property-whitelist"?:        #arrayStringRule
	...
}
¶
#rootRule: null | bool | number | string | [...] | { "root-no-standard-properties"?: #booleanRule ... } ¶
#rule:
click to see definition
null | bool | number | string | [...] | {
	"rule-nested-empty-line-before"?: matchN(1, [null, "always" | "never" | "always-multi-line" | "never-multi-line", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["always" | "never" | "always-multi-line" | "never-multi-line", #coreRule & {
		...
	} & {
		except?: list.UniqueItems() & [_, ...] & [..."first-nested"]
		ignore?: list.UniqueItems() & [_, ...] & [..."after-comment"]
		...
	}])]])
	"rule-non-nested-empty-line-before"?: matchN(1, [null, "always" | "never" | "always-multi-line" | "never-multi-line", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["always" | "never" | "always-multi-line" | "never-multi-line", #coreRule & {
		...
	} & {
		except?: list.UniqueItems() & [_, ...] & [..."after-single-line-comment"]
		ignore?: list.UniqueItems() & [_, ...] & [..."after-comment"]
		...
	}])]])
	...
}
¶
#selector:
click to see definition
null | bool | number | string | [...] | {
	"selector-anb-no-unmatchable"?: matchN(1, [matchN(1, [true, null]), list.MaxItems(2) & [_, ...] & [matchN(1, [true, null]), #coreRule, ...]])
	"selector-attribute-brackets-space-inside"?: #alwaysNeverRule
	"selector-attribute-operator-blacklist"?:    #arrayStringRule
	"selector-attribute-operator-space-after"?:  #alwaysNeverRule
	"selector-attribute-operator-space-before"?: #alwaysNeverRule
	"selector-attribute-operator-whitelist"?:    #arrayStringRule
	"selector-attribute-quotes"?:                #alwaysNeverRule
	"selector-class-pattern"?: matchN(1, [null | string, list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, [string, #coreRule & {
		...
	} & {
		resolveNestedSelectors?: bool
		...
	}])]])
	"selector-combinator-space-after"?:             #alwaysNeverRule
	"selector-combinator-space-before"?:            #alwaysNeverRule
	"selector-descendant-combinator-no-non-space"?: #booleanRule
	"selector-id-pattern"?:                         #stringRule
	"selector-max-compound-selectors"?:             #integerRule
	"selector-max-specificity"?:                    #stringRule
	"selector-nested-pattern"?:                     #stringRule
	"selector-no-attribute"?:                       #booleanRule
	"selector-no-combinator"?:                      #booleanRule
	"selector-no-id"?:                              #booleanRule
	"selector-no-qualifying-type"?: matchN(1, [null, true, list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, [true, #coreRule & {
		...
	} & {
		ignore?: list.UniqueItems() & [_, ...] & [..."attribute" | "class" | "id"]
		...
	}])]])
	"selector-no-type"?: matchN(1, [null, true, list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, [true, #coreRule & {
		...
	} & {
		ignore?: list.UniqueItems() & [_, ...] & [..."compounded" | "descendant"]
		ignoreTypes?: #simpleArrayStringRule
		...
	}])]])
	"selector-no-universal"?:      #booleanRule
	"selector-no-vendor-prefix"?:  #booleanRule
	"selector-pseudo-class-case"?: #lowerUpperRule
	"selector-pseudo-class-no-unknown"?: matchN(1, [null, true, list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, [true, #coreRule & {
		...
	} & {
		ignorePseudoClasses?: #simpleArrayStringRule
		...
	}])]])
	"selector-pseudo-class-parentheses-space-inside"?: #alwaysNeverRule
	"selector-pseudo-class-whitelist"?:                #arrayStringRule
	"selector-pseudo-element-case"?:                   #lowerUpperRule
	"selector-pseudo-element-colon-notation"?:         #singleDoubleRule
	"selector-pseudo-element-no-unknown"?: matchN(1, [null, true, list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, [true, #coreRule & {
		...
	} & {
		ignorePseudoElements?: #simpleArrayStringRule
		...
	}])]])
	"selector-root-no-composition"?: #booleanRule
	"selector-type-case"?:           #lowerUpperRule
	"selector-type-no-unknown"?: matchN(1, [null, true, list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, [true, #coreRule & {
		...
	} & {
		ignoreTypes?: #simpleArrayStringRule
		...
	}])]])
	"selector-max-empty-lines"?: #integerRule
	...
}
¶
#selectorList:
click to see definition
null | bool | number | string | [...] | {
	"selector-list-comma-newline-after"?:  #newlineRule
	"selector-list-comma-newline-before"?: #newlineRule
	"selector-list-comma-space-after"?:    #spaceRule
	"selector-list-comma-space-before"?:   #spaceRule
	...
}
¶
#shorthandProperty: null | bool | number | string | [...] | { "shorthand-property-no-redundant-values"?: #booleanRule ... } ¶
#simpleArrayStringRule: list.UniqueItems() & [...string] ¶
#simpleStringOrArrayStringRule: matchN(1, [string, #simpleArrayStringRule & (string | [...])]) ¶
#singleDoubleRule:
click to see definition
matchN(1, [null, "single" | "double", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["single" | "double", #coreRule & (string | {
	...
})])]])
¶
#spaceRule:
click to see definition
matchN(1, [null, "always" | "never" | "always-single-line" | "never-single-line", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["always" | "never" | "always-single-line" | "never-single-line", #coreRule & (string | {
	...
})])]])
¶
#string:
click to see definition
null | bool | number | string | [...] | {
	"string-no-newline"?: #booleanRule
	"string-quotes"?:     #singleDoubleRule
	...
}
¶
#stringRule:
click to see definition
matchN(1, [null | string, list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, [string, #coreRule & (string | {
	...
})])]])
¶
#stylelintDisableComment:
click to see definition
null | bool | number | string | [...] | {
	"stylelint-disable-reason"?: matchN(1, [null, "always-before" | "always-after", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["always-before" | "always-after", #coreRule & (string | {
		...
	})])]])
	...
}
¶
#time: null | bool | number | string | [...] | { "time-no-imperceptible"?: #booleanRule ... } ¶
#unit:
click to see definition
null | bool | number | string | [...] | {
	"unit-blacklist"?: #unitRule
	"unit-case"?:      #lowerUpperRule
	"unit-no-unknown"?: matchN(1, [null, true, list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, [true, #coreRule & {
		...
	} & {
		ignoreUnits?: #simpleArrayStringRule
		...
	}])]])
	"unit-whitelist"?: #unitRule
	...
}
¶
#unitRule:
click to see definition
matchN(1, [null, "em" | "ex" | "px" | "%" | "rem" | "vw" | "vh" | "vm" | "vmin" | "vmax" | "ch" | "in" | "cm" | "mm" | "q" | "pt" | "pc" | "deg" | "grad" | "rad" | "turn" | "ms" | "s" | "Hz" | "kHz" | "dpi" | "dpcm" | "dppx" | "fr", list.UniqueItems() & [_, ...] & [...matchN(>=1, ["em" | "ex" | "px" | "%" | "rem" | "vw" | "vh" | "vm" | "vmin" | "vmax" | "ch" | "in" | "cm" | "mm" | "q" | "pt" | "pc" | "deg" | "grad" | "rad" | "turn" | "ms" | "s" | "Hz" | "kHz" | "dpi" | "dpcm" | "dppx" | "fr", list.UniqueItems() & [_, ...] & [..."em" | "ex" | "px" | "%" | "rem" | "vw" | "vh" | "vm" | "vmin" | "vmax" | "ch" | "in" | "cm" | "mm" | "q" | "pt" | "pc" | "deg" | "grad" | "rad" | "turn" | "ms" | "s" | "Hz" | "kHz" | "dpi" | "dpcm" | "dppx" | "fr"], #coreRule & {
	...
} & {
	ignoreProperties?: {
		{
			[=~"(em|ex|ch|vw|vh|cm|mm|in|pt|pc|px|rem|vmin|vmax|%)"]: #simpleArrayStringRule
		}
		...
	}
	...
}])]])
¶
#value:
click to see definition
null | bool | number | string | [...] | {
	"value-keyword-case"?: matchN(1, [null, "lower" | "upper", list.MaxItems(2) & list.UniqueItems() & [_, _, ...] & [...matchN(>=1, ["lower" | "upper", #coreRule & {
		...
	} & {
		ignoreKeywords?: #simpleArrayStringRule
		...
	}])]])
	"value-no-vendor-prefix"?: #booleanRule
	...
}
¶
#valueList:
click to see definition
null | bool | number | string | [...] | {
	"value-list-comma-newline-after"?:  #newlineRule
	"value-list-comma-newline-before"?: #newlineRule
	"value-list-comma-space-after"?:    #spaceRule
	"value-list-comma-space-before"?:   #spaceRule
	"value-list-max-empty-lines"?:      #integerRule
	...
}
¶
ava?: ¶
files?: #."array-of-paths" ¶
ignoredByWatcher?: #."array-of-paths" ¶
match?: #."array-of-paths" ¶
cache?: bool ¶

Defaults to `true` to cache compiled files under `node_modules/.cache/ava.` If `false`, files are cached in a temporary directory instead

concurrency?: number ¶

Max number of test files running at the same time (default: CPU cores)

workerThreads?: bool ¶

Use worker threads to run tests (enabled by default). If `false`, tests will run in child processes

failFast?: bool ¶

Stop running further tests once a test fails

failWithoutAssertions?: bool ¶

If `false`, does not fail a test if it doesn't run assertions

environmentVariables?: [string]: string ¶

environment variables

Specifies environment variables to be made available to the tests. The environment variables defined here override the ones from `process.env`

serial?: bool ¶

if `true`, prevents parallel execution of tests within a file

tap?: bool ¶

If `true`, enables the TAP reporter

verbose?: bool ¶

If `true`, enables verbose output (though currently non-verbose output is not supported)

snapshotDir?: #path ¶
extensions?:
click to see definition
matchN(>=1, [#."array-of-strings", {
	{
		[=~"^(c|m)?js$"]: true
	}
	{
		[!~"^(c|m)?js$" & !~"^()$"]: "commonjs" | "module"
	}
}])
¶

Extensions of test files. Setting this overrides the default `["cjs", "mjs", "js"]` value, so make sure to include those extensions in the list. Experimentally you can configure how files are loaded

require?: #."array-of-paths" ¶
timeout?: matchN(>=1, [>=0, =~"^(\\d+)(s|m)$"]) ¶

Timeouts in AVA behave differently than in other test frameworks. AVA resets a timer after each test, forcing tests to quit if no new test results were received within the specified timeout. This can be used to handle stalled tests. See our timeout documentation for more options

nodeArguments?: #."array-of-strings" ¶
utilizeParallelBuilds?: bool ¶

If `false`, disable parallel builds (default: `true`)

typescript?: ¶

configuration

Configures @ava/typescript for projects that precompile TypeScript. Alternatively, you can use `ts-node` to do live testing without transpiling, in which case you shouldn't use the `typescript` property

extensions?: #."array-of-paths" ¶
rewritePaths?:
click to see definition
{
	{
		[=~"/$"]: =~"/$"
	}
	...
}
¶

paths

AVA searches your entire project for `*.js`, `*.cjs`, `*.mjs` and `*.ts` files (or other extensions you've configured). It will ignore such files found in the `rewritePaths` targets (e.g. `build/`). If you use more specific paths, for instance `build/main/`, you may need to change AVA's `files` configuration to ignore other directories. Paths are relative to your project directory

compile?: false | "tsc" ¶

If `false`, AVA will assume you have already compiled your project. If set to `'tsc'`, AVA will run the TypeScript compiler before running your tests. This can be inefficient when using AVA in watch mode

#: ¶
"array-of-paths": [...#path] ¶
"array-of-strings": [...string] ¶
#path: strings.MinRunes(1) ¶
release?: ¶
extends?: matchN(1, [string, [...string]]) ¶

List of modules or file paths containing a shareable configuration. If multiple shareable configurations are set, they will be imported in the order defined with each configuration option taking precedence over the options defined in a previous shareable configuration

branches?: matchN(1, [string, #."branch-object", [...matchN(>=1, [string, #."branch-object"])]]) ¶

The branches on which releases should happen.

repositoryUrl?: string ¶

The git repository URL

tagFormat?: string ¶

The Git tag format used by semantic-release to identify releases. The tag name is generated with Lodash template and will be compiled with the version variable.

plugins?: [...matchN(>=1, [string, [...], { path!: string ... }])] ¶

Define the list of plugins to use. Plugins will run in series, in the order defined

dryRun?: bool ¶

The objective of the dry-run mode is to get a preview of the pending release. Dry-run mode skips the following steps: prepare, publish, success and fail. In addition to this it prints the next version and release notes to the console

ci?: bool ¶

Set to false to skip Continuous Integration environment verifications. This allows for making releases from a local machine

#: ¶
"branch-object": ¶
name!: string ¶
channel?: string ¶
range?: string ¶
prerelease?: bool | string ¶
jscpd?: ¶
minLines?: int ¶

minimum size of code block in lines to check for duplication

maxLines?: int ¶

maximum size of source file in lines to check for duplication

maxSize?: matchN(>=1, [=~"^\\+?[0-9]+(\\.[0-9]+)? *[kKmMgGtTpP][bB]$", int]) ¶

maximum size of source file in bytes to check for duplication (e.g.,: 1kb, 1mb, 120kb)

minTokens?: int ¶

minimum size of code block in tokens to check for duplication

threshold?: number ¶

maximum allowed duplicate lines expressed as a percentage; exit with error and exit code 1 when threshold exceeded

formatsExts?: [string]: [...string] ¶

custom mapping from formats to file extensions (default: https://github.com/kucherenko/jscpd/blob/master/packages/tokenizer/src/formats.ts); see https://github.com/kucherenko/jscpd/blob/master/supported_formats.md

output?: string ¶

path to directory for non-console reports

path?: [...string] ¶

paths that should be included in duplicate detection (default: [process.cwd()])

pattern?: string ¶

glob pattern for files that should be included in duplicate detection (e.g., **/*.txt); only used to filter directories configured via path option

ignorePattern?: [...string] ¶

ignore code blocks matching these regular expressions

mode?: "mild" | "strict" | "weak" ¶

mode of detection quality; see https://github.com/kucherenko/jscpd/blob/master/packages/jscpd/README.md#mode

ignore?: [...string] ¶

glob pattern for files that should be excluded from duplicate detection

format?: [...#format] ¶

list of formats for which to detect duplication (default: all); see https://github.com/kucherenko/jscpd/blob/master/supported_formats.md

store?: "leveldb" | "redis" ¶

store used to collect information about code (default: in-memory store); install @jscpd/leveldb-store and use leveldb for big repositories

reporters?: [..."xml" | "json" | "csv" | "markdown" | "consoleFull" | "html" | "console" | "silent" | "threshold" | "xcode"] ¶

a list of reporters to use to output information about duplication; see https://github.com/kucherenko/jscpd/blob/master/packages/jscpd/README.md#reporters

blame?: bool ¶

get information about authors and dates of duplicated blocks from Git

silent?: bool ¶

do not write duplicate detection progress and result to console

verbose?: bool ¶

show full information during duplicate detection

absolute?: bool ¶

use absolute paths in reports

noSymlinks?: bool ¶

do not follow symlinks

skipLocal?: bool ¶

skip duplicates within folders; just detect cross-folder duplicates

ignoreCase?: bool ¶

ignore case of symbols in code (experimental)

gitignore?: bool ¶

ignore all files from .gitignore file

reportersOptions?: ¶
badge?: ¶
path?: string ¶

output path for duplication level badge (default: path.join(output, 'jscpd-badge.svg'))

label?: string ¶

badge subject text (URL-encoding needed for spaces or special characters)

labelColor?: #color ¶
status?: string ¶

badge value text (URL-encoding needed for spaces or special characters, default: duplication %)

color?: #color ¶
style?: "flat" | "classic" ¶

badge look: flat or classic

icon?: string ¶

URL for icon to display in front of badge subject text (e.g., data:image/svg+xml;base64,...)

iconWidth?: number ¶

SVG width of icon to display in front of badge subject text; set this if icon is not square

scale?: number ¶

size of badge relative to default of 1

exitCode?: int ¶

exit code to use when at least one duplicate code block is detected but threshold is not exceeded

#color: matchN(1, [#colorPreset, #colorHex]) ¶
#colorHex: =~"([0-9a-fA-F]{3}){1,2}" ¶
#colorPreset: "green" | "blue" | "red" | "yellow" | "orange" | "purple" | "pink" | "grey" | "gray" | "cyan" | "black" ¶
#format:
click to see definition
"abap" | "actionscript" | "ada" | "apacheconf" | "apl" | "applescript" | "arduino" | "arff" | "asciidoc" | "asm6502" | "aspnet" | "autohotkey" | "autoit" | "bash" | "basic" | "batch" | "bison" | "brainfuck" | "bro" | "c" | "c-header" | "clike" | "clojure" | "coffeescript" | "comments" | "cpp" | "cpp-header" | "crystal" | "csharp" | "csp" | "css-extras" | "css" | "d" | "dart" | "diff" | "django" | "docker" | "eiffel" | "elixir" | "elm" | "erb" | "erlang" | "flow" | "fortran" | "fsharp" | "gedcom" | "gherkin" | "git" | "glsl" | "go" | "graphql" | "groovy" | "haml" | "handlebars" | "haskell" | "haxe" | "hpkp" | "hsts" | "http" | "ichigojam" | "icon" | "inform7" | "ini" | "io" | "j" | "java" | "javascript" | "jolie" | "json" | "jsx" | "julia" | "keymap" | "kotlin" | "latex" | "less" | "liquid" | "lisp" | "livescript" | "lolcode" | "lua" | "makefile" | "markdown" | "markup" | "matlab" | "mel" | "mizar" | "monkey" | "n4js" | "nasm" | "nginx" | "nim" | "nix" | "nsis" | "objectivec" | "ocaml" | "opencl" | "oz" | "parigp" | "pascal" | "perl" | "php" | "plsql" | "powershell" | "processing" | "prolog" | "properties" | "protobuf" | "pug" | "puppet" | "pure" | "python" | "q" | "qore" | "r" | "reason" | "renpy" | "rest" | "rip" | "roboconf" | "ruby" | "rust" | "sas" | "sass" | "scala" | "scheme" | "scss" | "smalltalk" | "smarty" | "soy" | "sql" | "stylus" | "swift" | "tap" | "tcl" | "textile" | "tsx" | "tt2" | "twig" | "typescript" | "vbnet" | "velocity" | "verilog" | "vhdl" | "vim" | "visual-basic" | "wasm" | "url" | "wiki" | "xeora" | "xojo" | "xquery" | "yaml"
¶
pnpm?: ¶

Defines pnpm specific configuration.

overrides?: ... ¶

Used to override any dependency in the dependency graph.

packageExtensions?:
click to see definition
close({
	[=~"^.+$"]: close({
		dependencies?:         #dependency
		optionalDependencies?: #optionalDependency
		peerDependencies?:     #peerDependency
		peerDependenciesMeta?: #peerDependencyMeta
	})
})
¶

Used to extend the existing package definitions with additional information.

peerDependencyRules?: ¶
ignoreMissing?: [...string] ¶

pnpm will not print warnings about missing peer dependencies from this list.

allowedVersions?: ... ¶

Unmet peer dependency warnings will not be printed for peer dependencies of the specified range.

allowAny?: [...string] ¶

Any peer dependency matching the pattern will be resolved from any version, regardless of the range specified in "peerDependencies".

neverBuiltDependencies?: [...string] ¶

A list of dependencies to run builds for.

onlyBuiltDependencies?: [...string] ¶

A list of package names that are allowed to be executed during installation.

onlyBuiltDependenciesFile?: string ¶

Specifies a JSON file that lists the only packages permitted to run installation scripts during the pnpm install process.

ignoredBuiltDependencies?: [...string] ¶

A list of package names that should not be built during installation.

allowedDeprecatedVersions?: ... ¶

A list of deprecated versions that the warnings are suppressed.

patchedDependencies?: ... ¶

A list of dependencies that are patched.

allowNonAppliedPatches?: bool ¶

When true, installation won't fail if some of the patches from the "patchedDependencies" field were not applied.

allowUnusedPatches?: bool ¶

When true, installation won't fail if some of the patches from the "patchedDependencies" field were not applied.

updateConfig?: ¶
ignoreDependencies?: [...string] ¶

A list of packages that should be ignored when running "pnpm outdated" or "pnpm update --latest".

configDependencies?: ... ¶

Configurational dependencies are installed before all the other types of dependencies (before 'dependencies', 'devDependencies', 'optionalDependencies').

auditConfig?: ¶
ignoreCves?: [...=~"^CVE-\\d{4}-\\d{4,7}$"] ¶

A list of CVE IDs that will be ignored by "pnpm audit".

ignoreGhsas?: [...=~"^GHSA(-[23456789cfghjmpqrvwx]{4}){3}$"] ¶

A list of GHSA Codes that will be ignored by "pnpm audit".

requiredScripts?: [...string] ¶

A list of scripts that must exist in each project.

supportedArchitectures?: ¶

Specifies architectures for which you'd like to install optional dependencies, even if they don't match the architecture of the system running the install.

os?: [...string] ¶
cpu?: [...string] ¶
libc?: [...string] ¶
ignoredOptionalDependencies?: [...string] ¶

A list of optional dependencies that the install should be skipped.

executionEnv?: ¶
nodeVersion?: string ¶

Specifies which exact Node.js version should be used for the project's runtime.

stackblitz?: ¶

Defines the StackBlitz configuration for the project.

installDependencies?: bool ¶

StackBlitz automatically installs npm dependencies when opening a project.

startCommand?: bool | string ¶

A terminal command to be executed when opening the project, after installing npm dependencies.

compileTrigger?: "auto" | "keystroke" | "save" ¶

The compileTrigger option controls how file changes in the editor are written to the WebContainers in-memory filesystem.

env?: ... ¶

A map of default environment variables that will be set in each top-level shell process.

Source files

  • schema.cue