routes.ts

// based on https://github.com/remix-run/remix/blob/main/packages/remix-dev/config/routes.ts

import { win32, join, isAbsolute, relative, sep } from 'path';

export interface ConfigRoute {
  /**
   * The unique id for this route, named like its `file` but without the
   * extension. So `src/pages/gists/$username.jsx` will have an `id` of
   * `routes/gists/$username`.
   */
  id: string;
  /**
   * The path to the entry point for this route, relative to src/pages
   */
  file: string;
  /**
   * current route's component. `src/pages/gist.jsx` will have an `componentName` of `PageGist`
   */
  componentName: string;
  /**
   * The unique `id` for this route's parent route, if there is one.
   */
  parentId?: string;
  /**
   * The path this route uses to match on the URL pathname.
   */
  path: string;
  /**
   * Should be `true` if it is an index route. This disallows child routes.
   */
  index?: boolean;
  /**
   * Should be `true` if route is layout component.
   */
  layout?: boolean;
  /**
   * module exports key of route
   */
  exports?: string[];
}

export interface DefineRouteOptions {
  /**
   * Should be `true` if this is an index route that does not allow child routes.
   */
  index?: boolean;
}

interface DefineRouteChildren {
  (): void;
}

export interface DefineRouteFunction {
  (
    /**
     * The path this route uses to match the URL pathname.
     */
    path: string | undefined,

    /**
     * The path to the file that exports the React component rendered by this
     * route as its default export, relative to the `app` directory.
     */
    file: string,

    /**
     * Options for defining routes, or a function for defining child routes.
     */
    optionsOrChildren?: DefineRouteOptions | DefineRouteChildren,

    /**
     * A function for defining child routes.
     */
    children?: DefineRouteChildren,
  ): void;
}
export interface RouteManifest {
  [routeId: string]: ConfigRoute;
}

export interface NestedRouteManifest extends ConfigRoute {
  children?: ConfigRoute[];
}

export interface DefineRoutesOptions {
  routeManifest: RouteManifest;
  nestedRouteManifest: NestedRouteManifest[];
}

export type DefineExtraRoutes = (
  defineRoute: DefineRouteFunction,
  options: DefineRoutesOptions,
) => void;


export function formatPath(pathStr: string): string {
  return process.platform === 'win32' ? pathStr.split(sep).join('/') : pathStr;
}

export function defineRoutes(
  rootDir: string,
  callback: (defineRoute: DefineRouteFunction, options: DefineRoutesOptions) => void,
  options: DefineRoutesOptions,
) {
  const routes: RouteManifest = Object.create(null);
  const parentRoutes: ConfigRoute[] = [];
  let alreadyReturned = false;
  const defineRoute: DefineRouteFunction = (path, file, optionsOrChildren, children) => {
    if (alreadyReturned) {
      throw new Error(
        'You tried to define routes asynchronously but started defining ' +
          'routes before the async work was done. Please await all async ' +
          'data before calling `defineRoutes()`',
      );
    }

    let options: DefineRouteOptions;
    if (typeof optionsOrChildren === 'function') {
      // route(path, file, children)
      options = {};
      children = optionsOrChildren;
    } else {
      // route(path, file, options, children)
      // route(path, file, options)
      options = optionsOrChildren || {};
    }
    const parentRoute = parentRoutes.length > 0
      ? parentRoutes[parentRoutes.length - 1]
      : undefined;

    const id = createRouteId(file, path, parentRoute?.id, options.index);
    const route: ConfigRoute = {
      path,
      index: options.index ? true : undefined,
      id,
      parentId: parentRoute ? parentRoute.id : undefined,
      file,
      componentName: createComponentName(isAbsolute(file) ? formatPath(relative(rootDir, file)) : file),
      layout: id.endsWith('layout'),
    };

    routes[route.id] = route;

    if (children) {
      parentRoutes.push(route);
      children();
      parentRoutes.pop();
    }
  };

  callback(defineRoute, options);

  alreadyReturned = true;

  return routes;
}

export function createRouteId(
  file: string,
  path?: string,
  parentPath?: string,
  index?: boolean,
) {
  return normalizeSlashes(join(
    parentPath || '',
    path || (index ? '/' : ''),
    stripFileExtension(file).endsWith('layout') ? 'layout' : '',
  ));
}

export function createFileId(file: string) {
  return normalizeSlashes(stripFileExtension(file));
}

export function normalizeSlashes(file: string) {
  return file.split(win32.sep).join('/');
}

function stripFileExtension(file: string) {
  return file.replace(/\.[a-z0-9]+$/i, '');
}

export function createComponentName(file: string) {
  return createFileId(file).split('/')
    .map((item: string) => item.toLowerCase())
    .join('-');
}

/**
 * remove `/layout` str if the routeId has it
 *
 * 'layout' -> ''
 * 'About/layout' -> 'About'
 * 'About/layout/index' -> 'About/layout/index'
 */
export function removeLastLayoutStrFromId(id?: string) {
  const layoutStrs = ['/layout', 'layout'];
  const currentLayoutStr = layoutStrs.find(layoutStr => id?.endsWith(layoutStr));
  return currentLayoutStr ? id.slice(0, id.length - currentLayoutStr.length) : id;
}