DEV Community

How to Write Clean Code: Refactoring and Best Practices.

Balraj Singh on November 14, 2024

We’ve all been there – staring down code that should work but is practically unreadable. And let’s be real: every developer (yes, every single one ...

Read full post

Vitaliy Potapov • Nov 16 • Edited

Thanks for the article!
Here is the eslint config, that I use in my projects to follow the clean code rules:

rules: {
  complexity: ['error', { max: 6 }],
  'max-depth': ['error', { max: 2 }],
  'max-nested-callbacks': ['error', { max: 2 }],
  'max-params': ['error', { max: 3 }],
  'max-statements': ['error', { max: 12 }, { ignoreTopLevelFunctions: false }],
  'max-len': ['error', { code: 120, ignoreUrls: true }],
  'max-lines': ['error', { max: 200, skipComments: true, skipBlankLines: true }],
  'max-lines-per-function': ['error', { max: 30, skipBlankLines: true, skipComments: true }],
},

Balraj Singh • Nov 16

Wow. Perfect!

Sami • Nov 16

Eslint can check this wow. Thanks

Lakhan Jindam • Nov 15

Good points!
I think refactoring should be done proactively but if it's affecting your deliverables then at least it should be tracked in your project management software otherwise it keeps on piling and becomes a tech debt eventually :(

Balraj Singh • Nov 16

Proactive refactoring is ideal, but when timelines are tight, tracking it in your project management tool is crucial. It not only keeps it visible but also ensures it gets prioritized before turning into a full-blown tech debt crisis. Balancing progress with maintenance is always tricky, but good tracking helps!

Balraj Singh • Nov 16

You're absolutely right!

Nasrul Hazim Bin Mohamad • Nov 15

a great place to learn about refactoring - refactoring.guru/

Balraj Singh • Nov 16

Thanks for sharing!

Djamel Bougouffa • Nov 15

Thanks for sharing these valuable insights.
Clean code is indeed an art that every developer should strive to master!

Balraj Singh • Nov 16

True that!

Anup Khismatrao • Nov 15

Great article

Balraj Singh • Nov 16

Thank you!

Ibrahima DIALLO • Nov 17

I would like to have more clarification regarding SOLID principles

But nevertheless, this is a useful article

KRowin • Nov 17

Good, solid article, now I know that principles I’ve learned without formal coding education have a fancy corporate like names which I can throw around to refactor the discussion. :)

Dev Patel • Nov 20

test