import-alias-file

v2.0.1

Published

21 days ago

Import files via @ alias without having to manually enter ../ several times

Downloads

547

0High
0Medium
0Low

kirasiris

nextjs alias files filesystem file-system import files-import nodejs

v2.0.0 Breaking Changes

Import Alias File has received some upgrades and some of the old code has become obsolete and no longer useful

// Change all instances of this line
const lookFile = require("import-alias-file");
// to the new lookFile method
const { lookFile } = require("import-alias-file");

Pre-requisites

You will need NodeJS installed in your machine/project in order to load both the path and fs libraries.

npm i node

Install

npm i import-alias-file

Description

This npm library eases the process of importing files within a nodejs project. The way it works it's similar to NextJS!.

I made it after getting tired of using ../ multiple times when I needed to use a function that was placed in a different file!

Usage

const express = require("express");

// const lookFile = require("import-alias-file");
const { lookFile } = require("import-alias-file");

const { getBlogs, getBlog, createBlog } = lookFile("@/controllers/blogs"); // <- That
// Instead of this, require('../../../../controllers/blogs');

const Blog = lookFile("@/models/Blog"); // <- That
// Instead of this, require('../../../models/Blog);

const router = express.Router();

router.route("/").get(getBlogs).post(createBlog);

router.route("/:id").get(getBlog);

module.exports = router;

Extensions

You can specify the file extension as well.

// This is the same
const { getBlogs, getBlog, createBlog } = lookFile("@/controllers/blogs");
const Blog = lookFile("@/models/Blog");
// as this
const { getBlogs, getBlog, createBlog } = lookFile("@/controllers/blogs.js");
const Blog = lookFile("@/models/Blog.js");

The extensions supported so far are .js, .json, and .ts.

Community

The import-alias-file community can be found on GitHub Discussions where you can ask questions and voice ideas.