Path Codegen

Path Codegen is a tool that automates path-based code generation for TypeScript projects. It analyzes the project's directory structure and generates type-safe path constants for each file and folder. By using generated constants instead of hard-coded strings, developers can reduce errors caused by typos or path changes and improve code maintainability.

usage#

You can run this tool directly using npx without any installation.

npx path-codegen <source-directory> [options]

• <source-directory>: (Required) The path to the directory you want to scan.
• -o, --output <file>: The name for the generated output file. (Default: path-codegen.ts)

Given a directory structure like this:

assets/
├── images/
│   ├── logo.png
│   └── icons/
│       └── home.svg
└── README.md

Running the following command:

npx path-codegen assets -o src/generated/paths.ts

Will generate the following file at src/generated/paths.ts:

export const ASSETS = {
  README: "/README.md",
  images: {
    icons: {
      home: "/icons/home.svg"
    },
    logo: "/images/logo.png"
  }
} as const;