tatethurston · tatethurston · May 27, 2024 · May 26, 2024 · May 26, 2024 · May 26, 2024
diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,6 @@ node_modules
 tsconfig.tsbuildinfo
 .next
 .vscode
+# copied over durring build
+packages/nextjs-routes/LICENSE
+packages/nextjs-routes/README.md
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## 2.2.0
+
+- Add `trailingSlash` option to `route`. See [#168](https://github.com/tatethurston/nextjs-routes/issues/168)
+- Fix the generated optional catch all route type. See [#183](https://github.com/tatethurston/nextjs-routes/issues/183)
+- Sort the generated route types lexicographically.
+
 ## 2.1.0
 
 - Add experimental support for app directory [route handler](https://nextjs.org/docs/app/building-your-application/routing/route-handlers). See [#178](https://github.com/tatethurston/nextjs-routes/issues/178).

diff --git a/README.md b/README.md
@@ -258,6 +258,18 @@ export function getServerSideProps(context: GetServerSidePropsContext) {
 }
 ```
 
+`route` optionally accepts a `trailingSlash`:
+
+```ts
+// api/foos/foobar/
+fetch(
+  route(
+    { pathname: "/api/foos/[foo]", query: { foo: "foobar" } },
+    { trailingSlash: true },
+  ),
+);
+```
+
 ### Internationalization (i18n)
 
 `nextjs-routes` refines `Link` and `useRouter` based on your [Nextjs i18n configuration](https://nextjs.org/docs/advanced-features/i18n-routing).

diff --git a/examples/app/@types/nextjs-routes.d.ts b/examples/app/@types/nextjs-routes.d.ts
@@ -1,6 +1,6 @@
 // THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
 // This file will be automatically regenerated when your Next.js server is running.
-// nextjs-routes version: 2.0.1
+// nextjs-routes version: 2.2.0
 /* eslint-disable */
 
 // prettier-ignore
@@ -11,8 +11,8 @@ declare module "nextjs-routes" {
   } from "next";
 
   export type Route =
-    | DynamicRoute<"/[store]", { "store": string }>
-    | StaticRoute<"/">;
+    | StaticRoute<"/">
+    | DynamicRoute<"/[store]", { "store": string }>;
 
   interface StaticRoute<Pathname> {
     pathname: Pathname;

diff --git a/examples/app/next.config.mjs b/examples/app/next.config.mjs
@@ -3,9 +3,6 @@ import nextRoutes from "nextjs-routes/config";
 const withRoutes = nextRoutes();
 
 const nextConfig = {
-  experimental: {
-    appDir: true,
-  },
   reactStrictMode: true,
 };
 

diff --git a/examples/app/package.json b/examples/app/package.json
@@ -9,16 +9,16 @@
     "start": "next start"
   },
   "dependencies": {
-    "next": "^14.0.1",
-    "react": "18.2.0",
-    "react-dom": "18.2.0"
+    "next": "^14.2.3",
+    "react": "18.3.1",
+    "react-dom": "18.3.1"
   },
   "devDependencies": {
-    "@types/node": "20.8.10",
-    "@types/react": "18.2.34",
-    "eslint": "8.53.0",
-    "eslint-config-next": "14.0.1",
+    "@types/node": "20.12.12",
+    "@types/react": "18.3.3",
+    "eslint": "8.57.0",
+    "eslint-config-next": "14.2.3",
     "nextjs-routes": "workspace:*",
-    "typescript": "5.2.2"
+    "typescript": "5.4.5"
   }
 }
diff --git a/examples/cjs/__test__/index.test.tsx b/examples/cjs/__test__/index.test.tsx
@@ -11,6 +11,7 @@ describe("Home", () => {
   it("renders a Link", () => {
     render(<Home />);
     const link = screen.getByText("Foo");
+    // @ts-expect-error: https://github.com/testing-library/jest-dom/issues/546
     expect(link).toBeInTheDocument();
   });
 });
diff --git a/examples/cjs/package.json b/examples/cjs/package.json
@@ -9,22 +9,20 @@
     "start": "next start"
   },
   "dependencies": {
-    "next": "^14.0.1",
-    "react": "18.2.0",
-    "react-dom": "18.2.0"
+    "next": "^14.2.3",
+    "react": "18.3.1",
+    "react-dom": "18.3.1"
   },
   "devDependencies": {
-    "@testing-library/jest-dom": "^5.17.0",
-    "@testing-library/react": "^14.0.0",
-    "@types/jest": "^29.5.7",
-    "@types/node": "20.8.10",
-    "@types/react": "18.2.34",
-    "@types/testing-library__jest-dom": "^5.14.8",
-    "eslint": "8.53.0",
-    "eslint-config-next": "14.0.1",
+    "@testing-library/react": "^15.0.7",
+    "@types/jest": "^29.5.12",
+    "@types/node": "20.12.12",
+    "@types/react": "18.3.3",
+    "eslint": "^8.57.0",
+    "eslint-config-next": "14.2.3",
     "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.7.0",
     "nextjs-routes": "workspace:*",
-    "typescript": "5.2.2"
+    "typescript": "5.4.5"
   }
 }
diff --git a/examples/cjs/types/nextjs-routes.d.ts b/examples/cjs/types/nextjs-routes.d.ts
@@ -1,6 +1,6 @@
 // THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
 // This file will be automatically regenerated when your Next.js server is running.
-// nextjs-routes version: 2.0.1
+// nextjs-routes version: 2.2.0
 /* eslint-disable */
 
 // prettier-ignore
@@ -11,8 +11,8 @@ declare module "nextjs-routes" {
   } from "next";
 
   export type Route =
-    | DynamicRoute<"/bars/[bar]", { "bar": string }>
-    | StaticRoute<"/">;
+    | StaticRoute<"/">
+    | DynamicRoute<"/bars/[bar]", { "bar": string }>;
 
   interface StaticRoute<Pathname> {
     pathname: Pathname;

diff --git a/examples/intl/@types/nextjs-routes.d.ts b/examples/intl/@types/nextjs-routes.d.ts
@@ -1,6 +1,6 @@
 // THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
 // This file will be automatically regenerated when your Next.js server is running.
-// nextjs-routes version: 2.0.1
+// nextjs-routes version: 2.2.0
 /* eslint-disable */
 
 // prettier-ignore
@@ -11,8 +11,8 @@ declare module "nextjs-routes" {
   } from "next";
 
   export type Route =
-    | DynamicRoute<"/[store]", { "store": string }>
-    | StaticRoute<"/">;
+    | StaticRoute<"/">
+    | DynamicRoute<"/[store]", { "store": string }>;
 
   interface StaticRoute<Pathname> {
     pathname: Pathname;

diff --git a/examples/intl/package.json b/examples/intl/package.json
@@ -10,16 +10,16 @@
     "start": "next start"
   },
   "dependencies": {
-    "next": "^14.0.1",
-    "react": "18.2.0",
-    "react-dom": "18.2.0"
+    "next": "^14.2.3",
+    "react": "18.3.1",
+    "react-dom": "18.3.1"
   },
   "devDependencies": {
-    "@types/node": "20.8.10",
-    "@types/react": "18.2.34",
-    "eslint": "8.53.0",
-    "eslint-config-next": "14.0.1",
+    "@types/node": "20.12.12",
+    "@types/react": "18.3.3",
+    "eslint": "8.57.0",
+    "eslint-config-next": "14.2.3",
     "nextjs-routes": "workspace:*",
-    "typescript": "5.2.2"
+    "typescript": "5.4.5"
   }
 }
diff --git a/examples/typescript/__test__/index.test.tsx b/examples/typescript/__test__/index.test.tsx
@@ -11,6 +11,7 @@ describe("Home", () => {
   it("renders a Link", () => {
     render(<Home />);
     const link = screen.getByText("Foo");
+    // @ts-expect-error: https://github.com/testing-library/jest-dom/issues/546
     expect(link).toBeInTheDocument();
   });
 });
diff --git a/examples/typescript/package.json b/examples/typescript/package.json
@@ -9,22 +9,20 @@
     "start": "next start"
   },
   "dependencies": {
-    "next": "^14.0.1",
-    "react": "18.2.0",
-    "react-dom": "18.2.0"
+    "next": "^14.2.3",
+    "react": "18.3.1",
+    "react-dom": "18.3.1"
   },
   "devDependencies": {
-    "@testing-library/jest-dom": "^5.17.0",
-    "@testing-library/react": "^14.0.0",
-    "@types/jest": "^29.5.7",
-    "@types/node": "20.8.10",
-    "@types/react": "18.2.34",
-    "@types/testing-library__jest-dom": "^5.14.8",
-    "eslint": "8.53.0",
-    "eslint-config-next": "14.0.1",
+    "@testing-library/react": "^15.0.7",
+    "@types/jest": "^29.5.12",
+    "@types/node": "20.12.12",
+    "@types/react": "18.3.3",
+    "eslint": "8.57.0",
+    "eslint-config-next": "14.2.3",
     "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.7.0",
     "nextjs-routes": "workspace:*",
-    "typescript": "5.2.2"
+    "typescript": "5.4.5"
   }
 }
diff --git a/examples/typescript/types/nextjs-routes.d.ts b/examples/typescript/types/nextjs-routes.d.ts
@@ -1,6 +1,6 @@
 // THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
 // This file will be automatically regenerated when your Next.js server is running.
-// nextjs-routes version: 2.0.1
+// nextjs-routes version: 2.2.0
 /* eslint-disable */
 
 // prettier-ignore
@@ -11,10 +11,10 @@ declare module "nextjs-routes" {
   } from "next";
 
   export type Route =
+    | StaticRoute<"/">
     | StaticRoute<"/api/hello">
     | DynamicRoute<"/bars/[bar]", { "bar": string }>
-    | DynamicRoute<"/foos/[foo]", { "foo": string }>
-    | StaticRoute<"/">;
+    | DynamicRoute<"/foos/[foo]", { "foo": string }>;
 
   interface StaticRoute<Pathname> {
     pathname: Pathname;

diff --git a/package.json b/package.json
@@ -24,27 +24,27 @@
   },
   "sideEffects": false,
   "devDependencies": {
-    "@babel/preset-env": "^7.23.2",
-    "@babel/preset-typescript": "^7.23.2",
-    "@swc/core": "^1.3.95",
-    "@types/jest": "^29.5.7",
-    "@types/node": "^20.8.10",
-    "@types/react": "^18.2.34",
-    "@types/webpack": "^5.28.4",
-    "@typescript-eslint/eslint-plugin": "^6.9.1",
-    "@typescript-eslint/parser": "^6.9.1",
+    "@babel/preset-env": "^7.24.6",
+    "@babel/preset-typescript": "^7.24.6",
+    "@swc/core": "^1.5.7",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.12.12",
+    "@types/react": "^18.3.3",
+    "@types/webpack": "^5.28.5",
+    "@typescript-eslint/eslint-plugin": "^7.10.0",
+    "@typescript-eslint/parser": "^7.10.0",
     "babel-loader": "^9.1.3",
     "codecov": "^3.8.3",
-    "eslint": "^8.53.0",
-    "eslint-config-prettier": "^9.0.0",
-    "husky": "^8.0.3",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "husky": "^9.0.11",
     "jest": "^29.7.0",
-    "next": "^14.0.1",
-    "prettier": "^3.0.3",
+    "next": "^14.2.3",
+    "prettier": "^3.2.5",
     "prettier-package-json": "^2.8.0",
-    "swc-loader": "^0.2.3",
-    "typescript": "^5.2.2",
-    "webpack": "^5.89.0",
+    "swc-loader": "^0.2.6",
+    "typescript": "^5.4.5",
+    "webpack": "^5.91.0",
     "webpack-cli": "^5.1.4"
   },
   "packageManager": "pnpm@8.10.2"

diff --git a/packages/e2e/@types/nextjs-routes.d.ts b/packages/e2e/@types/nextjs-routes.d.ts
@@ -1,6 +1,6 @@
 // THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
 // This file will be automatically regenerated when your Next.js server is running.
-// nextjs-routes version: 2.0.1
+// nextjs-routes version: 2.2.0
 /* eslint-disable */
 
 // prettier-ignore
@@ -11,9 +11,9 @@ declare module "nextjs-routes" {
   } from "next";
 
   export type Route =
+    | StaticRoute<"/">
     | DynamicRoute<"/[...slug]", { "slug": string[] }>
-    | DynamicRoute<"/foos/[foo]", { "foo": string }>
-    | StaticRoute<"/">;
+    | DynamicRoute<"/foos/[foo]", { "foo": string }>;
 
   interface StaticRoute<Pathname> {
     pathname: Pathname;

diff --git a/packages/e2e/package.json b/packages/e2e/package.json
@@ -10,12 +10,12 @@
     "start": "next start"
   },
   "dependencies": {
-    "next": "^14.0.1",
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0"
+    "next": "^14.2.3",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1"
   },
   "devDependencies": {
     "nextjs-routes": "workspace:*",
-    "typescript": "^5.2.2"
+    "typescript": "^5.4.5"
   }
 }
diff --git a/packages/nextjs-routes/package.json b/packages/nextjs-routes/package.json
@@ -1,6 +1,6 @@
 {
   "name": "nextjs-routes",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "Type safe routing for Next.js",
   "license": "MIT",
   "author": "Tate <tatethurston@gmail.com>",
@@ -31,7 +31,7 @@
   },
   "sideEffects": false,
   "dependencies": {
-    "chokidar": "^3.5.3"
+    "chokidar": "^3.6.0"
   },
   "peerDependencies": {
     "next": "*"