Coder Social home page Coder Social logo

xunnamius / commit-spell Goto Github PK

View Code? Open in Web Editor NEW
1.0 2.0 0.0 2.43 MB

:rocket::sparkles: Unites Atom's spellchecker, VSCode's Code Spell Checker dictionaries, custom local and user dictionaries, and words from your repository's commit history to spellcheck your commit messages as you craft them

Home Page: https://www.npmjs.com/package/commit-spell

License: MIT License

Shell 0.35% JavaScript 38.86% TypeScript 60.80%
spell spellcheck commit message lint commit-lint spelling checker check cspell

commit-spell's People

Contributors

dependabot[bot] avatar xunnamius avatar

Stargazers

 avatar

Watchers

 avatar  avatar

commit-spell's Issues

Friendlier error message when a rebuild is required

Problematic behavior

When updating Node versions, a rebuild of some of the underlying libraries is necessary. The error message for this is too verbose and descriptive, a simple prescription to run npm rebuild should be enough.

Reproduction steps
  1. Update Node
  2. Run commit-spell
Expected behavior
Additional context

commit-spell no longer works as of node@22

Problematic behavior

Looks like the spellchecker package from the old Atom repository has finally died as of node@22's v8 changes. I quite liked having my commit messages spellchecked up until now, even if I haven't shown this repo much love over the years. Potentially viable alternative packages include:

Reproduction steps
Expected behavior
Additional context

Errors if repository contains fewer than two commits

Problematic behavior

In brand new repos and/or repos with fewer than two commits, commit-spell fails with a git log error. Solution: don't check for previous commits when there are less than two.

Reproduction steps
  1. Have a repo with less than two commits
  2. npx commit-spell
  3. Error
Expected behavior
Additional context

node-gyp compilation errors on installation (Windows)

Problematic behavior

The node-gyp invocation to build Hunspell should be skipped (or debugged) on Windows. Installing on Windows at the moment results in an unnecessary error.

Reproduction steps
  1. Attempt to install commit-spell on Windows.
  2. Error occurs.
Expected behavior
Additional context

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.