If you have worked on a decently sized Node.js application regardless of whether its JavaScript or TypeScript, you will have come across long imports such as these:

import User from "../../../../models/User";

which made you go:

Rewriting long imports hundreds of times can get on anyone's nerves. This article with show you how to compress those long imports into compact and short imports. After all:

Shorter Code == Happier Devs 😉

Enter `jsconfig.json`

What is jsconfig.json? you might be asking. Well, jsconfig.json can be thought of as a descendent of tsconfig.json, with the allowJs attribute set to true.

In simple terms, jsconfig.json is a file that specifies that the directory is the root of a JavaScript project. The tsconfig.json & jsconfig.json file specifies the root files and the compiler options required to compile the project.

For more on jsconfig.json, check out this article.

For Demonstration purpose, we would be working on a demo project with the following file structure:

.
│   app.js
│   jsconfig.json
│   package.json
│   
├───models
│       user.js
│       
└───utils
    ├───colors
    │       converter.js
    │       generateColor.js
    │       
    └───datetime
            formatter.js
            timezoneHelpers.js

Base Url

The easiest way to get rid of the long imports is to add baseUrl in the jsconfig.json (add jsconfig.json at the root level of the project in case you don't have it).

{
    "compilerOptions": {
        "baseUrl": "."
    }
}

Viola! Now you can directly access the files and folders at the root level of your project. So to import color related functions in the User model, you can now use:

import { hexToRgb, rgbToHex } from 'utils/colors/converter'

in place of:

import { hexToRgb, rgbToHex } from '../utils/colors/converter'

That's just a minor improvement in this demo, but in case your project has a lot of nested folders, it would lead to significant reductions.

But let's try to do better.

Paths

Paths allow us to aggregate a list directories under a predefined name and drastically reduce the length of the imports.

{
    "compilerOptions": {
        "baseUrl": ".",
        "paths": {
            "@models/*": [
                "./models/*"
            ],
            "@colors/*": [
                "./utils/colors/*"
            ],
            "@datetime/*": [
                "./utils/datetime/*"
            ]
        }
    }
}

We are aggregating all the files in the models folder under the name @models. The same is the case for colors and datetime. We would be able to reference the folders using @models, @colors, and @datetime in the import statement. So,

import { hexToRgb, rgbToHex } from '../utils/colors/converter'

finally reduces to:

import { hexToRgb, rgbToHex } from '@colors/converter'

Somethings worth noting:

The pathname doesn't have to be the same as the actual folder name. But it's a good idea to keep them the same to avoid confusion.
You can aggregate as many folders you want under any pathname. Let's take a look at a bit absurd example:
```
"@colors/*": [
    "./utils/colors/*",
    "./utils/datetime/*"
]
```
This would result in both the datetime and colors folders to be aggregated under the name @colors.

TypeScript

Everything we went over can be used with TypeScript as well. Just replace jsconfig.json with tsconfig.json and you are done.

NOTE: As TalOrlanczyk pointed out in the comments, this doesn't work with create-react-app. The work-around is provided in the comments below.

Wrapping up

This article went through how to optimize the annoying long imports into concise small statements. I hope this helps you in your development journey! :)

Finding personal finance too intimidating? Checkout my Instagram to become a Dollar Ninja

Thanks for reading

Want to work together? Contact me on Upwork

Want to see what I am working on? Check out my GitHub

I am a freelancer who will start off as a Digital Nomad in mid-2022. Want to catch the journey? Follow me on Instagram

Follow my blogs for weekly new tidbits on Dev

FAQ

These are a few commonly asked questions I get. So, I hope this FAQ section solves your issues.

I am a beginner, how should I learn Front-End Web Dev?
Look into the following articles:
1. Front End Development Roadmap
2. Front End Project Ideas
Would you mentor me?

Sorry, I am already under a lot of workload and would not have the time to mentor anyone.
Would you like to collaborate on our site?

As mentioned in the previous question, I am in a time crunch, so I would have to pass on such opportunities.

Connect to me on

How Pros Get Rid of Relative Imports

Enter jsconfig.json