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

Public API #2

Open
zimme opened this issue Dec 7, 2017 · 6 comments
Open

Public API #2

zimme opened this issue Dec 7, 2017 · 6 comments

Comments

@zimme
Copy link
Member

zimme commented Dec 7, 2017

Let's discuss the public api of this package. I see this as an internal package used by @linterjs/cli and the adapters.

@zimme
Copy link
Member Author

zimme commented Dec 7, 2017

This package should also be used by editor integrations.

@zimme
Copy link
Member Author

zimme commented Dec 7, 2017

I see the following functionality as needed, for now.

For cli, editors and other programmatic use cases.

  • lint
  • format
  • enable/disable registered linters?

For linter adapters

  • register linter

@zimme
Copy link
Member Author

zimme commented Dec 7, 2017

We will need a common lint output format so that the cli and editors can pretty print the output for all linters.

@zimme
Copy link
Member Author

zimme commented Dec 17, 2017

Working on a "light-weight" version of eslint's output with some additions from tslint's output, for LinterAdapterLintOutput.

@cangoektas
Copy link

What do you think about changing the naming to check/fix instead of lint/format? I've seen it in Google's ts-style project and I think it makes sense in here as well. Making the prettier adaptor i.e. expose a "lint" function seems a bit weird, doesn't it?

@zimme
Copy link
Member Author

zimme commented Jan 23, 2018

Worth thinking about, however the prettier provider will be using prettylint which make prettier work like a linter based on some of the exposed functionality fron eslint-plugin-prettier

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants