README.md

@cesium/eslint-config

The official shareable ESLint config for the Cesium ecosystem.

Usage

We export three ESLint configurations.

Default

This config contains basic Cesium syntax and style config, from which browser and node extend. Extends @eslint/js recommended rules and eslint-config/prettier with additional rules.

eslint.config.js

import configCesium from "@cesium/eslint-config";

exports default [
    // Apply recommended rules to all files
    configCesium.configs.recommended,
    // Apply recommended rules to JS files with an override
    {
        files: ["**/*.js"],
        rules: {
            ...configCesium.configs.recommended.rules,
            "no-unused-vars": "off"
        }
    },
]

Browser

For use in browser environments.

eslint.config.js

import configCesium from "@cesium/eslint-config";

exports default [
    // Apply recommended rules to all files
    configCesium.configs.browser,
    // Apply recommended rules to JS files with an override
    {
        files: ["**/*.js"],
        ...configCesium.configs.browser,
        rules: {
            ...configCesium.configs.browser.rules,
            "no-unused-vars": "off"
        }
    },
]

Node

For use in Node.js environments. Extends plugin/n:recommended

eslint.config.js

import configCesium from "@cesium/eslint-config";

exports default [
    // Apply recommended rules to all files
    configCesium.configs.node,
    // Apply recommended rules to JS files with an override
    {
        files: ["**/*.js"],
        ...configCesium.configs.node,
        rules: {
            ...configCesium.configs.node.rules,
            "no-unused-vars": "off"
        }
    },
]