chooser
chooser copied to clipboard
Fix prettier, eslint and stylelint config
Fixes
- Fixes #520 by @dijitali
Description
Fixes prettier, eslint and stylelint config. Now run manually via npm run lint
and npm run format
as discussed in https://github.com/creativecommons/chooser/pull/530#issuecomment-2299706213.
Technical details
~Add and configure husky to run lint-staged (latest v8.x, since v9 drops node v14 support):~
~npm install --save-dev [email protected]
~
~npx husky add .husky/pre-commit npx lint-staged
~
-
Upgrade Prettier and add
npm run format
scripts:npm update prettier
-
Downgrade
eslint-config-prettier
to be compatible with eslint v6 (current v7.2.0 requires eslint upgrade):npm install --save-dev [email protected]
-
Ignores
coverage
anddist
directories when running Prettier -
Update
lint-staged
to run prettier -
Remove git-hooks config from
package.json
(this project uses Husky not Yorkie) -
Check eslint <-> prettier conflicts and remove problematic rules:
npx eslint --print-config src/App.vue | npx eslint-config-prettier-check #The following rules are unnecessary or might conflict with Prettier: # - comma-dangle # - indent # - space-before-function-paren
-
Set
lint-staged
to runstylelint
on the same file patterns as the npm script is configured to. This potentially needs further work as a separate PR because currently onmain
, if you runnpx stylelint **/*.{css,vue} --fix
(the equivalent of whatlint-staged
runs it against), there's a bunch of things flagged in thestatic
directory.
Tests
- Run
npm run lint
andnpm run format
and check that tests and builds still work OK - Try committing a change with incorrect formatting and verify that it's fixed when you next run the lint and format commands
Checklist
- [x] My pull request has a descriptive title (not a vague title like
Update index.md
). - [x] My pull request targets the default branch of the repository (
main
ormaster
). - [x] My commit messages follow best practices.
- [x] My code follows the established code style of the repository.
- [x] I added or updated tests for the changes I made (if applicable).
- [ ] I added or updated documentation (if applicable).
- [x] I tried running the project locally and verified that there are no visible errors.
Developer Certificate of Origin
For the purposes of this DCO, "license" is equivalent to "license or public domain dedication," and "open source license" is equivalent to "open content license or public domain dedication."
Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129
Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.
Developer's Certificate of Origin 1.1
By making a contribution to this project, I certify that:
(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or
(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or
(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.
(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.