Toolbox
A library of reusable React components for iFixit.
Installation
npm install @ifixit/toolboxDevelopment Setup
# Clone the repo
git clone https://github.com/iFixit/toolbox.git
cd toolbox
# Install the dependencies
npm install
# Start the styleguide dev server
npm startCode Style
Toolbox adheres to the Airbnb Javascript Style Guide. Code style and quality are enforced by ESLint and Prettier. You can format your code with the lint:fix script:
npm run lint:fixCommit Message Format
Toolbox adheres to the Conventional Commits Specification for commit messages. Running npm run cm instead of git commit will guide you through the commit process.
Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject:
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
The header is mandatory and the scope of the header is optional.
Type
Must be one of the following:
- feat: A new feature
- fix: A bug fix
- docs: Documentation only changes
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
- refactor: A code change that neither fixes a bug nor adds a feature
- perf: A code change that improves performance
- test: Adding missing or correcting existing tests
- chore: Changes to the build process or auxiliary tools and libraries such as documentation generation
- build: Changes that affect the build system or external dependencies
- ci: Change to our CI configuration file and scripts
Scope
The scope could be anything specifying place of the commit change. For example Icon,
Tab, SearchInput, etc...
Remember that scope is entirely optional. Only include a scope if the commit message doesn't stand on it's own outside the context of a pull request.
Subject
The subject contains succinct description of the change:
- Use the imperative, present tense: "Change" not "Changed" nor "Changes"
- Use sentence case: "Some message" not "some message" nor "Some Message"
- Do not include a dot (.) at the end
Body
Just as in the subject, use the imperative, present tense: "Change" not "Changed" nor "Changes". The body should include the motivation for the change and contrast this with previous behavior.
Footer
The footer should contain any information about Breaking Changes and is also the place to reference GitHub issues that this commit closes.
Breaking Changes should start with the word BREAKING CHANGE: with a space or two newlines.
The rest of the commit message is then used for this.
Examples
Here are examples of the release types that will be generated based on a commit messages:
| Commit message | Release type |
|---|---|
fix(pencil): Stop graphite breaking when too much pressure applied |
Patch Release |
feat(pencil): Add 'graphiteWidth' option |
|
perf(pencil): Remove graphiteWidth optionBREAKING CHANGE: The graphiteWidth option has been removed.The default graphite width of 10mm is always used for performance reasons.
|
|
Why?
semantic-release uses commit messages to determine the type of changes in the codebase since the last release. Using these formalized conventions for commit messages allows semantic-release to automatically determine the next semantic version number, generate a changelog and publish to npm automatically.
Testing
Toolbox uses Jest for testing. Learn more about testing React with Jest here: Jest – Testing React Apps
How do I run the tests?
To run the test suite, use one of the following npm scripts:
# Run the test suite
npm test
# Run the test suite in watch mode (recommended during development)
npm run test:watch
# Update Jest snapshots
npm run test:update
# Run the test suite and generate a code coverage report
npm run test:coverageWhere should I place new tests?
Place *.test.jsx files in the same directory as the corresponding component. Example:
src/
Icon/
Icon.jsx
Icon.test.jsx
...
Deploying
We use NPM to publish Toolbox with semantic versioning. A publish happens automatically each time a commit is pushed to Master (does not work on an amended commit).