Opt-in Atom editor conversion

[JoshuaKGoldberg]

PR Checklist

• Addresses an existing issue: fixes Support Atom editor setting conversion #289; fixes Switch editor config conversions to opt-in #745
• That issue was marked as status: accepting prs

Overview

Builds off the excellent work by @MrCube42 (#133 -> #250) to make a general convertEditorConfigs function, which calls convertEditorConfig for each requested --editor configuration. Instead of assuming VS Code for all editors, a editorConfigDescriptors dependency is added that lists the known file path formats and matches to a known format if possible.

Trims down the logic around retrieving the settings keys and such to be a bit more manual in the editor configs. It was a nice thing to build off of but:

• Atom's editor settings such as linter-eslint and linter-tslint use nested properties, which are more difficult to support dynamically.
• The relevant editor extensions ended up not adding many new features, so the infrastructure was less necessary than I'd thought.

Adds two runtime dependencies to package.json:

• cson-parser: CSON equivalent to the global JSON object.
• lodash: This was already depended on at runtime so there's no real cost to using its nice merge function for merging configs... though this might be removed later in resolving Use a diff writer instead of complete override for JSON editor config conversions #744. I'd like to make that change separately, to keep changes small.

Example output snippets from running node ../tslint-to-eslint-config/bin/tslint-to-eslint-config --editor .vscode/settings.json:

✨ 1 editor file augmented with its ESLint equivalent. ✨

❓ 1 vscode/settings.json editor setting is not known by tslint-to-eslint-config to have an ESLint equivalent. ❓
  Check ./tslint-to-eslint-config.log for details.

2 rules are not known by tslint-to-eslint-config to have ESLint equivalents:
  * tslint-to-eslint-config does not know the ESLint equivalent for TSLint's "typedef".
  * tslint-to-eslint-config does not know the ESLint equivalent for TSLint's "whitespace".

[KingDarBoja]

Everything looks great to me, although I wish there was a easier way to spot changes when renaming files 😆

Btw, fix the merge conflict on package.json and should be ready to merge 🚀

[KingDarBoja]

Psss, you could have used lodash-es which is tree-shakable hence reduces bundle size. 🍸

[JoshuaKGoldberg]

Aha! I can never keep track of which Lodash is the right one to use now 😄. Will do.

[JoshuaKGoldberg]

Hmm, https://www.npmjs.com/package/lodash-es is a year out of date 😕 ... I'll skip this for now, but if it ends up getting regularly published it'd be great to include.

[JoshuaKGoldberg]

Oh fun, this is an actively discussed topic: https://github.com/lodash/lodash/issues/4879

[KingDarBoja]

After merging this one, should be good to change the JSON.parse by json5.parse as stated on #742

[KingDarBoja]

Clever approach 🍰

[skovalyov]

I get an error npm ERR! 404 Not Found - GET http://my-registry-url/coffeescript/-/coffeescript-1.12.8.tgz during installation on Windows. It comes from cson-parser. There are some mentions of this problem, for example at jashkenas/coffeescript/issues/4805, but it's not clear how to fix it while installing Angular Eslint with ng add @angular-eslint/schematics

[KingDarBoja]

Hello, can you open a new issue in order to track the error with Angular ESLint + this package? Thank you :)

[skovalyov]

• ng add @angular-eslint/schematics@latest fails trying to install [email protected] angular-eslint/angular-eslint#194
• ng add @angular-eslint/schematics@latest fails trying to install [email protected] #839

[KingDarBoja]

Thank you, we will look into these and provide a proper fix soon.