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 937d2b6 commit 20d3e03
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion eslint/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,17 @@ of the rules used in the project, including the custom rules that have been crea
More configuration files can be used instead of the base configuration:

* `node_eslintrc.js` expands on the base rules and adds configuration only intended for Node.js code (i.e. `perennial`).
* `sim_es6_eslint.js` expands on the base rules and adds configuration intended for sims that have no es5 in them (i.e. `wave-interference`)
* `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`)

So here is the hierarchy of chipper's config files. Indentation symbolized the "extends" relationship.

```
.eslint.js
node_eslintrc.js
sim_eslint.js
sim_es6_eslint.js
```

The project is set up based on configuration files extending others using the "extends" key. By default, a configuration
file in a child dir will completely override a parent directory. Be sure appropriately extend, and don't blow away a
Expand Down

0 comments on commit 20d3e03

Please sign in to comment.