path-alias-cli

Manage and resolve TypeScript/JavaScript path aliases from tsconfig.json.

Installation

npm install -g path-alias-cli

Usage

List all aliases

path-alias-cli list
path-alias-cli list -p ./tsconfig.json
path-alias-cli list --json

Resolve an alias

path-alias-cli resolve @utils/helpers
path-alias-cli resolve @components/Button --json

Check alias health

Verify that all alias target directories actually exist on disk:

path-alias-cli check
path-alias-cli check -p ./tsconfig.app.json
path-alias-cli check --json

Options

| Option | Description | |---|---| | -p, --project <path> | Path to tsconfig.json (default: ./tsconfig.json) | | --json | Output results as JSON | | -V, --version | Show version number | | -h, --help | Show help |

Example

Given a tsconfig.json:

{
  "compilerOptions": {
    "baseUrl": ".",
    "paths": {
      "@utils/*": ["src/utils/*"],
      "@components/*": ["src/components/*"]
    }
  }
}

$ path-alias-cli list

  Path Aliases

Alias            Pattern              Resolved Path
────────────────────────────────────────────────────
@utils/*         src/utils/*          /project/src/utils
@components/*    src/components/*     /project/src/components

Total: 2 alias(es)

License

MIT