sync-path-alias

Alias Sync Tool

Alias Sync Tool is an NPM package designed to synchronize path aliases between tsconfig.json (TypeScript) and babel.config.js (Babel) configurations. It ensures consistency across both configurations, allowing you to define aliases in one file and automatically propagate them to the other.

Features

Bidirectional synchronization between TypeScript (tsconfig.json) and Babel (babel.config.js). Command-line flags to specify which config file is the source of truth. Automatic detection of the most recently modified file and use of its aliases as the source. Safely removes old aliases and adds the new ones without causing duplication or conflict. Works seamlessly with Babel's module-resolver plugin and TypeScript's paths property.

Installation

You can install the package globally or locally in your project.

Global Installation

npm install -g alias-sync-tool

Local Installation

npm install alias-sync-tool --save-dev

Usage

Once installed, you can use the alias-sync command to sync aliases between tsconfig.json and babel.config.js.

CLI Commands

alias-sync [options]

Options

--babel <path>: Path to the Babel configuration file (default: babel.config.js).

--tsconfig <path>: Path to the TypeScript configuration file (default: tsconfig.json).

--prefer-tsconfig: Use tsconfig.json as the source of truth and update babel.config.js based on its aliases.

--prefer-babel: Use babel.config.js as the source of truth and update tsconfig.json based on its aliases.

Example Configuration

tsconfig.json

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

babel.config.js

module.exports = {
  presets: ['module:metro-react-native-babel-preset'],
  plugins: [
    [
      'module-resolver',
      {
        root: ['./src'],
        extensions: ['.js', '.jsx', '.ts', '.tsx', '.json'],
        alias: {
          '@components': './src/components',
          '@utils': './src/utils'
        }
      }
    ]
  ]
};

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request or open an Issue.

Author

Developed by Naman Dhingra.