Skip to content

Latest commit

 

History

History
108 lines (75 loc) · 3.15 KB

README.md

File metadata and controls

108 lines (75 loc) · 3.15 KB
Raw

Relative to Alias Resolver

npm version

Overview

The Relative to Alias Resolver is a tool designed to convert a TypeScript project from using relative imports to alias imports. This can help improve the readability and maintainability of your codebase by using more descriptive import paths.

For example, it can transform your imports from this:

// Before conversion
import { MyComponent } from '../../../components/MyComponent';
import { utilFunction } from '../../utils/utilFunction';

to this:

// After conversion
import { MyComponent } from '@/components/MyComponent';
import { utilFunction } from '@/utils/utilFunction';

This makes your code cleaner and easier to maintain, especially in larger projects.

Why Use This Package?

  • Improved Code Readability: Alias imports make your code cleaner and easier to navigate.
  • Enhanced Maintainability: Simplifies refactoring and reduces the risk of import path errors.
  • Seamless Integration: Easily integrates with existing TypeScript projects and build processes.

Features

  • Converts relative imports to alias imports based on your tsconfig.json configuration.
  • Supports both CommonJS and ES Module formats.
  • Provides a CLI for easy integration into your build process.
  • Includes options for dry runs before modifying your project.

Installation

To install the package cli, use npm:

npm install -g relative-to-alias-resolver

if you intend to use the library in your project, you can install it locally:

npm install relative-to-alias-resolver

Usage

CLI

The package provides a command-line interface to perform the conversion. You can use it as follows:

relative-to-alias-resolver --project <path-to-project> --tsconfig <path-to-tsconfig>

Options

  • -p, --project <path>: The path to the project to generate alias imports for. Defaults to ..
  • -t, --tsconfig <path>: The path to the tsconfig.json file to use for the project. Defaults to ./tsconfig.json.
  • -d, --dry-run: Whether to run the command in dry run mode. Defaults to false.
  • -i, --ignore <patterns>: A comma-separated list of regex patterns for paths to ignore. Defaults to ["node_modules"].
  • -v, --verbose: Enable verbose logging. Defaults to false.

Example

relative-to-alias-resolver --project ./project --tsconfig ./project/tsconfig.json

Library

The library can be used to convert relative imports to alias imports in a TypeScript project.

import { resolveRelativeToAlias } from "relative-to-alias-resolver";

resolveRelativeToAlias({
  projectPath: "./src",
  tsconfigPath: "./tsconfig.json",
  dryRun: true,
  ignore: ["node_modules"],
});

Configuration

The tool relies on the tsconfig.json file to determine the base URL and paths for aliasing. Ensure your tsconfig.json is correctly configured with the baseUrl and paths properties.

Example tsconfig.json:

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