eslint-plugin-toml weekly downloads statistics

Introduction

eslint-plugin-toml is ESLint plugin provides linting rules for [TOML].

:name_badge: Features

This ESLint plugin provides linting rules for [TOML].

• You can use ESLint to lint [TOML].
• You can find out the problem with your [TOML] files.
• You can apply consistent code styles to your [TOML] files.
• Supports Vue SFC custom blocks such as <custom-block lang="toml">.
  Requirements vue-eslint-parser v7.3.0 and above.
• Supports ESLint directives. e.g. # eslint-disable-next-line
• You can check your code in real-time using the ESLint editor integrations.

You can check on the Online DEMO.

<!--DOCS_IGNORE_START-->

:book: Documentation

See documents.

:cd: Installation

npm install --save-dev eslint eslint-plugin-toml

Requirements

• ESLint v9.38.0 and above
• Node.js v20.19.x, v22.13.x, v24.x and above

<!--DOCS_IGNORE_END-->

:book: Usage

<!--USAGE_SECTION_START--> <!--USAGE_GUIDE_START-->

Configuration

Use eslint.config.js file to configure rules. See also: https://eslint.org/docs/latest/use/configure/configuration-files.

Example eslint.config.js:

import eslintPluginToml from 'eslint-plugin-toml';
export default [
  // add more generic rule sets here, such as:
  // js.configs.recommended,
  ...eslintPluginToml.configs.recommended,
  {
    rules: {
      // override/add rules settings here, such as:
    // 'toml/rule-name': 'error'
    }
  }
];

This plugin provides configs:

• *.configs.base ... Configuration to enable correct TOML parsing.
• *.configs.recommended ... Above, plus rules to prevent errors or unintended behavior.
• *.configs.standard ... Above, plus rules to enforce the common stylistic conventions.
• *.configs.all ... Configuration to enable correct TOML parsing and all non-deprecated rules. This config is not recommended for production use because it may change with every minor release. Use at your own risk.

For backward compatibility, you can also use the flat/* namespace:

• *.configs['flat/all']
• *.configs['flat/base']
• *.configs['flat/recommended']
• *.configs['flat/standard']

See the rule list to get the rules that this plugin provides.

Languages

This plugin provides the following language identifiers for use in ESLint configurations:

• toml/toml ... TOML files

For example, to apply settings specifically to TOML files, you can use the language field in your ESLint configuration:

import eslintPluginToml from 'eslint-plugin-toml';
export default [
  {
    files: ["*.toml", "**/*.toml"],
    plugins: {
      toml: eslintPluginToml,
    },
    language: "toml/toml",
  }
]

The configuration above is included in the shareable configs provided by this plugin, so using configs is generally recommended.

See also https://eslint.org/docs/latest/use/configure/plugins#specify-a-language

:computer: Editor Integrations

Visual Studio Code

Use the dbaeumer.vscode-eslint extension that Microsoft provides officially.

You have to configure the eslint.validate option of the extension to check .toml files, because the extension targets only *.js or *.jsx files by default.

Example .vscode/settings.json:

{
    "eslint.validate": [
        "javascript",
        "javascriptreact",
        "toml"
    ]
}

<!--USAGE_GUIDE_END--> <!--USAGE_SECTION_END-->

:white_check_mark: Rules

<!--RULES_SECTION_START-->

The --fix option on the command line automatically fixes problems reported by rules which have a wrench :wrench: below.
The rules with the following star :star: are included in the configs.

<!--RULES_TABLE_START-->

TOML Rules…