commonOptions top-level property

List<Option> commonOptions

Implementation

final List<Option> commonOptions = [
  Option(
      name: ['-b', '--baseURL'],
      description: 'Hostname (and path) to the root, e.g. http://spf13.com/',
      args: [Arg(name: 'hostname and path')]),
  Option(
      name: ['-D', '--buildDrafts'],
      description: 'Include content marked as draft (default false)',
      args: [Arg(name: 'boolean')]),
  Option(
      name: ['-E', '--buildExpired'],
      description: 'Include expired content (default false)',
      args: [Arg(name: 'boolean')]),
  Option(
      name: ['-F', '--buildFuture'],
      description:
          'Include content with publishdate in the future (default false)',
      args: [Arg(name: 'boolean')]),
  Option(
      name: '--cacheDir',
      description:
          'Filesystem path to cache directory. Defaults: \$TMPDIR/hugo_cache/',
      args: [Arg(name: 'path', template: 'folders')]),
  Option(
      name: '--cleanDestinationDir',
      description:
          'Remove files from destination not found in static directories (default false)',
      args: [Arg(name: 'boolean')]),
  Option(
      name: ['-c', '--contentDir'],
      description: 'Filesystem path to content directory',
      args: [Arg(name: 'path', template: 'folders')]),
  Option(
      name: ['-d', '--destination'],
      description: 'Filesystem path to write files to',
      args: [Arg(name: 'path', template: 'folders')]),
  Option(
      name: '--disableKinds',
      description: 'Disable different kind of pages (home, RSS etc.)',
      args: [
        Arg(name: 'kind,kind', suggestions: [
          FigSuggestion(name: 'page'),
          FigSuggestion(name: 'home'),
          FigSuggestion(name: 'section'),
          FigSuggestion(name: 'taxonomy'),
          FigSuggestion(name: 'term'),
          FigSuggestion(name: 'RSS'),
          FigSuggestion(name: 'sitemap'),
          FigSuggestion(name: 'robotsTXT'),
          FigSuggestion(name: '404')
        ])
      ]),
  Option(
      name: '--enableGitInfo',
      description:
          'Add Git revision, date and author info to the pages (default false)',
      args: [Arg(name: 'boolean')]),
  Option(
      name: '--forceSyncStatic',
      description: 'Copy all files when static is changed (default false)',
      args: [Arg(name: 'boolean')]),
  Option(
      name: '--gc',
      description:
          'Enable to run some cleanup tasks (remove unused cache files) after the build (default false)',
      args: [Arg(name: 'boolean')]),
  Option(
      name: '--i18n-warnings',
      description: 'Print missing translations (default false)',
      args: [Arg(name: 'boolean')]),
  Option(
      name: '--ignoreCache',
      description: 'Ignores the cache directory (default false)',
      args: [Arg(name: 'boolean')]),
  Option(
      name: ['-l', '--layoutDir'],
      description: 'Filesystem path to layout directory',
      args: [Arg(name: 'path', template: 'folders')]),
  Option(
      name: '--minify',
      description:
          'Minify any supported output format (HTML, XML etc.) (default false)',
      args: [Arg(name: 'boolean')]),
  Option(
      name: '--noChmod',
      description: 'Don\'t sync permission mode of files (default false)',
      args: [Arg(name: 'boolean')]),
  Option(
      name: '--noTimes',
      description: 'Don\'t sync modification time of files (default false)',
      args: [Arg(name: 'boolean')]),
  Option(
      name: '--path-warnings',
      description:
          'Print warnings on duplicate target paths etc (default false)',
      args: [Arg(name: 'boolean')]),
  Option(
      name: '--poll',
      description:
          'Set this to a poll interval, e.g --poll 700ms, to use a poll based approach to watch for file system changes',
      args: [Arg(name: 'milliseconds')]),
  Option(
      name: '--print-mem',
      description: 'Print memory usage to screen at intervals (default false)',
      args: [Arg(name: 'boolean')]),
  Option(
      name: '--templateMetrics',
      description: 'Display metrics about template executions (default false)',
      args: [Arg(name: 'boolean')]),
  Option(
      name: '--templateMetricsHints',
      description:
          'Calculate some improvement hints when combined with --templateMetrics (default false)',
      args: [Arg(name: 'boolean')]),
  Option(
      name: ['-t', '--theme'],
      description: 'Themes to use (located in /themes/THEMENAME/)',
      args: [Arg(name: 'theme nam')]),
  Option(
      name: '--trace',
      description: 'Write trace to file (not useful in general)',
      args: [Arg(name: 'file', template: 'filepaths')])
];