← Back to the directory

goldbergyoni/nodebestpractices

Loading README…

_{Kevin Rambaud} 🖋	_{Michael Fine} 🖋	_{Shreya Dahal} 🖋	_{Matheus Cruz Rocha} 🖋	_{Yog Mehta} 🖋	_{Kudakwashe Paradzayi} 🖋	_t1st3 🖋
_{mulijordan1976} 🖋	_{Matan Kushner} 🖋	_{Fabio Hiroki} 🖋	_{James Sumners} 🖋	_{Dan Gamble} 🖋	_{PJ Trainor} 🖋	_{Remek Ambroziak} 🖋
_{Yoni Jah} 🖋	_{Misha Khokhlov} 🖋	_{Evgeny Orekhov} 🖋	_- 🖋	_{Isaac Halvorson} 🖋	_{Vedran Karačić} 🖋	_lallenlowe 🖋
_{Nathan Wells} 🖋	_{Paulo Reis} 🖋	_syzer 🖋	_{David Sancho} 🖋	_{Robert Manolea} 🖋	_{Xavier Ho} 🖋	_Aaron 🖋
_{Jan Charles Maghirang Adona} 🖋	_Allen 🖋	_{Leonardo Villela} 🖋	_{Michał Załęcki} 🖋	_{Chris Nicola} 🖋	_{Alejandro Corredor} 🖋	_cwar 🖋
_Yuwei 🖋	_{Utkarsh Bhatt} 🖋	_{Duarte Mendes} 🖋	_{Jason Kim} 🖋	_{Mitja O.} 🖋	_{Sandro Miguel Marques} 🖋	_Gabe 🖋
_{Ron Gross} 🖋	_{Valeri Karpov} 🖋	_{Sergio Bernal} 🖋	_{Nikola Telkedzhiev} 🖋	_{Vitor Godoy} 🖋	_{Manish Saraan} 🖋	_{Sangbeom Han} 🖋
_blackmatch 🖋	_{Joe Reeve} 🖋	_{Ryan Busby} 🖋	_{Iman Mohamadi} 🖋	_{Sergii Paryzhskyi} 🖋	_{Kapil Patel} 🖋	_迷渡 🖋
_Hozefa 🖋	_Ethan 🖋	_Sam 🖋	_Arlind 🖋	_{Teddy Toussaint} 🖋	_Lewis 🖋	_{Gabriel Lidenor} 🖋
_Roman 🖋	_Francozeira 🖋	_Invvard 🖋	_{Rômulo Garofalo} 🖋	_{Tho Q Luong} 🖋	_{Burak Shen} 🖋	_{Martin Muzatko} 🖋
_{Jared Collier} 🖋	_{Hilton Meyer} 🖋	_{ChangJoo Park(박창주)} 🖋	_{Masahiro Sakaguchi} 🖋	_{Keith Holliday} 🖋	_coreyc 🖋	_{Maximilian Berkmann} 🖋
_{Douglas Mariano Valero} 🖋	_{Marcelo Melo} 🖋	_{Mehmet Perk} 🖋	_{ryan ouyang} 🖋	_Shabeer 🖋	_{Eduard Kyvenko} 🖋	_{Deyvison Rocha} 🖋
_{George Mamer} 🖋	_{Konstantinos Leimonis} 🖋	_{Oliver Lluberes} 🌍	_{Tien Do} 🖋	_{Ranvir Singh} 🖋	_{Vadim Nicolaev} 🖋 🌍	_{German Gamboa Gonzalez} 🖋
_Hafez 🖋	_Chandiran 🖋	_{VinayaSathyanarayana} 🖋	_{Kim Kern} 🖋	_{Kenneth Freitas} 🖋	_songe 🖋	_{Kirill Shekhovtsov} 🖋
_Serge 🖋	_keyrwinz 🖋	_{Dmitry Nikitenko} 🖋	_bushuai 👀 🖋	_{Benjamin Gruenbaum} 🖋	_Ezequiel 🌍	_{Juan José Rodríguez} 🌍
_{Or Bin} 🖋	_{Andreo Vieira} 🖋	_{Michael Solomon} 🖋	_{Jimmy Callin} 🖋	_Siddharth 🖋	_{Ryan Smith} 🖋	_{Tom Boettger} 🖋
_{Joaquín Ormaechea} 🌍	_dfrzuz 🌍	_{Victor Homyakov} 🖋	_Josh 🖋 🛡️	_{Alec Francis} 🖋	_arjun6610 🖋	_{Jan Osch} 🖋
_{Thiago Rotondo Sampaio} 🌍	_Alexsey 🖋	_{Luis A. Acurero} 🌍	_{Lucas Romano} 🌍	_{Denise Case} 🖋	_{Nick Ribal} 🖋 👀	_0xflotus 🖋
_{Jonathan Chen} 🖋	_{Dilan Srilal} 🖋	_{vladthelittleone} 🌍	_{Nik Osvalds} 🖋	_{Daniel Kiss} 📖	_Forresst 🖋	_{Jonathan Svenheden} 🖋
_AustrisC 🖋	_{kyeongtae kim} 🌍	₀₀₇ 🖋	_{Ane Diaz de Tuesta} 🌍 🖋	_YukiOta 🌍	_{Frazer Smith} 🖋	_{Raz Luvaton} 🖋
_{Yuta Azumi} 🖋	_{andrewjbarbour} 🖋	_mr 🖋	_Aleksandar 🖋	_Owl 🖋	_{Yedidya Schwartz} 🖋 💡	_ari 🖋
_{Thomas König} 🖋	_{Kalle Lämsä} 🖋	_Wyatt 🖋	_{KHADIR Tayeb} 🖋	_{Shankar Regmi} 🖋	_Shubham 🖋	_{Lucas Alves} 🖋
_Benjamin 🖋	_{Yeoh Joer} 🖋	_Miigon 🖋	_{Rostislav Bogorad} 🖋	_Flouse 🖋	_{Tarantini Pereira} 🖋	_{Kazuki Matsuo} 🖋
_{Adam Smith} 🖋	_{Dohyeon Ko} 🖋	_{Vladislav Legkov} 🖋	_{Kerollos Magdy} 🖋	_{Erez Lieberman} 🖋	_{Breno Macedo} 🖋	_{Fernando Flores} 🌍
_{Rafael Brito} 🌍	_{Emiliano Peralta} 🌍	_{Shin, SJ} 🖋	_{Benjamin Forster} 🖋	_{Daniele Fedeli} 🖋	_djob195 🖋	_antspk 🖋
_정진영 🖋	_kkk-cashwalk 🖋	_{apainintheneck} 🖋	_{Fajar Budhi Iswanda} 🖋	_이주호 🖋	_Singh 🖋	_{Alex Dumitru} 🖋
_{Anton Lykhatskyi} 🖋	_sangwonlee 🖋	_{Eugenio Berretta} 🖋	_soranakk 🖋	_고준영 🖋 💻	_{Guilherme Portella} 🖋	_{André Esser} 🖋
_Scc 🌍	_{Mauro Accornero} 🖋	_no-yan 🖋	_hodbauer 🌍

