@aimhigh/theme
v0.1.17
Published
The theme for the AimHigh app
Downloads
1,058
Keywords
Readme
AHA-Theme
Version Information
- Version 0.0.27: Old theme structure that most projects still follow
- Version 0.1.0+: New theme structure that we'll be using moving forward. Currently implemented in the bmt-client project
SETUP
- Run
npm i
Git hooks
Husky runs local Git hooks from .husky/. After npm i (or npm install), the prepare script registers hooks for the repo. Commit .husky/ and scripts/validate-commit-msg.mjs so everyone shares the same checks.
Commit message format (commit-msg)
The hook validates the first non-comment line of the commit message. It must match one of:
- Conventional commit with one or more
(bmt-client#<digits>)scopes, optional!, optional: <description>. Types:build,chore,ci,docs,feat,fix,perf,refactor,revert,style,test. Example:feat(bmt-client#123): update theme tokens - Default merge commit subjects (starts with
Merge), such asMerge branch 'main'.
To change this rule, edit scripts/validate-commit-msg.mjs.
Pre-push checks (pre-push)
On git push, hooks run in order and the first failing command blocks the push:
npm run lintnpm run prettier:check
Update the --max-warnings value for the lint command when the baseline warning count is intentionally reduced.
Publishing
- Build the package
npm run build - Login to npm using
npm login - Increment the version using
npm version patch|minor|major - Dry run the publish to verify everything works
npm publish --dry-run - Publish using
npm publish --access public
Troubleshooting
Where do I create a username and password
Who can invite me to the npm project so I can publish
Eric Strabala Ethan Dyas Chris Kollars
