npmpackage.info

Gathering detailed insights and metrics for craco-alias

Other packages similar to craco-alias

react-app-alias

2.2.2

Alias for craco or rewire react app

react-app-rewire-alias

1.1.7

Alias for craco or rewired create-react-app

@jswork/craco-plugin-alias

1.0.4

Alias plugin for craco.

react-app-alias-ex

2.1.0

Alias for craco or rewire react app

Gathering detailed insights and metrics for craco-alias

craco-alias - 3.0.1 | npmpackage.info

craco-alias

A craco plugin for automatic aliases generation for Webpack and Jest

3.0.1

109

MIT

JavaScript

37.44 kB

2.6

Installations

npm install craco-alias

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

12.22.1

NPM Version

6.14.12 Pull Requests

Open

5

Total

18

Closed

1

Merged

12

Issues

Open

8

Total

30

Closed

22

Releases

3.0.1

Updated on May 23, 2021

3.0.0

Updated on May 11, 2021

2.3.1

Updated on May 11, 2021

2.3.0

Updated on May 07, 2021

2.2.0

Updated on Feb 25, 2021

v2.1.1

Updated on Feb 23, 2020

View All 8 releases

Languages

JavaScript

Shell

JavaScript (99.75%)

Shell (0.25%)

Developer

risenforces

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

109 Stars

76 Commits

11 Forks

3 Watchers

6 Branches

4 Contributors

Updated on Mar 03, 2024

Maintainers

View All 4 Contributors

Package Meta Information

Latest Version

3.0.1

Package Id

craco-alias@3.0.1

Unpacked Size

37.44 kB

Size

9.76 kB

File Count

NPM Version

6.14.12

Node Version

12.22.1

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

@eslint-kit/eslint-config-base @eslint-kit/eslint-config-node @eslint-kit/eslint-config-prettier @types/jest babel-eslint eslint husky jest jest-serializer-path lint-staged prettier

craco-alias

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

Installation

Install craco

Install craco-alias:

1npm i -D craco-alias

1yarn add -D craco-alias

Edit craco.config.js:

1const CracoAlias = require("craco-alias");
2
3module.exports = {
4  plugins: [
5    {
6      plugin: CracoAlias,
7      options: {
8        // see in examples section
9      }
10    }
11  ]
12};

Go to Examples section

Options

source:
One of "options", "jsconfig", "tsconfig"
Optional, defaults to "options"
baseUrl:
A base url for aliases. (./src for example)
Optional, defaults to ./ (project root directory)
aliases:
An object with aliases names and paths
Only required when source is set to "options"
tsConfigPath:
A path to tsconfig file
Only required when source is set to "tsconfig"
filter: A function of type ([key, value]) => boolean
Optional, used to remove some aliases from the resulting config
Example: ([key]) => !key.startsWith('node_modules')
unsafeAllowModulesOutsideOfSrc:
Allow importing modules outside of ./src folder.
Disables webpack ModuleScopePlugin.
debug:
Enable it if you ran into a problem. It will log a useful info in console.
Optional, defaults to false

Examples

Specify aliases manually (source: "options")

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

1/* craco.config.js */
2
3const CracoAlias = require("craco-alias");
4
5module.exports = {
6  plugins: [
7    {
8      plugin: CracoAlias,
9      options: {
10        source: "options",
11        baseUrl: "./",
12        aliases: {
13          "@file": "./src/file.js",
14          "@dir": "./src/some/dir",
15          // you can alias packages too
16          "@material-ui": "./node_modules/@material-ui-ie10"
17        }
18      }
19    }
20  ]
21};

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

1/* craco.config.js */
2
3const CracoAlias = require("craco-alias");
4
5module.exports = {
6  plugins: [
7    {
8      plugin: CracoAlias,
9      options: {
10        source: "jsconfig",
11        // baseUrl SHOULD be specified
12        // plugin does not take it from jsconfig
13        baseUrl: "./src"
14      }
15    }
16  ]
17};

Note: your jsconfig should always have compilerOptions.paths property. baseUrl is optional for plugin, but some IDEs and editors require it for intellisense.

1/* jsconfig.json */
2
3{
4  "compilerOptions": {
5    "baseUrl": "./src",
6    "paths": {
7      // file aliases
8      "@baz": ["./baz.js"],
9      "@boo": ["./boo.jsx"],
10
11      // folder aliases
12      "@root": ["./"],
13      "@root/*": ["./*"],
14      "@lib": ["./lib"],
15      "@lib/*": ["./lib/*"],
16
17      // package aliases (types is optional without ts)
18      "@my-react-select": [
19        "../node_modules/react-select",
20        "../node_modules/@types/react-select"
21      ],
22      "@my-react-select/*": [
23        "../node_modules/react-select/*",
24        "../node_modules/@types/react-select"
25      ]
26    }
27  }
28}

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

Go to project's root directory.
Create tsconfig.extend.json.

Edit it as follows:

1{
2  "compilerOptions": {
3    "baseUrl": "./src",
4    "paths": {
5      // file aliases
6      "@baz": ["./baz.ts"],
7      "@boo": ["./boo.tsx"],
8
9      // folder aliases
10      "@root": ["./"],
11      "@root/*": ["./*"],
12      "@lib": ["./lib"],
13      "@lib/*": ["./lib/*"],
14
15      // package aliases
16      "@my-react-select": [
17        "../node_modules/react-select",
18        "../node_modules/@types/react-select"
19      ],
20      "@my-react-select/*": [
21        "../node_modules/react-select/*",
22        "../node_modules/@types/react-select"
23      ]
24    }
25  }
26}

Go to tsconfig.json.

Extend tsconfig.json from tsconfig.extend.json:

1{
2+ "extends": "./tsconfig.extend.json",
3  "compilerOptions": {
4    ...
5  },
6  ...
7}

Edit craco.config.js:

1const CracoAlias = require("craco-alias");
2
3module.exports = {
4  plugins: [
5    {
6      plugin: CracoAlias,
7      options: {
8        source: "tsconfig",
9        // baseUrl SHOULD be specified
10        // plugin does not take it from tsconfig
11        baseUrl: "./src",
12        // tsConfigPath should point to the file where "baseUrl" and "paths" are specified
13        tsConfigPath: "./tsconfig.extend.json"
14      }
15    }
16  ]
17};

Ran into a problem?

Make sure your config is valid.
Set debug to true in options.
Run application again.
Copy a printed info.
Here, create an issue describing your problem (do not forget to add the debug info).

If you want to help

Install:

1yarn

Use yarn please. npm may fail the dependencies installation.

Run tests:

yarn test

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

1

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Security-Policy

Determines if the project has published a security policy.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.6

/10

Last Scanned on 2025-06-30

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More