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

chore/issue 24 formatting and linting #40

Merged
merged 17 commits into from
May 3, 2024

Conversation

thescientist13
Copy link
Member

@thescientist13 thescientist13 commented Apr 29, 2024

Related Issue

resolves #24

Summary of Changes

  1. Add Prettier and related npm scripts and formatted the entire project
  2. Integrate ESLint + Prettier (and bumped project to Node 18.18.0)
  3. Integrate Stylelint + Prettier
  4. Add LS Lint
  5. Integrate Husky and document in Storybook

TODO

  1. CI Check
         > [email protected] format:check
         > prettier . --check
         Checking formatting...
         [warn] .github/workflows/ci.yml
         [warn] Code style issues found in the above file. Run Prettier to fix.
         Error: Process completed with exit code 1.
       
  2. ESLint integration
  3. Stylelint integration
  4. Husky Integration
  5. LS Lint integration
  6. Document in Storybook

Nice To Have

  1. Markdown lint and Import Attributes compat (make separate ticket) - linting and formatting support for code snippets inside markdown #43
  2. clean up stylistic ESLint rules (make a standalone ticket / GFI) - clean up style specific rules from ESLint configuration #42

Questions

  1. Formatting Options - https://prettier.io/docs/en/options
    • quotes
    • end of line
    • trailing commas
    • column width
    • consistent quotes for keys
  2. Looks like Prettier breaks intentional line breaks in markdown :/

@thescientist13 thescientist13 added question Further information is requested chore project maintenance related tasks labels Apr 29, 2024
@thescientist13 thescientist13 changed the title initial formatting with prettier chore/issue 24 formatting and linting Apr 29, 2024
Copy link

netlify bot commented Apr 29, 2024

Deploy Preview for super-tapioca-5987ce ready!

Name Link
🔨 Latest commit
🔍 Latest deploy log https://app.netlify.com/sites/super-tapioca-5987ce/deploys/66351d33783c732658f72b29
😎 Deploy Preview https://deploy-preview-40--super-tapioca-5987ce.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.

@thescientist13 thescientist13 self-assigned this Apr 29, 2024
@thescientist13 thescientist13 marked this pull request as ready for review April 30, 2024 01:36
@thescientist13 thescientist13 force-pushed the chore/issue-24-linting-and-formatting branch from 5a46b16 to 1a1a1ed Compare May 3, 2024 17:09
Copy link
Member Author

@thescientist13 thescientist13 left a comment

Choose a reason for hiding this comment

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

Ended up reverting the Prettier overrides I had, other than just extending the default printWidth from 80 -> 100

@thescientist13 thescientist13 merged commit b205621 into main May 3, 2024
1 of 5 checks passed
@thescientist13 thescientist13 deleted the chore/issue-24-linting-and-formatting branch May 3, 2024 17:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore project maintenance related tasks question Further information is requested
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Linting and Formatting
2 participants