Node.js Best Practices

🎊 2026 edition is here!

Welcome! 3 Things You Ought To Know First

By Yoni Goldberg

Learn with me: As a consultant, I engage with worldwide teams on various activities like workshops and code reviews. 🎉AND... Hold on, I've just launched my beyond-the-basics testing course, which is on a 🎁 limited-time sale until August 7th

Table of Contents

1. Project Architecture Practices

1.1 Structure your solution by business components

📝 #updated

1.2 Layer your components with 3-tiers, keep the web layer within its boundaries

📝 #updated

1.3 Wrap common utilities as packages, consider publishing

1.4 Use environment aware, secure and hierarchical config

📝 #updated

1.5 Consider all the consequences when choosing the main framework

🌟 #new

1.6 Use TypeScript sparingly and thoughtfully

🌟 #new

2. Error Handling Practices

2.1 Use Async-Await or promises for async error handling

2.2 Extend the built-in Error object

📝 #updated

2.3 Distinguish catastrophic errors from operational errors

📝 #updated

2.4 Handle errors centrally, not within a middleware

2.5 Document API errors using OpenAPI or GraphQL

2.6 Exit the process gracefully when a stranger comes to town

2.7 Use a mature logger to increase errors visibility

📝 #updated

2.8 Test error flows using your favorite test framework

📝 #updated

2.9 Discover errors and downtime using APM products

2.10 Catch unhandled promise rejections

📝 #updated

2.11 Fail fast, validate arguments using a dedicated library

2.12 Always await promises before returning to avoid a partial stacktrace

🌟 #new

2.13 Subscribe to event emitters and streams 'error' event

🌟 #new

3. Code Patterns And Style Practices

3.1 Use ESLint

3.2 Use Node.js eslint extension plugins

📝 #updated

3.3 Start a Codeblock's Curly Braces on the Same Line

Code Example

3.4 Separate your statements properly

Code example

3.5 Name your functions

3.6 Use naming conventions for variables, constants, functions and classes

3.6 Code Example

3.7 Prefer const over let. Ditch the var

3.8 Require modules first, not inside functions

3.9 Set an explicit entry point to a module/folder

📝 #updated

3.9 Code example - avoid coupling the client to the module structure

3.10 Use the === operator

3.10 Code example

3.11 Use Async Await, avoid callbacks

3.12 Use arrow function expressions (=>)

3.13 Avoid effects outside of functions

🌟 #new

4. Testing And Overall Quality Practices

4.1 At the very least, write API (component) testing

4.2 Include 3 parts in each test name

🌟 #new

4.3 Structure tests by the AAA pattern

🌟 #new

4.4 Ensure Node version is unified

🌟 #new

4.5 Avoid global test fixtures and seeds, add data per-test

4.6 Tag your tests

4.7 Check your test coverage, it helps to identify wrong test patterns

4.8 Use production-like environment for e2e testing

4.9 Refactor regularly using static analysis tools

4.10 Mock responses of external HTTP services

🌟 #new

4.11 Test your middlewares in isolation

4.12 Specify a port in production, randomize in testing

🌟 #new

4.13 Test the five possible outcomes

`1. Project Architecture Practices`

`📝 #updated`

`📝 #updated`

`📝 #updated`

`🌟 #new`

`🌟 #new`

`2. Error Handling Practices`

`📝 #updated`

`📝 #updated`

`📝 #updated`

`📝 #updated`

`📝 #updated`

`🌟 #new`

`🌟 #new`

`3. Code Patterns And Style Practices`

`📝 #updated`

`📝 #updated`

3.10 Use the `===` operator

`🌟 #new`

`4. Testing And Overall Quality Practices`

`🌟 #new`

`🌟 #new`

`🌟 #new`

`🌟 #new`

`🌟 #new`

`🌟 #new`

`5. Going To Production Practices`

`📝 #updated`

5.15. Set `NODE_ENV=production`

`📝 #updated`

5.19. Install your packages with `npm ci`

`6. Security Best Practices`

`🌟 #new`

`7. Draft: Performance Best Practices`

`8. Docker Best Practices`

8.2. Bootstrap using `node` command, avoid `npm start`

8.9. Use explicit image reference, avoid `latest` tag