DEV Community

Cover image for You need to write CSS like that to improve your code quality 🧐
Lucas Romero Di Benedetto
Lucas Romero Di Benedetto

Posted on

You need to write CSS like that to improve your code quality 🧐

Hi everyone. This is my first post in DEV πŸ₯³
I'm from Argentina and i'm currently working at Aerolab.co ❀️ as a UI dev.

This post will be about how to write better CSS (TL;DR)

The problem πŸ™ˆ

  • Unorganized properties in a CSS selector
  • Sometimes, every developer write code according their own rules and preferences
  • Hard to maintain
  • Code smells
  • Bad code quality

Approach πŸ‘€

  • Organize the CSS properties
  • Separate CSS properties into categories
/* Concept */
.selector {
  /* layout */
  /* position and dimensions */
  /* margin and padding */
  /* box enhancements */
  /* font enhancements */
  /* others */
}

Advantages πŸ™Œ

  • Better readability across devs and teams
  • Avoid possible redundant code
  • Easy refactoring
  • Easy to find some property
  • Easy to explain
  • Better code quality

Examples

The wrong way 🀒

The following is a really bad example, it works of course, but you need to avoid this type of code because it is hard to read and maintain. When you write code like this you are dropping the quality of your code and you are spreading bad practices to your teammates.

/* Avoid coding like this*/

.myBadClass {
  font-family: sans-serif;
  font-size: 22px;
  background-color: silver;
  border: 1px solid gray;
  box-shadow: 0 0 3px 20px black;
  display: flex;
  margin-right: auto;
  margin-left: auto;
  padding: 20px;
  margin-bottom: 30px;
  overflow: hidden;
  width: 100%;
  height: 50px;
  top: 0;
  border-radius: 7px;
  flex-direction: column;
  justify-content: center;
  cursor: crosshair;
  align-items: center;
  color: black;
  line-height: 1.5;
  position: relative;
}

The best way 😎

The following is a better way to write CSS, because it is better structured and easy to read. Just start proposing good practices so that your teammates also acquire them.

/* Do this way */

.myGoodClass {
  display: flex;
  flex-direction: column;
  justify-content: center;
  align-items: center;

  position: relative;
  top: 0;
  width: 100%;
  height: 50px;

  margin-left: auto;
  margin-right: auto;
  margin-bottom: 30px;
  padding: 20px;

  background-color: silver;
  border: 1px solid gray;
  border-radius: 7px;
  box-shadow: 0 0 3px 20px black;

  font-family: sans-serif;
  font-size: 22px;
  color: black;
  line-height: 1.5;

  overflow: hidden;
  cursor: crosshair;
}

If you have a small set of properties you can following the same pattern. Follow the example below.

.myOtherGoodClass {
  display: flex;
  flex-direction: column;
  justify-content: center;
  align-items: center;

  color: black;

  overflow: hidden;
}

Feedback πŸ‘‚

  • What do you think about this practice?
  • How do you write better CSS?
  • Are you considering apply this on future projects?
  • If not agree whit this pattern. Why?
  • Any other way to keep writing better CSS?

Have a good week! and Thanks for reading πŸ™‚

Discussion (0)