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

Update README.md with a workaround for #10618 #13549

Closed
wants to merge 1 commit into from

Conversation

joaotavora
Copy link

@joaotavora joaotavora commented Aug 6, 2020

Prerequisites checklist

What is the purpose of this pull request? (put an "X" next to an item)

[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:

What changes did you make? (Give an overview)

Added a question to the faq answering some of problems in #10618, which I've recently come across myself. I just need a bit of linting for some javascript and don't want a big node.js setup. I figured providing people with a way to make a quick .eslintrc would be a good idea. Even better would be for Eslint to have that thing called defaults and work out of the box.

Is there anything you'd like reviewers to focus on?

Not really. I'm just making this for my own reference and trying my luck at helping others with the same problem I had.

@jsf-clabot
Copy link

@jsf-clabot jsf-clabot commented Aug 6, 2020

CLA assistant check
Thank you for your submission, we really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.

@eslint-deprecated eslint-deprecated bot added the triage label Aug 6, 2020
@nzakas nzakas added documentation and removed triage labels Aug 7, 2020
@nzakas
Copy link
Member

@nzakas nzakas commented Aug 7, 2020

Thanks for the suggestion. This question hasn't come up frequently enough to put it on the README, but it might make sense in the getting started guide: https://github.com/eslint/eslint/blob/master/docs/user-guide/getting-started.md

@joaotavora
Copy link
Author

@joaotavora joaotavora commented Aug 7, 2020

I admit I didn't read this guide. I just read the README to install eslint, which went OK, and then when eslint --init failed I went straight to Google to getting it to work. Like me, I suspect thousands will, and either be frustrated or invest in some frameworkey setup.

Actually, if eslint works with an even smaller .eslintrc file, just mention that in the README. You should advise, but not force people to use eslint --init. First give them something working, then leave that fine-tuning for later. My two cents, but you can move my contribution anywhere you want.

Thanks for eslint, it's working nicely.

@nzakas
Copy link
Member

@nzakas nzakas commented Sep 16, 2020

Just to close the loop on this, we don't force anyone to use --init. You can always set up a config file manually, but for people just starting out, doing so is often overwhelming. There are some rough edges we can probably still work on, though.

@joaotavora
Copy link
Author

@joaotavora joaotavora commented Sep 16, 2020

You can always set up a config file manually, but for people just starting out, doing so is often overwhelming.

But if you really care about that, then just make configless eslint infer reasonable defaults. A lot of applications do this.

Remember that the problem here is that --init does force you to have a package.json, and I found it exactly that: overwhelming and frankly, just sill, given that it's totally unrequired for eslint to work reasonably well.

nzakas added a commit that referenced this issue Sep 22, 2020
… (#13696)

* Docs: Clarify package.json requirement in Getting Started (refs #13549)

* Update docs/user-guide/getting-started.md
@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators Mar 18, 2021
@eslint-github-bot eslint-github-bot bot added the archived due to age label Mar 18, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
archived due to age documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants