craco-alias

craco-alias

A craco plugin for automatic aliases generation for Webpack and Jest.

:warning: The plugin does not fully support a module alises

List of Contents

• Installation
• Options
• Examples

Installation

1. Install craco

2. Install craco-alias:

   npm i -D craco-alias
   

3. Edit craco.config.js:

   const CracoAlias = require("craco-alias");
   
   module.exports = {
     plugins: [
       {
         plugin: CracoAlias,
         options: {
           // craco-alias options
           // please see below
         }
       }
     ]
   };
   

4. Go to Examples section

Options

• source: One of "options", "jsconfig", "tsconfig"
  Defaults to "options"

• aliases: An object with aliases names and paths
  Defaults to {}

• tsConfigPath: A path to tsconfig file
  Only required when source is set to "tsconfig"

Examples

Specify aliases manually (source: "options")

Note: you don't need to add /* part for directories in this case

/* craco.config.js */

const CracoAlias = require("craco-alias");

module.exports = {
  plugins: [
    {
      plugin: CracoAlias,
      options: {
        source: "options",
        aliases: {
          "@file": "src/file.js",
          "@dir": "src/some/dir"
        }
      }
    }
  ]
};

Use aliases from jsconfig.json (source: "jsconfig")

/* craco.config.js */

const CracoAlias = require("craco-alias");

module.exports = {
  plugins: [
    {
      plugin: CracoAlias,
      options: {
        source: "jsconfig"
      }
    }
  ]
};

Note: your jsconfig should always have baseUrl and paths properties

/* jsconfig.json */

{
  compilerOptions: {
    baseUrl: "src",
    paths: {
      "@file": ["file.js"],
      "@dir/*": ["dir/*", "dir"]
    }
  }
}

Use aliases from tsconfig.json (source: "tsconfig")

1. Go to project's root directory.

2. Create tsconfig.extend.json.

3. Edit it as follows:

   {
     "compilerOptions": {
       "baseUrl": "src",
       "paths": {
         "@file-alias": ["./your/file.tsx"],
         "@folder-alias/*": ["./very/long/path/*", "./very/long/path/"]
       }
     }
   }
   

4. Go to tsconfig.json.

5. Extend tsconfig.json from tsconfig.extend.json:

   {
   + "extends": "./tsconfig.extend.json",
     "compilerOptions": {
       ...
     },
     ...
   }
   

6. Edit craco.config.js:

   const CracoAlias = require("craco-alias");
   
   module.exports = {
     plugins: [
       {
         plugin: CracoAlias,
         options: {
           source: "tsconfig",
           // tsConfigPath should point to the file where "baseUrl" and "paths" are specified
           tsConfigPath: "./tsconfig.extend.json"
         }
       }
     ]
   };