phetsims / projectile-data-lab

"Projectile Data Lab" is an educational simulation in HTML5, by PhET Interactive Simulations.
GNU General Public License v3.0
0 stars 0 forks source link

Review eslintConfig in package.json #200

Closed pixelzoom closed 5 months ago

pixelzoom commented 5 months ago

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 commented 5 months ago

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 commented 5 months ago

(oops, accidentally pressed close. Reopened).

pixelzoom commented 5 months ago

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 commented 5 months ago

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.