Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/metroxe/relative-to-alias-resolver
Transform your TypeScript project with ease using the relative-to-alias-resolver. This powerful tool converts cumbersome relative imports into clean, maintainable alias imports, enhancing code readability and maintainability.
https://github.com/metroxe/relative-to-alias-resolver
aliases build-process cli-tool code-maintainability code-readability developer-tools npm-package tsconfig typescript
Last synced: 2 months ago
JSON representation
Transform your TypeScript project with ease using the relative-to-alias-resolver. This powerful tool converts cumbersome relative imports into clean, maintainable alias imports, enhancing code readability and maintainability.
- Host: GitHub
- URL: https://github.com/metroxe/relative-to-alias-resolver
- Owner: Metroxe
- Created: 2024-10-24T00:57:18.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-10-24T06:30:45.000Z (3 months ago)
- Last Synced: 2024-11-01T01:06:13.180Z (2 months ago)
- Topics: aliases, build-process, cli-tool, code-maintainability, code-readability, developer-tools, npm-package, tsconfig, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/relative-to-alias-resolver
- Size: 169 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Relative to Alias Resolver
[](https://www.npmjs.com/package/relative-to-alias-resolver)
## 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:
```typescript
// Before conversion
import { MyComponent } from '../../../components/MyComponent';
import { utilFunction } from '../../utils/utilFunction';
```
to this:
```typescript
// 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:
```bash
npm install -g relative-to-alias-resolver
```
if you intend to use the library in your project, you can install it locally:
```bash
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:
```bash
relative-to-alias-resolver --project --tsconfig
```
#### Options
- `-p, --project `: The path to the project to generate alias imports for. Defaults to `.`.
- `-t, --tsconfig `: 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 `: A comma-separated list of regex patterns for paths to ignore. Defaults to `["node_modules"]`.
- `-v, --verbose`: Enable verbose logging. Defaults to `false`.
#### Example
```bash
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.
```typescript
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`:
```json
{
"compilerOptions": {
"baseUrl": ".",
"paths": {
"@/*": ["src/*"]
}
}
}
```