toml-eslint-parser

toml-eslint-parser

A TOML parser that produces output compatible with ESLint.

Features

• Converts TOML text to AST.
• Support for TOML 1.0.0

Installation

npm install --save-dev toml-eslint-parser

Usage

Configuration

Use .eslintrc.* file to configure parser. See also: https://eslint.org/docs/user-guide/configuring.

Example .eslintrc.js:

module.exports = {
    "overrides": [
        {
            "files": ["*.toml"],
            "parser": "toml-eslint-parser"
        }
    ]
}

Usage for Custom Rules / Plugins

• AST.md is AST specification.
• keys-order.ts is an example.
• You can see the AST on the Online DEMO.

Testing

This project uses files from BurntSushi/toml-test and iarna/toml-spec-tests repositories for testing.

Related Packages

• eslint-plugin-jsonc ... ESLint plugin for JSON, JSON with comments (JSONC) and JSON5.
• eslint-plugin-yml ... ESLint plugin for YAML.
• eslint-plugin-toml ... ESLint plugin for TOML.
• jsonc-eslint-parser ... JSON, JSONC and JSON5 parser for use with ESLint plugins.
• yaml-eslint-parser ... YAML parser for use with ESLint plugins.