diff --git a/README.md b/README.md index d0feda915..e823c92e0 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ dart pub global run very_good_cli:very_good ### Commands ✨ -### `very_good create` +### [`very_good create`](https://cli.vgv.dev/docs/category/templates) Create a very good project in seconds based on the provided template. Each template has a corresponding sub-command (e.g.,`very_good create flutter_app` will generate a Flutter starter app). @@ -114,7 +114,31 @@ very_good create docs_site my_docs_site --- -### `very_good packages get` +### [`very_good test`](https://cli.vgv.dev/docs/commands/test) + +Run tests in a Dart or Flutter project. + +```sh +# Run all tests +very_good test + +# Run all tests and collect coverage +very_good test --coverage + +# Run all tests and enforce 100% coverage +very_good test --coverage --min-coverage 100 + +# Run only tests in ./some/other/directory +very_good test ./some/other/directory + +# Run tests recursively +very_good test --recursive + +# Run tests recursively (shorthand) +very_good test -r +``` + +### [`very_good packages get`](https://cli.vgv.dev/docs/commands/get_pkgs) Get packages in a Dart or Flutter project. @@ -132,31 +156,25 @@ very_good packages get --recursive very_good packages get -r ``` -### `very_good test` +### [`very_good packages check licenses`](https://cli.vgv.dev/docs/commands/check_licenses) -Run tests in a Dart or Flutter project. +Check packages' licenses in a Dart or Flutter project. ```sh -# Run all tests -very_good test +# Check licenses in the current directory +very_good packages check licenses -# Run all tests and collect coverage -very_good test --coverage +# Only allow the use of certain licenses +very_good packages check licenses --allowed="MIT,BSD-3-Clause,BSD-2-Clause,Apache-2.0" -# Run all tests and enforce 100% coverage -very_good test --coverage --min-coverage 100 +# Deny the use of certain licenses +very_good packages check licenses --forbidden="unknown" -# Run only tests in ./some/other/directory -very_good test ./some/other/directory - -# Run tests recursively -very_good test --recursive - -# Run tests recursively (shorthand) -very_good test -r +# Check licenses for certain dependencies types +very_good packages check licenses --dependency-type="direct-main,transitive" ``` -### `very_good --help` +### [`very_good --help`](https://cli.vgv.dev/docs/overview) See the complete list of commands and usage information. diff --git a/lib/src/commands/packages/commands/check/commands/licenses.dart b/lib/src/commands/packages/commands/check/commands/licenses.dart index f20c1feff..7a902acbb 100644 --- a/lib/src/commands/packages/commands/check/commands/licenses.dart +++ b/lib/src/commands/packages/commands/check/commands/licenses.dart @@ -84,7 +84,7 @@ class PackagesCheckLicensesCommand extends Command { @override String get description => - 'Check packages licenses in a Dart or Flutter project.'; + "Check packages' licenses in a Dart or Flutter project."; @override String get name => 'licenses'; diff --git a/site/docs/overview.md b/site/docs/overview.md index dfcce9458..f836ce9da 100644 --- a/site/docs/overview.md +++ b/site/docs/overview.md @@ -80,6 +80,24 @@ very_good packages get --recursive very_good packages get -r ``` +### `very_good packages check licenses` + +Check packages' licenses in a Dart or Flutter project. + +```sh +# Check licenses in the current directory +very_good packages check licenses + +# Only allow the use of certain licenses +very_good packages check licenses --allowed="MIT,BSD-3-Clause,BSD-2-Clause,Apache-2.0" + +# Deny the use of certain licenses +very_good packages check licenses --forbidden="unknown" + +# Check licenses for certain dependencies types +very_good packages check licenses --dependency-type="direct-main,transitive" +``` + ### `very_good test` Run tests in a Dart or Flutter project. diff --git a/test/src/commands/packages/commands/check/check_test.dart b/test/src/commands/packages/commands/check/check_test.dart index 344640c9e..6a07b5abc 100644 --- a/test/src/commands/packages/commands/check/check_test.dart +++ b/test/src/commands/packages/commands/check/check_test.dart @@ -14,7 +14,7 @@ const _expectedPackagesCheckUsage = [ '-h, --help Print this usage information.\n' '\n' 'Available subcommands:\n' - ' licenses Check packages licenses in a Dart or Flutter project.\n' + " licenses Check packages' licenses in a Dart or Flutter project.\n" '\n' 'Run "very_good help" to see global options.' ]; diff --git a/test/src/commands/packages/commands/check/commands/licenses_test.dart b/test/src/commands/packages/commands/check/commands/licenses_test.dart index 058a101da..542648562 100644 --- a/test/src/commands/packages/commands/check/commands/licenses_test.dart +++ b/test/src/commands/packages/commands/check/commands/licenses_test.dart @@ -14,7 +14,7 @@ class _MockProgress extends Mock implements Progress {} const _expectedPackagesCheckLicensesUsage = [ // ignore: no_adjacent_strings_in_list - 'Check packages licenses in a Dart or Flutter project.\n' + "Check packages' licenses in a Dart or Flutter project.\n" '\n' 'Usage: very_good packages check licenses [arguments]\n' '-h, --help Print this usage information.\n'