Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

AF-137 add help option #28

Merged
merged 3 commits into from
May 25, 2018
Merged

AF-137 add help option #28

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
44607b2
AF-137 add help option
toddbeckman-wf May 25, 2018
a61e085
AF-137 show help when parsing fails
toddbeckman-wf May 25, 2018
99ef55b
Merge branch 'master' into AF-137_help
toddbeckman-wf May 25, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
136 changes: 109 additions & 27 deletions bin/dependency_validator.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,36 +12,127 @@
// See the License for the specific language governing permissions and
// limitations under the License.

import 'dart:io' show stderr, stdout;
import 'dart:io' show exit, stderr, stdout;

import 'package:args/args.dart';
import 'package:logging/logging.dart';
import 'package:dependency_validator/dependency_validator.dart';

const String helpArg = 'help';
const String verboseArg = 'verbose';
const String ignoreArg = 'ignore';

const String excludeDirArg = 'exclude-dir';

const String fatalPinsArg = 'fatal-pins';

const String fatalMissingArg = 'fatal-missing';
const String fatalDevMissingArg = 'fatal-dev-missing';

const String fatalUnderPromotedArg = 'fatal-under-promoted';
const String fatalOverPromotedArg = 'fatal-over-promoted';

const String fatalUnusedArg = 'fatal-unused';

/// Parses the command-line arguments
final ArgParser argParser = new ArgParser()
..addFlag('verbose', defaultsTo: false)
..addOption('ignore', abbr: 'i', allowMultiple: true, splitCommas: true)
..addOption('exclude-dir', abbr: 'x', allowMultiple: true, splitCommas: true)
..addFlag('fatal-pins', defaultsTo: true)
..addFlag('fatal-under-promoted', defaultsTo: true)
..addFlag('fatal-over-promoted', defaultsTo: true)
..addFlag('fatal-missing', defaultsTo: true)
..addFlag('fatal-dev-missing', defaultsTo: true)
..addFlag('fatal-unused', defaultsTo: true);
..addFlag(
helpArg,
abbr: 'h',
help: 'Displays this info.',
)
..addFlag(
verboseArg,
defaultsTo: false,
help: 'Display extra information for debugging.',
)
..addOption(
ignoreArg,
abbr: 'i',
allowMultiple: true,
help: 'Comma-delimited list of packages to ignore from validation.',
splitCommas: true,
)
..addOption(
excludeDirArg,
abbr: 'x',
allowMultiple: true,
help: 'Comma-delimited list of directories to exclude from validation.',
splitCommas: true,
)
..addFlag(
fatalPinsArg,
defaultsTo: true,
help: 'Whether to fail on dependency pins.',
)
..addFlag(
fatalUnderPromotedArg,
help: 'Whether to fail on dependencies that are in `dev_dependencies` that should be in `dependencies`.',
defaultsTo: true,
)
..addFlag(
fatalOverPromotedArg,
defaultsTo: true,
help: 'Whether to fail on dependencies that are in `dependencies` that should be in `dev_dependencies`.',
)
..addFlag(
fatalMissingArg,
defaultsTo: true,
help: 'Whether to fail on dependencies that are missing from `dependencies`.',
)
..addFlag(
fatalDevMissingArg,
defaultsTo: true,
help: 'Whether to fail on dependencies that are missing from `dev_dependencies`.',
)
..addFlag(
fatalUnusedArg,
defaultsTo: true,
help: 'Whether to fail on dependencies in the `pubspec.yaml` that are never used in any of:\n'
'- bin/\n'
'- lib/\n'
'- examples/\n'
'- test/\n'
'- tool/\n'
'- web/\n',
);

void showHelpAndExit() {
Logger.root.shout(argParser.usage);
exit(0);
}

void main(List<String> args) {
final argResults = argParser.parse(args);
Logger.root.onRecord
.where((record) => record.level < Level.WARNING)
.map((record) => record.message)
.listen(stdout.writeln);
Logger.root.onRecord
.where((record) => record.level >= Level.WARNING)
.map((record) => record.message)
.listen(stderr.writeln);

ArgResults argResults;
try {
argResults = argParser.parse(args);
} catch (e) {
showHelpAndExit();
}

if (argResults.wasParsed('verbose') && argResults['verbose']) {
if (argResults.wasParsed(helpArg) && argResults[helpArg]) {
showHelpAndExit();
}

if (argResults.wasParsed(verboseArg) && argResults[verboseArg]) {
Logger.root.level = Level.ALL;
}

final fatalUnderPromoted = argResults['fatal-under-promoted'] ?? true;
final fatalOverPromoted = argResults['fatal-over-promoted'] ?? true;
final fatalMissing = argResults['fatal-missing'] ?? true;
final fatalDevMissing = argResults['fatal-dev-missing'] ?? true;
final fatalUnused = argResults['fatal-unused'] ?? true;
final fatalPins = argResults['fatal-pins'] ?? true;
final fatalUnderPromoted = argResults[fatalUnderPromotedArg] ?? true;
final fatalOverPromoted = argResults[fatalOverPromotedArg] ?? true;
final fatalMissing = argResults[fatalMissingArg] ?? true;
final fatalDevMissing = argResults[fatalDevMissingArg] ?? true;
final fatalUnused = argResults[fatalUnusedArg] ?? true;
final fatalPins = argResults[fatalPinsArg] ?? true;

List<String> ignoredPackages;

Expand All @@ -59,15 +150,6 @@ void main(List<String> args) {
excludedDirs = const <String>[];
}

Logger.root.onRecord
.where((record) => record.level < Level.WARNING)
.map((record) => record.message)
.listen(stdout.writeln);
Logger.root.onRecord
.where((record) => record.level >= Level.WARNING)
.map((record) => record.message)
.listen(stderr.writeln);

run(
excludedDirs: excludedDirs,
fatalDevMissing: fatalDevMissing,
Expand Down