nuxt-typed-router 3.4.0 → 3.5.0-beta.1

package/dist/module.json

@@ -5,5 +5,5 @@
     "nuxt": "^3.0.0",
     "bridge": false
   },
-  "version": "3.4.0"
+  "version": "3.5.0-beta.1"
 }

package/dist/module.mjs

@@ -3,13 +3,13 @@ import chalk from 'chalk';
 import logSymbols from 'log-symbols';
 import path from 'path';
 import { defu } from 'defu';
-import { customAlphabet } from 'nanoid/non-secure';
-import { nanoid as nanoid$1 } from 'nanoid';
+import { startCase, camelCase } from 'lodash-es';
+import { nanoid } from 'nanoid/non-secure';
+import prettier from 'prettier';
 import fs, { existsSync } from 'fs';
 import { fileURLToPath } from 'url';
 import { dirname, resolve } from 'pathe';
 import { mkdirp } from 'mkdirp';
-import { camelCase } from 'lodash-es';
 import { readFile } from 'fs/promises';
 
 class ModuleOptionsStore {
@@ -45,6 +45,12 @@ class ModuleOptionsStore {
       this.i18nOptions = defu(options.i18nOptions, {
         strategy: "prefix_except_default"
       });
+      if (this.i18nOptions.strategy === "prefix_except_default" && !options.i18nOptions.defaultLocale) {
+        console.error(
+          logSymbols.error,
+          "You have not set 'i18n.defaultLocale', it's required when using 'prefix_except_default' mode (default one)"
+        );
+      }
       if (options.i18nOptions.locales) {
         this.i18nLocales = options.i18nOptions.locales.map((l) => {
           if (typeof l === "string") {
@@ -61,6 +67,9 @@ class ModuleOptionsStore {
     if (options.ignoreRoutes) {
       this.ignoreRoutes = options.ignoreRoutes;
     }
+    if (options.isDocumentDriven) {
+      this.ignoreRoutes.push("[...slug].vue");
+    }
   }
   get resolvedIgnoredRoutes() {
     return this.ignoreRoutes.map((file) => path.join(this.pagesDir, file));
@@ -113,7 +122,7 @@ function createRoutesNamesListExport(routesList) {
   /**
    * Exhaustive list of all the available route names in the app
    * */
-  export type RoutesNamesList = ${routesList.map((m) => `'${m}'`).join("|\n")}`;
+  export type RoutesNamesList = ${routesList.length ? routesList.map((m) => `'${m}'`).join("|\n") : '""'}`;
 }
 
 function createRoutesParamsRecordExport(routesParams) {
@@ -142,13 +151,13 @@ function createRoutesNamedLocationsExport(routesParams) {
    * It's used for programmatic navigation like router.push or <NuxtLink/>
    * */
   export type RoutesNamedLocations = 
-    ${routesParams.map(
+    ${routesParams.length ? routesParams.map(
     ({ name, params }) => `{name: "${name}" ${params.length ? `, params${params.some((s) => s.required) ? "" : "?"}: {
           ${params.map(
       ({ key, required, catchAll }) => `"${key}"${required ? "" : "?"}: (string | number)${catchAll ? "[]" : ""}`
     ).join(",\n")}
         }` : ""}}`
-  ).join("|\n")}
+  ).join("|\n") : "''"}
   `;
 }
 
@@ -162,7 +171,7 @@ function createRoutesNamedLocationsResolvedExport(routesParams) {
   {
     name: RoutesNamesList;
     params: unknown;
-  } & (
+  } ${routesParams.length ? `& (
     ${routesParams.map(
     ({ name, params }) => `{name: "${name}" ${params.length ? `, params: {
                 ${params.map(
@@ -170,7 +179,7 @@ function createRoutesNamedLocationsResolvedExport(routesParams) {
     ).join(",\n")}
         }` : ""}}`
   ).join("|\n")}
-      )
+      )` : ""} 
   `;
 }
 
@@ -201,7 +210,9 @@ function returnIfTrue(condition, template, otherwise) {
   return otherwise ?? "";
 }
 
-const nanoid = customAlphabet("ABCDEFGHIJKLMNOPQRSTUVWXYZ", 10);
+function pascalCase(str) {
+  return startCase(camelCase(str)).replace(/ /g, "");
+}
 function createRoutePathSchema(routePaths) {
   return `export type RoutePathSchema = 
     ${routePaths.filter((f) => !!f.path).map((route) => `"${route.path}"`).join("|")}
@@ -213,7 +224,7 @@ function createLocaleRoutePathSchema(routePaths) {
   `;
 }
 function createValidatePathTypes(pathElements, routesList, withLocale = false) {
-  let pathConditions = pathElements.map(createTypeValidatePathCondition).filter((f) => {
+  let pathConditions = pathElements.map((m) => createTypeValidatePathCondition(m, withLocale)).filter((f) => {
     if (withLocale) {
       return !f.isLocale;
     }
@@ -247,8 +258,9 @@ function createValidatePathTypes(pathElements, routesList, withLocale = false) {
   
         `;
 }
-function createTypeValidatePathCondition(elements) {
-  const typeName = `Validate${nanoid(7)}`;
+function createTypeValidatePathCondition(elements, withLocale) {
+  const seedName = pascalCase(elements[0][0].fullPath);
+  const typeName = `Validate${returnIfTrue(withLocale, "Locale")}${seedName}`;
   const params = /* @__PURE__ */ new Map();
   const routeName = elements.flat()[0]?.routeName ?? "index";
   elements.flat().every((elem) => elem.type === "name");
@@ -257,13 +269,13 @@ function createTypeValidatePathCondition(elements) {
     return elementArray.map((elem) => {
       const isLast = index === elements.flat().length - 1;
       if (elem.type === "name" && isLast) {
-        const id = nanoid(6);
+        const id = `T${pascalCase(elem.content)}`;
         params.set(elem.id, id);
         return `${elem.content}\${infer ${id}}`;
       } else if (elem.type === "name") {
         return elem.content;
       } else if (elem.type === "param" || elem.type === "optionalParam") {
-        const id = nanoid(6);
+        const id = `T${pascalCase(elem.content)}`;
         params.set(elem.id, id);
         return `\${infer ${id}}`;
       } else if (elem.type === "catchAll") {
@@ -911,6 +923,7 @@ function createi18nRouterFile() {
     `
   import type { RouteLocationRaw } from 'vue-router';
   import { useLocalePath as _useLocalePath, useLocaleRoute as _useLocaleRoute} from 'vue-i18n-routing';
+  import type {I18nCommonRoutingOptionsWithComposable} from 'vue-i18n-routing';
   import type {TypedRouteLocationRawFromName, TypedLocationAsRelativeRaw, TypedRouteFromName} from './__router';
   import type {RoutesNamesList} from './__routes';
   ${returnIfTrue(
@@ -946,7 +959,7 @@ function createi18nRouterFile() {
     )}
   }
 
-  export function useLocalePath(options?: Pick<NonNullable<Parameters<typeof _useLocalePath>[0]>, 'i18n'>): TypedToLocalePath {
+  export function useLocalePath(options?: I18nCommonRoutingOptionsWithComposable): TypedToLocalePath {
      return _useLocalePath(options) as any;
   }
   
@@ -959,7 +972,7 @@ function createi18nRouterFile() {
   }
 
 
-  export function useLocaleRoute(options?: Pick<NonNullable<Parameters<typeof _useLocaleRoute>[0]>, 'i18n'>): TypedLocaleRoute {
+  export function useLocaleRoute(options?: I18nCommonRoutingOptionsWithComposable): TypedLocaleRoute {
     return _useLocaleRoute(options) as any;
   }
 
@@ -1039,7 +1052,7 @@ function extractPathElements(partOfPath, route) {
         pathElements.push({
           type: "name",
           content: path1,
-          id: nanoid$1(6),
+          id: nanoid(6),
           ...sharedProperties
         });
       }
@@ -1047,7 +1060,7 @@ function extractPathElements(partOfPath, route) {
         pathElements.push({
           type: catchAll && parentheseContent ? "catchAll" : optional ? "optionalParam" : "param",
           content: key,
-          id: nanoid$1(6),
+          id: nanoid(6),
           ...sharedProperties
         });
       }
@@ -1055,7 +1068,7 @@ function extractPathElements(partOfPath, route) {
         pathElements.push({
           type: "name",
           content: path2,
-          id: nanoid$1(6),
+          id: nanoid(6),
           ...sharedProperties
         });
       }
@@ -1349,6 +1362,32 @@ async function handleAddPlugin() {
   });
 }
 
+const defaultPrettierOptions = {
+  printWidth: 100,
+  tabWidth: 2,
+  trailingComma: "es5",
+  singleQuote: true,
+  semi: true,
+  bracketSpacing: true,
+  htmlWhitespaceSensitivity: "strict"
+};
+async function formatOutputWithPrettier(template) {
+  try {
+    let prettierFoundOptions = await prettier.resolveConfig(process.cwd());
+    if (!prettierFoundOptions) {
+      prettierFoundOptions = defaultPrettierOptions;
+    }
+    const formatedTemplate = prettier.format(template, {
+      ...prettierFoundOptions,
+      parser: "typescript"
+    });
+    return formatedTemplate;
+  } catch (e) {
+    console.error(logSymbols.error, chalk.red("Error while formatting the output"), "\n" + e);
+    return Promise.reject(e);
+  }
+}
+
 dirname(fileURLToPath(import.meta.url));
 async function processPathAndWriteFile({
   content,
@@ -1360,14 +1399,15 @@ async function processPathAndWriteFile({
     const finalOutDir = outDir ?? `.nuxt/typed-router`;
     const processedOutDir = resolve(rootDir, finalOutDir);
     const outputFile = resolve(process.cwd(), `${processedOutDir}/${fileName}`);
+    const formatedContent = await formatOutputWithPrettier(content);
     if (fs.existsSync(outputFile)) {
-      await writeFile(outputFile, content);
+      await writeFile(outputFile, formatedContent);
     } else {
       let dirList = outputFile.split("/");
       dirList.pop();
       const dirPath = dirList.join("/");
       await mkdirp(dirPath);
-      await writeFile(outputFile, content);
+      await writeFile(outputFile, formatedContent);
     }
   } catch (e) {
     return Promise.reject(e);
@@ -1385,11 +1425,11 @@ async function writeFile(path, content) {
 const watermarkTemplate = `
   // @ts-nocheck
   // eslint-disable
-  /** 
-  * ---------------------------------------------------
-  * \u{1F697}\u{1F6A6} Generated by nuxt-typed-router. Do not modify !
-  * ---------------------------------------------------
-  * */
+  // ---------------------------------------------------
+  // \u{1F697}\u{1F6A6} Generated by nuxt-typed-router. Do not modify !
+  // ---------------------------------------------------
+  
+  
  
 `;
 
@@ -1507,7 +1547,7 @@ function modifyRoutePrefixDefaultIfI18n(route) {
         };
       }
     } else if (i18nOptions?.strategy === "prefix_except_default") {
-      let defaultLocale = i18nLocales.find((f) => f === i18nOptions.defaultLocale) ? i18nOptions.defaultLocale?.replace(specialCharacterRegxp, "\\$&") : "";
+      let defaultLocale = i18nLocales.find((f) => f === i18nOptions.defaultLocale) ? i18nOptions.defaultLocale?.replace(specialCharacterRegxp, "\\$&") : void 0;
       const routeDefaultNameRegXp = new RegExp(`^([a-zA-Z0-9-]+)${separator}${defaultLocale}`, "g");
       const match = routeDefaultNameRegXp.exec(route.name);
       if (match) {
@@ -1778,10 +1818,18 @@ const module = defineNuxtModule({
         return isRegistered;
       }
     });
+    const isDocumentDriven = !!nuxt.options.modules.find((mod) => {
+      if (Array.isArray(mod)) {
+        return mod[0] === "@nuxt/content";
+      } else {
+        return mod === "@nuxt/content";
+      }
+    }) && "content" in nuxt.options && "documentDriven" in nuxt.options.content;
     moduleOptionStore.updateOptions({
       ...moduleOptions,
       i18n: hasi18nModuleRegistered,
-      i18nOptions
+      i18nOptions,
+      isDocumentDriven
     });
     nuxt.options.alias = {
       ...nuxt.options.alias,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-typed-router",
-  "version": "3.4.0",
+  "version": "3.5.0-beta.1",
   "description": "Provide autocompletion for routes paths, names and params in Nuxt apps",
   "type": "module",
   "main": "./dist/module.cjs",
@@ -59,6 +59,9 @@
   "bugs": {
     "url": "https://github.com/victorgarciaesgi/nuxt-typed-router/issues"
   },
+  "peerDependencies": {
+    "prettier": "^2.5.x || 3.x"
+  },
   "dependencies": {
     "@nuxt/kit": "3.8.2",
     "chalk": "5.3.0",
@@ -75,6 +78,7 @@
     "@nuxt/test-utils": "3.8.1",
     "@nuxt/types": "2.17.2",
     "@nuxtjs/eslint-config-typescript": "12.1.0",
+    "@nuxt/content": "2.9.0",
     "@nuxtjs/i18n": "8.0.0-rc.5",
     "@nuxtjs/web-vitals": "0.2.6",
     "@types/lodash-es": "4.17.12",