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

Review eslintConfig in package.json #200

Closed
pixelzoom opened this issue Feb 27, 2024 · 4 comments
Closed

Review eslintConfig in package.json #200

pixelzoom opened this issue Feb 27, 2024 · 4 comments
Assignees

Comments

@pixelzoom
Copy link
Contributor

Related to code review #32 ...

From the CRC:

Does package.json include any config that was only needed for development? For example: ...

eslintConfig looks like it needs some cleanup, sometime before the sim is published.

@samreid
Copy link
Member

samreid commented Feb 27, 2024

package.json eslintConfig currently looks like this:

  "eslintConfig": {
    "extends": "../chipper/eslint/sim_eslintrc.js",
    "overrides": [
      {
        "files": [
          "**/*.ts"
        ],
        "rules": {
          "@typescript-eslint/ban-ts-comment": [
            "error",
            {
              "ts-expect-error": true,
              "ts-ignore": true,
              "ts-check": true,
              "ts-nocheck": true
            }
          ],
          "no-object-spread-on-non-literals": "error",
          "additional-bad-text": [
            "error",
            {
              "forbiddenTextObjects": [
                "dispose"
              ]
            }
          ],
          "author-annotation": "error"
        }
      }
    ]
  }

What do you recommend we change?

@samreid samreid closed this as completed Feb 27, 2024
@samreid samreid reopened this Feb 27, 2024
@samreid samreid assigned pixelzoom and unassigned samreid and matthew-blackman Feb 27, 2024
@samreid
Copy link
Member

samreid commented Feb 27, 2024

(oops, accidentally pressed close. Reopened).

@pixelzoom
Copy link
Contributor Author

pixelzoom commented Feb 27, 2024

I said it should be reviewed and cleaned up. For example, "no-object-spread-on-non-literals": "error" and "author-annotation": "error" are both unnecessary, because they are the defaults in chipper's .eslintrc.js.

@samreid
Copy link
Member

samreid commented Feb 27, 2024

Thanks! I checked each entry and saw that the two you mentioned are unnecessary. The other ones seem necessary. So I removed the redundant ones. Closing.

@samreid samreid closed this as completed Feb 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants