Receive notifications about upcoming Intlayer releases
    Creation:2024-08-11Last update:2025-11-22

    Transform components

    npx intlayer transform

    This command analyses your code files to help migrate existing components to use Intlayer. It supports interactive file selection or specific file targeting.

    Aliases:

    • npx intlayer trans

    Arguments:

    File selection options:

    • -f, --file [files...]: List of specific files to transform. If not provided, the CLI will scan for matching files (**/*.{tsx,jsx,vue,svelte,ts,js}) and prompt you to select which ones to transform.
    Example: npx intlayer transform -f src/components/MyComponent.tsx

    Output options:

    • -o, --output-content-declarations [outputContentDeclarations]: Directory to save the generated content declaration files.

      Example: npx intlayer transform -o src/content
    • --code-only: Only transform the component code (do not write content declaration).

      Example: npx intlayer transform --code-only
    • --declaration-only: Only generate content declaration (do not rewrite component).

      Example: npx intlayer transform --declaration-only

    Configuration options:

    • --base-dir: Specify the base directory for the project.
    • --env: Specify the environment.
    • --env-file: Provide a custom environment file.
    • --verbose: Enable verbose logging.

    Required plugins:

    The transform command works without additional plugins on TypeScript / JSX files. However, it requires the following plugins to be installed for Vue and Svelte projects:

    • @intlayer/vue-transformer: For Vue files.
    • @intlayer/svelte-transformer: For Svelte files.
    Receive notifications about upcoming Intlayer releases