TS Import Refiner

TSImportRefiner is a powerful jscodeshift script designed to optimize and sort TypeScript imports based on path aliases defined in tsconfig.json. It automates the refactoring of import statements, making your codebase cleaner and more maintainable.

Before	After

Features

Alias Conversion: Converts module paths to aliases as defined in your tsconfig.json.
Sort Imports: Sorts import statements based on line length.
Seamless Integration: Works with existing TypeScript projects with minimal setup.

Prerequisites

Before you begin, ensure you have installed Node.js and jscodeshift:

npm install -g jscodeshift

Installation

Install TSImportRefiner globally via npm:

npm install -g tsimportrefiner

Usage

To refactor a file or a directory of files, run:

tsimportrefiner <path> [options]

Where <path> can be a single file or a directory. [options] are optional arguments that you would normally pass to jscodeshift.

Example

tsimportrefiner ./src --extensions=ts,tsx

This command will process all .ts and .tsx files in the src directory.

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

Fork the Project
Create your Feature Branch (git checkout -b feature/AmazingFeature)
Commit your Changes (git commit -m 'Add some AmazingFeature')
Push to the Branch (git push origin feature/AmazingFeature)
Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Acknowledgements

Feel free to adjust the contents to fit the specifics of your project better, such as adding more detailed usage instructions, screenshots, or additional sections as necessary.

AliRezaBeigy/TSImportRefiner