Skip to content

Commit 74f50cf

Browse files
committed
update readme to include info about the codeclimate filename changes
1 parent 1bbd9ae commit 74f50cf

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# eslint-config-frontier
1+
# eslint-config-frontier-react
22

33
* A common ESLint configuration for frontier apps. The base is airbnb's config (a highly used and tested configuration).
44

@@ -34,6 +34,11 @@ It is important to note that in order for CodeClimate to use this custom config,
3434
path: 'eslint-config-frontier-react.js'
3535
```
3636
- If you also opt into the jsdoc plugin we provide, you'll also need to make a prepare statement for that file.
37+
- WARNING: Starting in version 4 of this repo, there is a different codeclimateEslintRules file for every major version
38+
that is released. If you are using or upgrading to v4 of this repo, you'll need to change the fetched url file to
39+
`codeclimateEslintRulesv4.js`. Notice the "v4" at the end of the filename. When v5 is released, you'll also need
40+
to change the filename to v5, etc.
41+
3742
2. Make a new eslintrc file for codeclimate to use (that way it can point to the `eslint-config-frontier-react.js` file that codeclimate will prepare in Step 1.)
3843
3944
1. Copy your existing local eslintrc file and rename the copy to `.codeclimate.eslintrc.js` (or .json or .yml if you are using those filetypes)

0 commit comments

Comments
 (0)