cspell VS lint-staged

CSpell is a great spell checker for code. It can be added as a source to null-ls. However, a lot of features are missing when it's used from null-ls, for instance the ability to ignore certain paths. According to this comment in a null-ls thread cspell would need its own companion plugin.

I use cspell CLI to test for spelling errors at build time so that spelling errors cannot get committed. It's very easy to automate to avoid introducing errors. I don't know of an offline library to check for grammar though.

Spell check

Are this.state.representative and this.respresentative supposed to be the same thing? First off, they are misspelled, second, not the same property. Highly recommend at least using a code spell checker cspell and VS Code - Code Spell Checker if you aren't going to use TypeScript or ESLint.

You could definitely use a spellchecker. cspell is a great programatic spellchecker that you can add to your commit or build validations to enforce that things are spelled correctly.

- cspell: https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell

Also, it's response not responce. Highly recommend using the Code Spellchecker plugin for VS Code and/or the cspell cli for spellchecking.

We were already using lint-staged and have a pre-commit hook in place using Husky in our project for linter and prettier. So it made sense to add a check here.

Now you can config it in your package.json, here is the guide doc:

In the world of software development, maintaining consistent code quality and ensuring that the codebase adheres to predefined patterns and guidelines is crucial. However, manually enforcing these standards can be time-consuming and error-prone. This is where automation tools like Husky, Lint-Staged, Commitlint, and Commitizen come to the rescue. In this post, we will explore how these tools can be combined to streamline your development workflow.

This is wasted work that can and should be automated. Adding a linter and formatter on CI and a pre-commit hook such as lint-staged can do wonders.

lint-staged is a package that can be used to run formatting and linting commands on staged files in a Git repo.

To answer your next question: I lint and format on save, and I use Git hooks installed by Husky and executed through Lint-Staged (this tool helps ensure your Git hooks only run on modified files, etc) to ensure there are no lint or formatting errors whenever making a commit or pushing code. This is helpful for teams, as some developers tend to forget to run lint tasks, or don't have the Prettier extension installed in their IDE. If there are lint errors, the commit is rejected until fixed. YMMV - you'll need to fine-tune the strictness of this based on the team's needs.

Uses Husky Git hooks and Lint-staged pre-commit hooks.

Something else to consider is applying linting and formatting before every git commit. A package like Lint-staged only lints and formats on staged items, ensuring all pushed code follows the standards in the repo. This allows developers to have their own formatting preferences when developing, while the code homogenizes on push. Linting pre-commit also avoids strict rules like no-console or no-unused-vars restricting a developer when writing code, when it should only apply in production. Imagine not being able to console log anything during development!

Lint-Staged Docs

Additionally, there are pre-commit hooks which can be setup to seamlessly validate and modify the source code before every commit. I followed Prettier documentation to create one. I ran npx mrm@2 lint-staged which installed husky and lint-stagedand added a configuration to the project’s package.json. Then, I modified the commands a little and that's it.