Skip to content

Commit

Permalink
update readme with sim config, phetsims/chipper#728
Browse files Browse the repository at this point in the history
  • Loading branch information
zepumph committed Oct 22, 2024
1 parent 20d3e03 commit 9439828
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion eslint/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,9 @@
In general, PhET's eslint configuration can be found in `./.eslintrc.js`. This base configuration specifies the majority
of the rules used in the project, including the custom rules that have been created for the project (see `./rules/`).

More configuration files can be used instead of the base configuration:
Here is a list of all the available configuration files and why to use them for a repo:

* `.eslintrc.js` is the main set of rules, and should be used for browser code that isn't used in sims, see `sim_eslint.js` for sim configuration (i.e. `phetmarks`).
* `node_eslintrc.js` expands on the base rules and adds configuration only intended for Node.js code (i.e. `perennial`).
* `sim_eslint.js` expands on the base rules and adds configuration intended for code run in sims (think of this as es5 sim rules)
* `sim_es6_eslint.js` expands on the sim rules and adds configuration intended for sims that have no es5 in them (i.e. `wave-interference`)
Expand Down

0 comments on commit 9439828

Please sign in to comment.