npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2025 – Pkg Stats / Ryan Hefner

path-typegen

v2.0.0

Published

Typegen for path - Powered by JSON Schema

Downloads

256

Readme

path-typegen

CI Status npm version codecov

path-typegen is a library that converts file paths to TypeScript types

📦 Installation

npm i path-typegen

🚀 Usage

🔰 ph

Provides flexible path type processing using method chaining with map and filter.

Basic

// 📦 src/components/
//  ┣ 📂Button
//  ┃ ┗ 📜index.tsx
//  ┣ 📂Card
//  ┃ ┗ 📜index.tsx

ph('./src/components', './src/types/components.ts')
  .write()

// ./src/types/components.ts
export type PathType = './src/components/Button/index.tsx' | './src/components/Card/index.tsx'

Processing

Uses method chaining with map() and filter() for path transformations.

  • All operations are lazily evaluated until write() is called.
  • Use typed tagged template function for object type transformation
// 📦 src/pages/
//  ┣ 📜posts/[id].tsx
//  ┗ 📜users/[id]/settings.tsx

const paths = ph('./src/pages', './src/types/routes.ts')
  .filter(path => path.endsWith('.tsx')) // Lazy evaluation, Iterable is not consumed
  .map(path => typed`{
    path: ${path},
    params: {
      id: number,
    }
  }`) // Lazy evaluation, Iterable is still not consumed
  .write(prettier.format) // Iterable is consumed

// ./src/types/routes.ts
export type PathType = 
  | {
      path: './src/pages/posts/[id].tsx',
      params: {
        id: number
      }
    } 
  | {
      path: './src/pages/users/[id]/settings.tsx',
      params: {
        id: number
      }
    }

Configuration

ph('./src/components', './src/types/components.ts')
  .setConfig({
    typeName: 'ComponentPaths',
    annotation: '/** @generated This is auto-generated type */\n'
  })
  .write()

// ./src/types/components.ts
/** @generated This is auto-generated type */
export type ComponentPaths = './src/components/Button/index.tsx' | './src/components/Card/index.tsx'

💻 CLI

Options

  • -h, --help — Prints help information
  • -V, --version — Prints version information

Command

init command

Creates a new configuration file (path-typegen.config.cjs) in your project root with default settings. Types are provided through JSDoc annotations for better DX

path-typegen init
generate command

Generates TypeScript types from your input files.

Options:

  • -i, --input — Input file path
  • -o, --output — Output file path
# Generate TypeScript types
path-typegen generate -i ./assets/images -o ./ImageType.ts