Shorten import paths in TypeScript

Written byPhuoc Nguyen

Tags

TypeScript

Created

16 Mar, 2021

In TypeScript, we often use the relative path to import a particular file. Here is an example of importing multiple files from the `helper` and `services` folder:

import { validator } from '../../../helpers/validator';
import { authService } from '../../../services/authService';

The disadvantage is that when we change the directory structure, these imports must be updated accordingly. Despite the fact that popular editors such as Visual Studio Code updates the paths automatically, it doesn't ensure that the process works all the time.

Fortunately, TypeScript provides the ability of using the absolute paths. In the TypeScript configuration file, `tsconfig.json`, we can indicate the alias for particular paths under the `paths` property.

For example, the following settings will find all imports starting with `@` in the `src` folder:

{
    "paths": {
        "@/*": ["src/*"]
    }
}

Import path	Identical absolute path
`@/helpers/validator`	`src/helpers/validator`
`@/services/authService`	`src/services/authService`

Our imports can be shorten as following:

import { validator } from '@/helpers/validator';
import { authService } from '@/services/authService';

Some libraries, Angular for instance, follows a specific pattern of directory structure, we can pre-define the path for given folders:

{
    "paths": {
        "@helpers/*": ["src/helpers/*"],
        "@models/*": ["src/models/*"],
        "@services/*": ["src/services/*"]
    }
}

Then the imports of files belonging to these folders can be shorten as below:

import { validator } from '@helpers/validator';
import { userModel } from '@models/user';
import { authService } from '@services/authService';

#See also

Shorten import paths in Webpack

Questions? 🙋

Do you have any questions? Not just about this specific post, but about any topic in front-end development that you'd like to learn more about? If so, feel free to send me a message on Twitter or send me an email. You can find them at the bottom of this page.

I have a long list of upcoming posts, but your questions or ideas for the next one will be my top priority. Let's learn together! Sharing knowledge is the best way to grow 🥷.

Newsletter 🔔

If you're into front-end technologies and you want to see more of the content I'm creating, then you might want to consider subscribing to my newsletter.

By subscribing, you'll be the first to know about new articles, products, and exclusive promotions.

Don't worry, I won't spam you. And if you ever change your mind, you can unsubscribe at any time.

Phước Nguyễn

Shorten import paths in TypeScript

#See also

Questions? 🙋

Recent posts ⚡

Newsletter 🔔