Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP] enable prettier to run automatically #522

Closed
wants to merge 12 commits into from

Conversation

dijitali
Copy link
Contributor

@dijitali dijitali commented Apr 8, 2024

Fixes

Description

Runs prettier automatically for consistency.

Technical details

  • Adds Husky package which is the recommended method of setting up git hooks
  • Upgrade to latest supports with Node version 14:
  • Also ignores coverage and dist directories when running Prettier

Tests

TODO

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the default branch of the repository (main or master).
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • 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.

Upgrade to latest of each supported with node v14
Ignore coverage and dist directories when running prettier
Copy link

netlify bot commented Apr 8, 2024

Deploy Preview for creativecommons-chooser ready!

Name Link
🔨 Latest commit fb588b6
🔍 Latest deploy log https://app.netlify.com/sites/creativecommons-chooser/deploys/6618b280d60c3c0008fbb608
😎 Deploy Preview https://deploy-preview-522--creativecommons-chooser.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

package.json Outdated
@@ -28,8 +28,9 @@
"test:unit": "vue-cli-service test:unit",
"build-component": "rm -rf dist && VUE_APP_CC_OUTPUT=embedded vue-cli-service build --target wc --name license-chooser src/main.js",
"test:cypress": "node_modules/.bin/cypress open",
"lint": "vue-cli-service lint src/**/*.{vue,js} --fix && npx stylelint ./src/**/*.{vue,css} --fix",
"i18n:report": "vue-cli-service i18n:report -v --src src/**/*.vue --locales src/locales/**.json -o output.json"
"lint": "prettier ./src/**/*.{css,js,vue} --write && vue-cli-service lint src/**/*.{vue,js} --fix && npx stylelint ./src/**/*.{vue,css} --fix",
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Prettier docs specifically state that prettier should run after linters but I get a build error if it does:

⠴  Building for production...

 ERROR  Failed to compile with 2 errors                                                                     8:42:14 PM

 error  in ./src/components/Stepper.vue

Module Error (from ./node_modules/eslint-loader/index.js):

/app/src/components/Stepper.vue
   77:20  warning  Unexpected space before function parentheses   space-before-function-paren
  100:1   error    Expected indentation of 6 spaces but found 8   indent
  101:1   error    Expected indentation of 8 spaces but found 10  indent
  102:1   error    Expected indentation of 6 spaces but found 8   indent
...

I suspect the eslint-config-prettier config is not working as expected and/or something else needs upgrading.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK no, I think the conflict was specifically with eslint/prettier indentation rules. This goes away with 218b42a .

Now the remaining problem is stylelint falling over during the git hook...

@dijitali
Copy link
Contributor Author

Closing in favour of #530.

@dijitali dijitali closed this Apr 22, 2024
@dijitali dijitali deleted the chore/auto-format branch April 22, 2024 00:27
@possumbilities possumbilities self-assigned this Apr 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature] enable Prettier to run automatically
3 participants