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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update environment configuration section #1816

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

klaemo
Copy link

@klaemo klaemo commented May 30, 2022

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

[x] Documentation update
[ ] Bug fix
[ ] New feature
[ ] Other, please explain:

What changes did you make? (Give an overview)
I added an example illustrating the standard.env property in package.json.

Which issue (if any) does this pull request address?

Standard's environment configuration syntax in package.json is slightly different to what is documented for ESLint. This changed in version 17 of standard. Before, it accepted the ESLint syntax.

References: #1814

Standard

{
  "standard": {
    "env": ["mocha"]
  }
}

ESLint

{
  "standard": {
    "env": {
      "mocha": true
    }
  }
}

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

In all honesty, I think the underlying issue should probably be fixed instead 馃槄

Standard's syntax is slightly different to what is documented for ESLint.
@welcome
Copy link

welcome bot commented May 30, 2022

馃檶 Thanks for opening this pull request! You're awesome.

Copy link
Member

@LinusU LinusU left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Neat 馃憤

@LinusU
Copy link
Member

LinusU commented May 31, 2022

Hmm, actually, I didn't understand that current ESLint versions still uses the object syntax. I thought that the change in Standard was due to upgrading to a newer ESLint version.

I think it would be better if we make sure that the "proper" way works instead 馃

This probably needs to be done in standard-engine

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

Successfully merging this pull request may close these issues.

None yet

2 participants