Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Also export editor converter Node APIs #822

Open
JoshuaKGoldberg opened this issue Nov 8, 2020 · 0 comments
Open

Also export editor converter Node APIs #822

JoshuaKGoldberg opened this issue Nov 8, 2020 · 0 comments
Labels
area: node API Using tslint-to-eslint-config as an npm dependency good first issue Good for newcomers; welcome aboard! status: accepting prs Please, send in a PR to resolve this! ✨ type: enhancement New feature or request

Comments

@JoshuaKGoldberg
Copy link
Member

JoshuaKGoldberg commented Nov 8, 2020

🚀 Feature Request

Following #732 to add a Node API and #820 to add a standalone comment conversion API, it might also be useful for Node API consumers to be able to convert their editor configuration file(s) automatically.

Existing Behavior

The convertEditorConfig(s) methods are not exported as a standalone function via the Node API.

Change Proposal

Export standalone equivalent(s) to those methods so that someone could call them to convert their editor configuration(s) without tslint-to-eslint-config using its own file I/O.


@JamesHenry, do you predict wanting to use this as part of the angular-eslint schematic (angular-eslint/angular-eslint#173)? If so, I can tackle this pretty quickly alongside #820. If not, this would be a good contribution opportunity for someone new to tackle if they're interested. This isn't necessary for the angular-eslint schematics. Which makes it a perfect good first issue for someone who'd like to try adding to tslint-to-eslint-config without time pressure! ✨

@JoshuaKGoldberg JoshuaKGoldberg added area: node API Using tslint-to-eslint-config as an npm dependency status: accepting prs Please, send in a PR to resolve this! ✨ type: enhancement New feature or request labels Nov 8, 2020
@KingDarBoja KingDarBoja changed the title Also export comment converter Node APIs Also export editor converter Node APIs Nov 10, 2020
@JoshuaKGoldberg JoshuaKGoldberg added the good first issue Good for newcomers; welcome aboard! label Nov 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: node API Using tslint-to-eslint-config as an npm dependency good first issue Good for newcomers; welcome aboard! status: accepting prs Please, send in a PR to resolve this! ✨ type: enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant