npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@gisce/commitlint-rules

v1.0.6

Published

Shareable commitlint config for GISCE JS projects

Downloads

397

Readme

gisce/commitlint-rules

This package provides a custom set of rules for commit messages in all GISCE projects and libraries, ensuring consistency and readability. It extends the conventional commit message guidelines with specific customizations suitable for our workflow.

Installation

To use gisce/commitlint-rules in your project, first install the package along with commitlint:

npm install --save-dev @commitlint/cli @gisce/commitlint-rules

Configuration

After installation, create a commitlint.config.js file in the root of your project with the following content:

module.exports = {
  extends: ["@gisce/commitlint-rules"],
};

This configuration extends the custom rules defined in @gisce/commitlint-rules.

Rules

The custom rules defined in this package are as follows:

  • body-max-line-length: Set to always ignore the line length in the commit message body.
  • footer-max-line-length: Set to always ignore the line length in the commit message footer.

These rules are built on top of the conventional commit rules provided by @commitlint/config-conventional.

Usage

Commit messages in projects using this package will be checked against the defined rules. Ensure your commit messages are structured according to these rules to maintain consistency across GISCE's codebases.

| Commit message | Release type | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------- | | fix(pencil): stop graphite breaking when too much pressure applied | ~~Patch~~ Fix Release | | feat(pencil): add 'graphiteWidth' option | ~~Minor~~ Feature Release | | perf(pencil): remove graphiteWidth optionBREAKING CHANGE: The graphiteWidth option has been removed.The default graphite width of 10mm is always used for performance reasons. | ~~Major~~ Breaking Release (Note that the BREAKING CHANGE: token must be in the footer of the commit) |

Cheat Sheet: Commit Message Types

| Type | Category | Description | |-----------|--------------------------|----------------------------------------------------------| | feat | Features | A new feature. | | fix | Bug Fixes | A bug fix. | | docs | Documentation | Documentation only changes. | | style | Styles | Changes that do not affect the meaning of the code. | | refactor| Code Refactoring | A code change that neither fixes a bug nor adds a feature.| | perf | Performance Improvements | A code change that improves performance. | | test | Tests | Adding missing tests or correcting existing tests. | | build | Builds | Changes that affect the build system or external dependencies. | | ci | Continuous Integrations | Changes to CI configuration files and scripts. | | chore | Chores | Other changes that don't modify src or test files. | | revert | Reverts | Reverts a previous commit. |

Contributing

Contributions to the gisce/commitlint-rules package are welcome. If you have suggestions for improving or extending the rules, please open an issue or a pull request in the repository.

License

MIT