rollup-plugin-sass icon indicating copy to clipboard operation
rollup-plugin-sass copied to clipboard

Suggestions: package maintenance improvements

Open marcalexiei opened this issue 8 months ago • 0 comments

Follow up to #140

[!NOTE] I'm creating a separate issue since the following changes should not affect package behaviour in user land.

[!NOTE] Alike #140 If you are ok with at least one of the proposed changes I can take care of doing separate PR's 😁

Linter

eslint is installed in devDependencies but it is not used in npm scripts or in actions as far as I can tell. It would be good to use the default configuration combined with https://typescript-eslint.io plugin

Formatter

Alongside with linting it would be good to have also a formatter. prettier is widely adopted so I would go for it, alternatively there is biomejs.

Unit test using snapshots

https://github.com/elycruz/rollup-plugin-sass/pull/139#issuecomment-2196135864

Add more check to GitHub actions

  • Add checks for all supported node version
  • Add lint and format checks too

Add commit message linter

In order to ease changelog maintenance (https://github.com/elycruz/rollup-plugin-sass/issues/118), commits should follow conventional commits. Having a commit linter + a git hooks manager will enable commit message validation on user commit:

Examples:

  • Linter: https://commitlint.js.org
  • git hooks manager: https://typicode.github.io/husky/

  • [x] #143
    • [x] #151
  • [x] #144
    • [x] #148
  • [x] #156
  • [x] #162
  • [ ] add eslint and add check to GitHub actions

marcalexiei avatar Jun 29 '24 07:06 marcalexiei