craco-alias

craco-alias

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

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

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")

/* craco.config.js */

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

module.exports = {
  plugins: [
    {
      plugin: CracoAlias,
      options: {
        source: "tsconfig",
        // as you know, CRA doesn't allow to modify tsconfig's compilerOptions
        // so you should create a separate JSON file and extend tsconfig.json from it
        // and then just specify its path here:
        tsConfigPath: "tsconfig.paths.json"
      }
    }
  ]
};

/* tsconfig.paths.json */

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