Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aspida/pathpida
TypeScript friendly internal link client for Next.js.
https://github.com/aspida/pathpida
nextjs typescript
Last synced: 1 day ago
JSON representation
TypeScript friendly internal link client for Next.js.
- Host: GitHub
- URL: https://github.com/aspida/pathpida
- Owner: aspida
- License: mit
- Created: 2020-05-28T21:45:59.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-12-18T06:57:53.000Z (about 1 month ago)
- Last Synced: 2025-01-11T05:00:14.392Z (8 days ago)
- Topics: nextjs, typescript
- Language: TypeScript
- Homepage: https://github.com/aspida/pathpida
- Size: 842 KB
- Stars: 508
- Watchers: 3
- Forks: 33
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - aspida/pathpida - TypeScript friendly internal link client for Next.js. (TypeScript)
README
# pathpida
TypeScript friendly pages and static path generator for Next.js.
## Breaking change :warning:
### 2024/12/14
Since pathpida >= `0.23.0` , removed Nuxt support.
### 2022/11/25
Since pathpida >= `0.20.0` , removed Sapper support.
## Features
- **Type safety**. Automatically generate type definition files for manipulating internal links in Next.js.
- **Zero configuration**. No configuration required can be used immediately after installation.
- **Zero runtime**. Lightweight because runtime code is not included in the bundle.
- **Support for static files**. Static files in public/ are also supported, so static assets can be safely referenced.
- **Support for appDir of Next.js 13 Layout**.
## Table of Contents
- [Install](#Install)
- [Command Line Interface Options](#CLI-options)
- [Setup](#Setup)
- [Usage](#Usage)
- [Define query](#Define-query)
- [Generate static files path](#Generate-static-files-path)
- [License](#License)
## Install
- Using [npm](https://www.npmjs.com/):
```sh
$ npm install pathpida npm-run-all --save-dev
```
- Using [Yarn](https://yarnpkg.com/):
```sh
$ yarn add pathpida npm-run-all --dev
```
## Command Line Interface Options
Option
Type
Description
--enableStatic
-s
Generate static files path in $path.ts.
--ignorePath
-p
string
Specify the ignore pattern file path.
--output
-o
string
Specify the output directory for $path.ts.
--watch
-w
Enable watch mode.
Regenerate $path.ts.
--version
-v
Print pathpida version.
## Setup
`package.json`
```json
{
"scripts": {
"dev": "run-p dev:*",
"dev:next": "next dev",
"dev:path": "pathpida --ignorePath .gitignore --watch",
"build": "pathpida --ignorePath .gitignore && next build"
}
}
```
## Usage
```
pages/index.tsx
pages/post/create.tsx
pages/post/[pid].tsx
pages/post/[...slug].tsx
lib/$path.ts or utils/$path.ts // Generated automatically by pathpida
```
or
```
src/pages/index.tsx
src/pages/post/create.tsx
src/pages/post/[pid].tsx
src/pages/post/[...slug].tsx
src/lib/$path.ts or src/utils/$path.ts // Generated automatically by pathpida
```
`pages/index.tsx`
```tsx
import Link from "next/link";
import { pagesPath } from "../lib/$path";
console.log(pagesPath.post.create.$url()); // { pathname: '/post/create' }
console.log(pagesPath.post._pid(1).$url()); // { pathname: '/post/[pid]', query: { pid: 1 }}
console.log(pagesPath.post._slug(["a", "b", "c"]).$url()); // { pathname: '/post//[...slug]', query: { slug: ['a', 'b', 'c'] }}
export default () => {
const onClick = useCallback(() => {
router.push(pagesPath.post._pid(1).$url());
}, []);
return (
<>
>
);
};
```
## Define query
`pages/post/create.tsx`
```tsx
export type Query = {
userId: number;
name?: string;
};
export default () =>
;
```
`pages/post/[pid].tsx`
```tsx
export type OptionalQuery = {
limit: number;
label?: string;
};
export default () =>
;
```
`pages/index.tsx`
```tsx
import Link from "next/link";
import { pagesPath } from "../lib/$path";
console.log(pagesPath.post.create.$url({ query: { userId: 1 } })); // { pathname: '/post/create', query: { userId: 1 }}
console.log(pagesPath.post.create.$url()); // type error
console.log(pagesPath.post._pid(1).$url()); // { pathname: '/post/[pid]', query: { pid: 1 }}
console.log(pagesPath.post._pid(1).$url({ query: { limit: 10 }, hash: "sample" })); // { pathname: '/post/[pid]', query: { pid: 1, limit: 10 }, hash: 'sample' }
export default () => {
const onClick = useCallback(() => {
router.push(pagesPath.post._pid(1).$url());
}, []);
return (
<>
>
);
};
```
## Generate static files path
`package.json`
```json
{
"scripts": {
"dev": "run-p dev:*",
"dev:next": "next dev",
"dev:path": "pathpida --enableStatic --watch",
"build": "pathpida --enableStatic && next build"
}
}
```
```
pages/index.tsx
pages/post/create.tsx
pages/post/[pid].tsx
pages/post/[...slug].tsx
public/aa.json
public/bb/cc.png
lib/$path.ts or utils/$path.ts // Generated automatically by pathpida
```
or
```
src/pages/index.tsx
src/pages/post/create.tsx
src/pages/post/[pid].tsx
src/pages/post/[...slug].tsx
public/aa.json
public/bb/cc.png
src/lib/$path.ts or src/utils/$path.ts // Generated automatically by pathpida
```
`pages/index.tsx`
```tsx
import Link from "next/link";
import { pagesPath, staticPath } from "../lib/$path";
console.log(staticPath.aa_json); // /aa.json
export default () => {
return (
<>
>
);
};
```
## License
pathpida is licensed under a [MIT License](https://github.com/aspida/pathpida/blob/master/LICENSE).