Simple Import Replacement

A script to replace relative imports with absolute imports in TypeScript and JavaScript files.

Description

This script processes files in your project directory and converts relative import paths to absolute import paths based on the specified root directory. It supports ts, tsx, js, and jsx file extensions.

Installation

Local Installation

You can install the package locally as a development dependency:

npm install --save-dev simple-import-replacement

or using yarn:

yarn add --dev simple-import-replacement

Global Installation

You can install the package globally:

npm install -g simple-import-replacement

or using yarn:

yarn global add simple-import-replacement

Using npx

You can run the script directly using npx without installing it:

npx simple-import-replacement --root-dir /path/to/your/project/src **/*.{ts,tsx,js,jsx}

Usage

Local Installation

Add a script to your package.json:

{
  "scripts": {
    "replace-imports": "simple-import-replacement --root-dir /path/to/your/project/src **/*.{ts,tsx,js,jsx}"
  }
}

Run the script:

npm run replace-imports

or using yarn:

yarn replace-imports

Global Installation

Run the script directly:

replace-imports --root-dir /path/to/your/project/src **/*.{ts,tsx,js,jsx}

Using npx

Run the script using npx:

npx simple-import-replacement --root-dir /path/to/your/project/src **/*.{ts,tsx,js,jsx}

Additional Examples

Single File

npx simple-import-replacement --root-dir /path/to/your/project/src src/com/test/foo/bar/example.ts

Two Files

npx simple-import-replacement --root-dir /path/to/your/project/src src/com/test/foo/bar/example.ts src/com/test/foo/another/anotherThing.ts

Only TypeScript Files

npx simple-import-replacement --root-dir /path/to/your/project/src **/*.ts

Only JavaScript Files

npx simple-import-replacement --root-dir /path/to/your/project/src **/*.js

TypeScript Family Files (ts and tsx)

npx simple-import-replacement --root-dir /path/to/your/project/src **/*.{ts,tsx}

Example

Suppose you have a project structure as follows:

/path/to/your/project/src/
├── com/
│   ├── test/
│   │   ├── foo/
│   │   │   ├── bar/
│   │   │   │   └── example.ts
│   │   │   └── another/
│   │   │       └── anotherThing.ts
│   └── components/
│       └── MyComponent.ts

And your example.ts file contains the following imports:

import something from './something';
import anotherThing from '../another/anotherThing';
import React from 'react';
export { MyComponent } from '../../components/MyComponent';

Running the script:

npx simple-import-replacement --root-dir /path/to/your/project/src **/*.{ts,tsx,js,jsx}

will update example.ts to:

import something from 'com/test/foo/bar/something';
import anotherThing from 'com/test/foo/another/anotherThing';
import React from 'react';
export { MyComponent } from 'com/components/MyComponent';

Contributing

Feel free to open issues or submit pull requests if you find bugs or have suggestions for improvements.

License

This project is licensed under the MIT License.