ReviewProjectConfig.flutterWebsite constructor

ReviewProjectConfig.flutterWebsite({
  1. String reviewDirectoryName = '.dash_review',
  2. String cliResolveCommand = 'dart run dash_site review resolve',
  3. String defaultSite = 'docs',
})

Preset matching the flutter/website (docs + www) monorepo layout.

Implementation

factory ReviewProjectConfig.flutterWebsite({
  String reviewDirectoryName = '.dash_review',
  String cliResolveCommand = 'dart run dash_site review resolve',
  String defaultSite = 'docs',
}) => ReviewProjectConfig(
  reviewDirectoryName: reviewDirectoryName,
  cliResolveCommand: cliResolveCommand,
  defaultSite: defaultSite,
  allowedSites: const <String>['docs', 'www'],
  sites: const <String, ReviewSiteConfig>{
    'docs': ReviewSiteConfig(
      contentRoot: 'sites/docs/src/content',
      includeRoots: <String>['sites/docs/src/_includes'],
      sourceRoots: <String>[
        'sites/docs/src/_includes',
        'sites/docs/src/data',
        'sites/docs/lib/src',
        'examples',
      ],
    ),
    'www': ReviewSiteConfig(
      contentRoot: 'sites/www/content',
      componentRoots: <String>[
        'sites/www/lib/src/pages',
        'sites/www/lib/src/components/pages',
        'sites/www/lib/src/components/sections',
        'sites/www/lib/src/components/common',
      ],
      dataRoots: <String>['sites/www/content'],
      sourceRoots: <String>['sites/www/content/_data', 'sites/www/lib/src'],
    ),
  },
);