express-typescript-skeleton VS lint-staged

I have been using TsED for a year now and I can say that so far I have not had any problems. It is very comfortable to work with this mini-framework. In addition, the creator provides very fast support and is happy to help with any problems. A few months ago I created a REST API template with hexagonal architecture using TsED.

https://github.com/borjapazr/express-typescript-skeleton

As I say in the README of the project:

This is an opinionated template. The architecture of the code base and the configuration of the different tools used has been based on best practices and personal preferences.

This template does not pretend to have the magic solution to all the problems that a developer may face when creating a REST API using Node.js. This is my contribution, after spending some time on it, to the community. It is an opinionated codebase created based on personal preferences, but also based on the application of best practices.

All criticisms and opinions are welcome, indeed I am very grateful for them. Based on them this could evolve, adapt and become something better. I am sure it will bring something to someone at some point, because even from the worst things something can be learned.

Many thanks to all of you who have taken the time to look at the project.

lint-staged is the second important tools we need here, install it via NPM.

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