Merge pull request #5 from ckastbjerg/add-basic-tests

Add basic tests

example/src/@types/next-type-safe-routes/index.d.ts

@@ -1,7 +1,7 @@
 /* eslint no-use-before-define: 0 */ // --> OFF
 // prettier-ignore
 
-// IMPORTANT! This file is autogenerated by the `type-safe-next-pages`
+// IMPORTANT! This file is autogenerated by the `type-safe-next-routes`
 // package. You should _not_ update these types manually...
 
 declare module "next-type-safe-routes" {

package.json

@@ -1,18 +1,17 @@
 {
   "name": "next-type-safe-routes",
-  "version": "0.0.19-alpha",
+  "version": "0.0.20-alpha",
   "description": "Never should your users experience broken links again!",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
-  "bin": "bin/cli.js",
   "files": [
     "dist",
     "bin"
   ],
   "scripts": {
     "build": "tsc",
     "prepare": "yarn build",
-    "test": "yarn jest",
+    "test": "yarn jest --updateSnapshot",
     "lint": "eslint '*/**/*.{js,ts,tsx}' --quiet --fix"
   },
   "husky": {

src/plugin/generateTypeScriptFile/__snapshots__/generateTypeScriptFile.test.ts.snap

@@ -0,0 +1,18 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`plugin/generateTypeScriptFile works as expected 1`] = `
+"/* eslint no-use-before-define: 0 */ // --> OFF
+// prettier-ignore
+
+// IMPORTANT! This file is autogenerated by the \`type-safe-next-routes\` 
+// package. You should _not_ update these types manually...
+
+declare module \\"next-type-safe-routes\\" {
+  export type TypeSafePage = \\"/404\\" | \\"/\\" | { route: \\"/users/[userId]\\", userId: string | string[] | number } | \\"/users\\";
+  export type TypeSafeApiRoute = { route: \\"/api/[authId]\\", authId: string | string[] | number } | { route: \\"/api/users/[userId]\\", userId: string | string[] | number } | \\"/api/users\\";
+
+  export const getPathname = (typeSafeUrl: TypeSafePage | TypeSafeApiRoute) => string;
+  export const getRoute = (typeSafeUrl: TypeSafePage | TypeSafeApiRoute, query?: any) => string;
+}
+"
+`;

src/plugin/generateTypeScriptFile/generateTypeScriptFile.test.ts

@@ -0,0 +1,9 @@
+import generateTypeScriptFile from "./index";
+
+const pagesDir = __dirname + "/mocks/pages";
+
+describe("plugin/generateTypeScriptFile", () => {
+  it("works as expected", () => {
+    expect(generateTypeScriptFile(pagesDir)).toMatchSnapshot();
+  });
+});

src/plugin/generateTypeScriptFile/getApiRoutes.ts

@@ -2,7 +2,7 @@ import getNextPageRoute from "./getNextPageRoute";
 import getNextRouteUrlParams from "./getNextRouteUrlParams";
 import { ApiRoute } from "./types";
 
-const shouldIncludeEntry = (endpoint: string) => !endpoint.match("README");
+const shouldIncludeEntry = (endpoint: string) => endpoint.match(".ts");
 
 const getApiRoutes = (fileNames: string[]): ApiRoute[] => {
   return fileNames.filter(shouldIncludeEntry).map((fileName) => {

src/plugin/generateTypeScriptFile/getFileContent.ts

@@ -21,7 +21,7 @@ const getFileContent = ({
 }: Args) => `/* eslint no-use-before-define: 0 */ // --> OFF
 // prettier-ignore
 
-// IMPORTANT! This file is autogenerated by the \`type-safe-next-pages\` 
+// IMPORTANT! This file is autogenerated by the \`type-safe-next-routes\` 
 // package. You should _not_ update these types manually...
 
 declare module "next-type-safe-routes" {

src/plugin/generateTypeScriptFile/getPages.ts

@@ -2,8 +2,10 @@ import getNextPageRoute from "./getNextPageRoute";
 import getNextRouteUrlParams from "./getNextRouteUrlParams";
 import { Page } from "./types";
 
+const ignoreRoutes = ["/_app.tsx", "/_document.tsx"];
+
 const shouldIncludeEntry = (route: string) =>
-  !route.startsWith("/_") && !route.match(".md");
+  route.match(".tsx") && !ignoreRoutes.includes(route);
 
 const getPages = (fileNames: string[]): Page[] => {
   return fileNames.filter(shouldIncludeEntry).map((fileName) => {