skip to Main Content

Suppose we have the following routes defined:

const routes: Routes = [
  {
    path: '',
    component: WelcomeComponent
  },  
  {
    path: 'start',
    component: StartComponent
  }

Is the a way to tell Scully to skip generation fo a static page for the start route?

2

Answers


  1. You can do this by using the ignoredRoutePlugin.

    `/someRoute`:{
      type:'ignored'
    }
    

    It doesn’t look like it’s in the documentation yet but here is the code in the repo: https://github.com/scullyio/scully/blob/main/libs/scully/src/lib/routerPlugins/ignoredRoutePlugin.ts

    Login or Signup to reply.
  2. In order to use a "wilcard"-ignore, you can use a routeProcessPlugin, declared in ./scully/plugins/plugin.ts:

    import { HandledRoute, registerPlugin } from '@scullyio/scully';
    
    registerPlugin(
      'routeProcess',
      'filteredRoute',
      (routes: HandledRoute[]): Promise<HandledRoute[]> => {
        return Promise.resolve(routes.filter((r) => !r.route.startsWith('/someRoute')));
      },
    );
    

    Make sure to import it in your scully.config.ts:

    import { ScullyConfig } from '@scullyio/scully';
    require('./scully/plugins/plugin');
    
    export const config: ScullyConfig = {
      // your config here
    }
    
    Login or Signup to reply.
Please signup or login to give your own answer.
Back To Top
Search