As developers, we’ve all been there – pushing code only to realize it doesn’t follow the team’s coding standards or contains formatting inconsistencies. This is where pre-commit hooks come into play, particularly for TypeScript projects. Let’s explore how these tools can make your development process smoother and more efficient.
Pre-commit hooks are scripts that run automatically before a commit is completed. Think of them as your code’s quality control checkpoint. They examine the changes you will commit and ensure they meet your project’s standards.
One of the biggest advantages of pre-commit hooks is that they work regardless of which IDE your team uses; whether someone prefers VS Code, WebStorm, or Sublime Text, pre-commit hooks ensure consistent code quality across the team.
For example:
# Sample pre-commit hook configuration
#!/bin/sh
npm run lint-stagedPre-commit hooks are intelligent – they only check the files that are being changed in the current commit. This means:
▪️Faster execution times
▪️Immediate feedback on your changes
▪️No waste of resources checking unchanged files
Let’s set up a basic pre-commit hook system:
1. First, install the necessary packages:
npm install --save-dev husky lint-staged prettier eslint
@typescript-eslint/parser @typescript-eslint/eslint-plugin2. Configure Husky in your package.json:
{
"husky": {
"hooks": {
"pre-commit": "lint-staged"
}
},
"lint-staged": {
"*.{ts,tsx}": [
"prettier --write",
"eslint --fix",
"git add"
]
}
}Code formatting might seem like a cosmetic concern, but it’s much more than that:
1. Readability: Consistent formatting makes code easier to read and understand.
// Hard to read
function calculateTotal(items:number[],tax:number,discount?:number):number{
return items.reduce((sum,item)=>sum+item,0)*(1+tax)*(discount?1-discount:1)}
// After Prettier formatting
function calculateTotal(
items: number[],
tax: number,
discount?: number
): number {
return items.reduce((sum, item) => sum + item, 0) * (1 + tax) * (discount ? 1 - discount : 1);
}2. Smaller Diffs: When everyone uses the same formatting rules, code diffs in version control focus on actual logic changes rather than styling differences.
3. Time-Saving: No more debates about tabs vs. spaces or line length – Prettier handles it automatically.
TypeScript is powerful, but you need proper linting to use it effectively. ESLint with TypeScript support helps you:
1. Catch Type-Related Issues Early:
// ESLint will catch this error
function processUser(user: any) { // Warning: Avoid using 'any'
return user.name.toLowerCase();
}
// Better approach
interface User {
name: string;
}
function processUser(user: User) {
return user.name.toLowerCase();
}2. Enforce Best Practices:
// ESLint will warn about implicit any
function add(a, b) { // Warning: Parameters lack type annotations
return a + b;
}
// Correct version
function add(a: number, b: number): number {
return a + b;
}Pre-commit hooks help you stay updated with the latest TypeScript features and best practices:
1. Automatic Detection of Deprecated Features:
// Old approach (will be flagged)
interface Person {
name: string;
getAge(): number;
}
// Modern approach using more TypeScript features
type Person = {
name: string;
age: () => number;
};2. Encouraging Modern JavaScript Features:
// Will be flagged by ESLint
var x = 5;
function oldStyle() {
return x;
}
// Modern approach
const x = 5;
const modernStyle = () => x;1. Keep it Fast: Only run necessary checks to avoid slowing down the commit process.
2. Configure Appropriately: Create a .prettierrc file:
{
"singleQuote": true,
"trailingComma": "es5",
"printWidth": 100,
"tabWidth": 2
}3. ESLint Configuration:
{
"parser": "@typescript-eslint/parser",
"plugins": ["@typescript-eslint"],
"extends": [
"eslint:recommended",
"plugin:@typescript-eslint/recommended"
]
}1. Hook Takes Too Long:
▪️Only run checks on changed files
▪️Use cache mechanisms in ESLint
▪️Configure Prettier to run only on necessary files
2. False Positives:
// If you need to disable a rule occasionally
// eslint-disable-next-line @typescript-eslint/no-explicit-any
function legacy(data: any) {
// Legacy code handling
}▪️Consistent Codebase: Everyone’s code looks the same, making review easier.
▪️Reduced Code Review Time: Automated formatting means reviewers can focus on logic.
▪️Better Onboarding: New developers automatically follow team standards.
Pre-commit hooks in TypeScript projects are more than just a tool; they are your first line of defense against code inconsistencies and potential issues. By implementing them, you ensure code quality across different IDEs, get immediate feedback on your changes, maintain consistent styling, use TypeScript to its full potential, and stay updated with modern coding standards.
Remember, the goal is to make development smoother, not to create obstacles. Configure your hooks wisely, and they’ll become an invaluable part of your development workflow.
The team at Mindbowser was highly professional, patient, and collaborative throughout our engagement. They struck the right balance between offering guidance and taking direction, which made the development process smooth. Although our project wasn’t related to healthcare, we clearly benefited...
Founder, Texas Ranch Security
Mindbowser played a crucial role in helping us bring everything together into a unified, cohesive product. Their commitment to industry-standard coding practices made an enormous difference, allowing developers to seamlessly transition in and out of the project without any confusion....
CEO, MarketsAI
I'm thrilled to be partnering with Mindbowser on our journey with TravelRite. The collaboration has been exceptional, and I’m truly grateful for the dedication and expertise the team has brought to the development process. Their commitment to our mission is...
Founder & CEO, TravelRite
The Mindbowser team's professionalism consistently impressed me. Their commitment to quality shone through in every aspect of the project. They truly went the extra mile, ensuring they understood our needs perfectly and were always willing to invest the time to...
CTO, New Day Therapeutics
I collaborated with Mindbowser for several years on a complex SaaS platform project. They took over a partially completed project and successfully transformed it into a fully functional and robust platform. Throughout the entire process, the quality of their work...
President, E.B. Carlson
Mindbowser and team are professional, talented and very responsive. They got us through a challenging situation with our IOT product successfully. They will be our go to dev team going forward.
Founder, Cascada
Amazing team to work with. Very responsive and very skilled in both front and backend engineering. Looking forward to our next project together.
Co-Founder, Emerge
The team is great to work with. Very professional, on task, and efficient.
Founder, PeriopMD
I can not express enough how pleased we are with the whole team. From the first call and meeting, they took our vision and ran with it. Communication was easy and everyone was flexible to our schedule. I’m excited to...
Founder, Seeke
We had very close go live timeline and Mindbowser team got us live a month before.
CEO, BuyNow WorldWide
If you want a team of great developers, I recommend them for the next project.
Founder, Teach Reach
Mindbowser built both iOS and Android apps for Mindworks, that have stood the test of time. 5 years later they still function quite beautifully. Their team always met their objectives and I'm very happy with the end result. Thank you!
Founder, Mindworks
Mindbowser has delivered a much better quality product than our previous tech vendors. Our product is stable and passed Well Architected Framework Review from AWS.
CEO, PurpleAnt
I am happy to share that we got USD 10k in cloud credits courtesy of our friends at Mindbowser. Thank you Pravin and Ayush, this means a lot to us.
CTO, Shortlist
Mindbowser is one of the reasons that our app is successful. These guys have been a great team.
Founder & CEO, MangoMirror
Kudos for all your hard work and diligence on the Telehealth platform project. You made it possible.
CEO, ThriveHealth
Mindbowser helped us build an awesome iOS app to bring balance to people’s lives.
CEO, SMILINGMIND
They were a very responsive team! Extremely easy to communicate and work with!
Founder & CEO, TotTech
We’ve had very little-to-no hiccups at all—it’s been a really pleasurable experience.
Co-Founder, TEAM8s
Mindbowser was very helpful with explaining the development process and started quickly on the project.
Executive Director of Product Development, Innovation Lab
The greatest benefit we got from Mindbowser is the expertise. Their team has developed apps in all different industries with all types of social proofs.
Co-Founder, Vesica
Mindbowser is professional, efficient and thorough.
Consultant, XPRIZE
Very committed, they create beautiful apps and are very benevolent. They have brilliant Ideas.
Founder, S.T.A.R.S of Wellness
Mindbowser was great; they listened to us a lot and helped us hone in on the actual idea of the app. They had put together fantastic wireframes for us.
Co-Founder, Flat Earth
Ayush was responsive and paired me with the best team member possible, to complete my complex vision and project. Could not be happier.
Founder, Child Life On Call
The team from Mindbowser stayed on task, asked the right questions, and completed the required tasks in a timely fashion! Strong work team!
CEO, SDOH2Health LLC
Mindbowser was easy to work with and hit the ground running, immediately feeling like part of our team.
CEO, Stealth Startup
Mindbowser was an excellent partner in developing my fitness app. They were patient, attentive, & understood my business needs. The end product exceeded my expectations. Thrilled to share it globally.
Owner, Phalanx
Mindbowser's expertise in tech, process & mobile development made them our choice for our app. The team was dedicated to the process & delivered high-quality features on time. They also gave valuable industry advice. Highly recommend them for app development...
Co-Founder, Fox&Fork
