snanovskyi / eslint-to-editorconfig

Module for transforming configuration from ESLint to EditorConfig format

eslint-to-editorconfig

Module for transforming configuration from ESLint to EditorConfig format.

Note that minimum supported version of eslint is 2.0.0.

Usage

You need to install eslint-to-editorconfig globally if you use npm 5.1 or earlier:

npm install -g eslint-to-editorconfig
cd project
eslint-to-editorconfig

Otherwise you can use npx:

cd project
npx eslint-to-editorconfig

For a complete list of available options run:

eslint-to-editorconfig --help

API

const transform = require('eslint-to-editorconfig');

// Take ESLint rules
const eslintRules = {
  indent: 'error',
  'no-trailing-spaces': 'error',
  'eol-last': 'error',
  'max-len': 'error',
};

// Transform them into EditorConfig rules
const editorConfigRules = transform(eslintRules);
console.log(editorConfigRules);

License

This library is released under the ISC license.

eslint-to-editorconfig's Issues

airbnb config

Hi,
I'v tried running this against airbnb's config and got the following error:
/usr/local/lib/node_modules/eslint-to-editorconfig/node_modules/eslint/lib/config/config-file.js:332
throw e;
^

Error: /usr/local/lib/node_modules/eslint-config-airbnb/rules/best-practices.js:
Configuration for rule "no-labels" is invalid:
Value "2,[object Object]" has more items than allowed.

Any ideas?
/Stephen.

Upgrade eslint v2.x -> v3.x

I've run into errors like the following, and they appear to be due to using an outdated version of eslint

/path/to/project/node_modules/eslint-to-editorconfig/node_modules/eslint/lib/config/config-file.js:402
            throw e;
            ^

Error: /path/to/project/node_modules/eslint-config-airbnb-base/rules/es6.js:
	Configuration for rule "arrow-parens" is invalid:
	Value "as-needed,[object Object]" has more items than allowed.

Referenced from: airbnb-base
Referenced from: /path/to/project/.eslintrc

"ESLint configuration is invalid" when it's not

Running eslint-to-editorconfig outputs "ESLint configuration is invalid" without any additional information. However it is not invalid, as ESLint works fine, both CLI and IDE.

eslint-to-editorconfig version: 2.0.0
eslint version: 7.3.1
.eslintrc.js file:

module.exports = {
    "env": {
        "browser": true,
        "es2017": true,
        "node": true
    },
    "parser": "@typescript-eslint/parser",
    "parserOptions": {
        "project": "tsconfig.eslint.json",
        "sourceType": "module"
    },
    "plugins": [
        "@typescript-eslint",
        "import",
        "prefer-arrow"
    ],
    "rules": {
        // bunch of rules
    },
    "overrides": [
        {
            "files": ["*.spec.ts"],
            "env": {
                "jasmine": true
            },
            "rules": {
                // bunch of rule overrides
            }
        }
    ]
};

Any plans on converting the other way?

As the title states, are there any plans on supporting editorconfig to eslint conversion?

Error thowing on running eslint-editorconfig command

When I am running the command It is thowing following error. I have .eslintrc in my current directory

~/.npm-packages/lib/node_modules/eslint-to-editorconfig/index.js:43
  if (rules['max-len'][0] > 0) {
                      ^
TypeError: Cannot read property '0' of undefined
    at maxLineLength (~/.npm-packages/lib/node_modules/eslint-to-editorconfig/index.js:43:23)
    at rulesToProps (~/.npm-packages/lib/node_modules/eslint-to-editorconfig/index.js:72:3)
    at module.exports (~/.npm-packages/lib/node_modules/eslint-to-editorconfig/index.js:96:5)
    at Object.<anonymous> (~/.npm-packages/lib/node_modules/eslint-to-editorconfig/bin.js:5:1)
    at Module._compile (module.js:460:26)
    at Object.Module._extensions..js (module.js:478:10)
    at Module.load (module.js:355:32)
    at Function.Module._load (module.js:310:12)
    at Function.Module.runMain (module.js:501:10)
    at startup (node.js:129:16)

Use ESLint API to get rules

Hi, this looks very useful.

Have you considered using getConfigForFiles() instead of pulling the rule configuration straight from an .eslintrc? This would have the benefit of detecting rules extended from a sharable config like standard.