-
Notifications
You must be signed in to change notification settings - Fork 118
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
16 changed files
with
163 additions
and
167 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,153 +1,7 @@ | ||
| import 'dart:io' show stderr, exitCode; | ||
| // Copyright (c) 2023, the Dart project authors. Please see the AUTHORS file | ||
| // for details. All rights reserved. Use of this source code is governed by a | ||
| // BSD-style license that can be found in the LICENSE file. | ||
|
|
||
| import 'package:args/args.dart'; | ||
| import 'package:dartdoc/src/dartdoc.dart' show dartdocVersion, programName; | ||
| import 'package:dartdoc/src/dartdoc_options.dart'; | ||
| import 'package:dartdoc/src/generator/generator.dart'; | ||
| import 'package:dartdoc/src/logging.dart'; | ||
| import 'package:dartdoc/src/package_meta.dart'; | ||
|
|
||
| /// Helper class that consolidates option contexts for instantiating generators. | ||
| class DartdocGeneratorOptionContext extends DartdocOptionContext { | ||
| DartdocGeneratorOptionContext( | ||
| super.optionSet, super.dir, super.resourceProvider); | ||
| DartdocGeneratorOptionContext.fromDefaultContextLocation( | ||
| super.optionSet, super.resourceProvider) | ||
| : super.fromDefaultContextLocation(); | ||
|
|
||
| /// The joined contents of any 'header' files specified in options. | ||
| String get header => | ||
| _joinCustomTextFiles(optionSet['header'].valueAt(context)); | ||
|
|
||
| /// The joined contents of any 'footer' files specified in options. | ||
| String get footer => | ||
| _joinCustomTextFiles(optionSet['footer'].valueAt(context)); | ||
|
|
||
| /// The joined contents of any 'footer-text' files specified in options. | ||
| String get footerText => | ||
| _joinCustomTextFiles(optionSet['footerText'].valueAt(context)); | ||
|
|
||
| String _joinCustomTextFiles(Iterable<String> paths) => paths | ||
| .map((p) => resourceProvider.getFile(p).readAsStringSync()) | ||
| .join('\n'); | ||
|
|
||
| bool get prettyIndexJson => optionSet['prettyIndexJson'].valueAt(context); | ||
|
|
||
| String? get favicon => optionSet['favicon'].valueAt(context); | ||
|
|
||
| String? get relCanonicalPrefix => | ||
| optionSet['relCanonicalPrefix'].valueAt(context); | ||
|
|
||
| String? get templatesDir => optionSet['templatesDir'].valueAt(context); | ||
|
|
||
| // TODO(jdkoren): duplicated temporarily so that GeneratorContext is enough for configuration. | ||
| @override | ||
| bool get useBaseHref => optionSet['useBaseHref'].valueAt(context); | ||
|
|
||
| String? get resourcesDir => optionSet['resourcesDir'].valueAt(context); | ||
| } | ||
|
|
||
| class DartdocProgramOptionContext extends DartdocGeneratorOptionContext | ||
| with LoggingContext { | ||
| DartdocProgramOptionContext( | ||
| super.optionSet, super.dir, super.resourceProvider); | ||
|
|
||
| DartdocProgramOptionContext.fromDefaultContextLocation( | ||
| super.optionSet, super.resourceProvider) | ||
| : super.fromDefaultContextLocation(); | ||
|
|
||
| /// Whether to generate docs or perform a dry run. | ||
| bool get generateDocs => optionSet['generateDocs'].valueAt(context); | ||
| bool get help => optionSet['help'].valueAt(context); | ||
| bool get version => optionSet['version'].valueAt(context); | ||
| } | ||
|
|
||
| List<DartdocOption<bool>> createDartdocProgramOptions( | ||
| PackageMetaProvider packageMetaProvider) { | ||
| var resourceProvider = packageMetaProvider.resourceProvider; | ||
| return [ | ||
| DartdocOptionArgOnly<bool>('generateDocs', true, resourceProvider, | ||
| help: | ||
| 'Generate docs into the output directory (or only display warnings ' | ||
| 'if false).', | ||
| negatable: true), | ||
| DartdocOptionArgOnly<bool>('help', false, resourceProvider, | ||
| abbr: 'h', help: 'Show command help.', negatable: false), | ||
| DartdocOptionArgOnly<bool>('version', false, resourceProvider, | ||
| help: 'Display the version for $programName.', negatable: false), | ||
| ]; | ||
| } | ||
|
|
||
| DartdocProgramOptionContext? parseOptions( | ||
| PackageMetaProvider packageMetaProvider, | ||
| List<String> arguments, { | ||
| // Additional options are given in google3. | ||
| OptionGenerator? additionalOptions, | ||
| }) { | ||
| var optionRoot = DartdocOptionRoot.fromOptionGenerators( | ||
| 'dartdoc', | ||
| [ | ||
| createDartdocOptions, | ||
| createDartdocProgramOptions, | ||
| createLoggingOptions, | ||
| createGeneratorOptions, | ||
| if (additionalOptions != null) additionalOptions, | ||
| ], | ||
| packageMetaProvider); | ||
|
|
||
| try { | ||
| optionRoot.parseArguments(arguments); | ||
| } on FormatException catch (e) { | ||
| stderr.writeln(' fatal error: ${e.message}'); | ||
| stderr.writeln(''); | ||
| _printUsage(optionRoot.argParser); | ||
| // Do not use `exit()` as this bypasses `--pause-isolates-on-exit`. | ||
| exitCode = 64; | ||
| return null; | ||
| } | ||
| if (optionRoot['help'].valueAtCurrent() as bool) { | ||
| _printHelp(optionRoot.argParser); | ||
| exitCode = 0; | ||
| return null; | ||
| } | ||
| if (optionRoot['version'].valueAtCurrent() as bool) { | ||
| _printVersion(optionRoot.argParser); | ||
| exitCode = 0; | ||
| return null; | ||
| } | ||
|
|
||
| DartdocProgramOptionContext config; | ||
| try { | ||
| config = DartdocProgramOptionContext.fromDefaultContextLocation( | ||
| optionRoot, packageMetaProvider.resourceProvider); | ||
| } on DartdocOptionError catch (e) { | ||
| stderr.writeln(' fatal error: ${e.message}'); | ||
| stderr.writeln(''); | ||
| _printUsage(optionRoot.argParser); | ||
| exitCode = 64; | ||
| return null; | ||
| } | ||
| startLogging( | ||
| isJson: config.json, | ||
| isQuiet: config.quiet, | ||
| showProgress: config.showProgress, | ||
| ); | ||
| return config; | ||
| } | ||
|
|
||
| /// Print help if we are passed the help option. | ||
| void _printHelp(ArgParser parser) { | ||
| print('Generate HTML documentation for Dart libraries.\n'); | ||
| print(parser.usage); | ||
| } | ||
|
|
||
| /// Print usage information on invalid command lines. | ||
| void _printUsage(ArgParser parser) { | ||
| print('Usage: dartdoc [OPTIONS]\n'); | ||
| print(parser.usage); | ||
| } | ||
|
|
||
| /// Print version information. | ||
| void _printVersion(ArgParser parser) { | ||
| print('dartdoc version: $dartdocVersion'); | ||
| } | ||
| @Deprecated( | ||
| 'Will be removed in a later version of DartDoc. Use /src/dartdoc_options.dart.') | ||
| export 'package:dartdoc/src/dartdoc_options.dart'; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.