ng-rerouter

File base routing for angular

✅ Generates route configuration by reading your directory structure
✅ supports dynamic routes, wildcard routes
✅ Embraces upcoming standalone components
🚧 router outlet
🚧 Lazy loaded modules
✅ Additional configuration (guards, resolvers, etc)

⚠️ This lib is not ready for production usage

Getting Started

• in your angular application, create a directory named pages in the src directory

 mkdir src/pages

• create file index.route.ts in the src/pages directory

import { Component, NgModule } from '@angular/core';
@Component({
  template: `root`
})
export default class RouteComponent{
}
@NgModule({
  declarations: [RouteComponent]
})
class Module{}

• run npx ng-rerouter --watch

• page.routing.ts should be generated in the src directory

• import routes in AppModule

import {routes } from '../app/page.routing';

• use generated routes for your routing config

    RouterModule.forRoot(routes)

• Now, adding new files in the pages directory will automatically update the pages.routing.ts

##only files ending with .route.ts are considered for routing

##index.route.ts index.route.ts is a special file which is used routed at the directory path.

Dynamic routes

• following file name convention is used to create dynamic route :filename.route.ts

Wildcard routes

• Wild card routes are created by using the following convention

**.routing.ts
*.routing.ts
**/*.routing.ts

Additional Configuration

• create a named export routeConfig in your *.route.ts file to provide additional configuration for route

export const routeConfig: Partial<Route> = {
  data: {
    title: 'ramesh'
  }
};

API

  -V, --version      output the version number
  --output <path>    output path for the generated routes (default: "src/page.routing.ts")
  --pageRoot <path>  pages dir (default: "src/pages")
  --tsconfig <path>  tsconfig of the angular application (default: "tsconfig.app.json")
  --watch [boolean]  watch for file changes (default: false)
  -h, --help         display help for command