@lerna/filter-options - npm Package Compare versions

Comparing version 3.0.0-beta.18 to 3.0.0-rc.0

CHANGELOG.md

@@ -6,2 +6,14 @@ # Change Log
 
+<a name="3.0.0-rc.0"></a>
+# [3.0.0-rc.0](https://github.com/lerna/lerna/compare/v3.0.0-beta.21...v3.0.0-rc.0) (2018-07-27)
+
+
+### Features
+
+* **cli:** Upgrade to Yargs 12 ([7899ab8](https://github.com/lerna/lerna/commit/7899ab8))
+
+
+
+
+
 <a name="3.0.0-beta.18"></a>
@@ -8,0 +20,0 @@ # [3.0.0-beta.18](https://github.com/lerna/lerna/compare/v3.0.0-beta.17...v3.0.0-beta.18) (2018-04-24)

index.js

@@ -32,13 +32,13 @@ "use strict";
       describe: dedent`
-        Include all transitive dependents when running a command,
-        regardless of --include, --exclude or --since.
+        Include all transitive dependents when running a command
+        regardless of --scope, --ignore, or --since.
       `,
-      boolean: true,
+      type: "boolean",
     },
     "include-filtered-dependencies": {
       describe: dedent`
-        Include all transitive dependencies when running a command,
-        regardless of --include, --exclude or --since.
+        Include all transitive dependencies when running a command
+        regardless of --scope, --ignore, or --since.
       `,
-      boolean: true,
+      type: "boolean",
     },
@@ -45,0 +45,0 @@ };

package.json

 {
   "name": "@lerna/filter-options",
-  "version": "3.0.0-beta.18",
+  "version": "3.0.0-rc.0",
   "description": "Options for lerna sub-commands that need filtering",
@@ -35,3 +35,3 @@ "keywords": [
   },
-  "gitHead": "7995561e8d010d9fa2e59109b57b9ad8573baba1"
+  "gitHead": "1ab24c152d3ff5c2b9453bcaafeb4b5e432b2410"
 }

README.md

@@ -5,4 +5,65 @@ # `@lerna/filter-options`
 
-## Usage
+## Options
 
-TODO
+### `--scope <glob>`
+
+Include only packages with names matching the given glob.
+
+```sh
+$ lerna exec --scope my-component -- ls -la
+$ lerna run --scope toolbar-* test
+```
+
+### `--ignore <glob>`
+
+Exclude packages with names matching the given glob.
+
+### `--no-private`
+
+Exclude private packages. They are included by default.
+
+### `--since [ref]`
+
+Only include packages that have been updated since the specified `ref`. If no ref is passed, it defaults to the most-recent tag.
+
+
+```sh
+# List the contents of packages that have changed since the latest tag
+$ lerna exec --since -- ls -la
+
+# Run the tests for all packages that have changed since `master`
+$ lerna run test --since master
+
+# List all packages that have changed since `some-branch`
+$ lerna ls --since some-branch
+```
+
+_This can be particularly useful when used in CI, if you can obtain the target branch a PR will be going into, because you can use that as the `ref` to the `--since` option. This works well for PRs going into master as well as feature branches._
+
+### `--include-filtered-dependents`
+
+Include all transitive dependents when running a command regardless of `--scope`, `--ignore`, or `--since`.
+
+### `--include-filtered-dependencies`
+
+Include all transitive dependencies when running a command regardless of `--scope`, `--ignore`, or `--since`.
+
+Used in combination with any command that accepts `--scope` (`bootstrap`, `clean`, `ls`, `run`, `exec`).
+Ensures that all dependencies (and dev dependencies) of any scoped packages (either through `--scope` or `--ignore`) are operated on as well.
+
+> Note: This will override the `--scope` and `--ignore` flags.
+>
+> > i.e. A package matched by the `--ignore` flag will still be bootstrapped if it is depended on by another package that is being bootstrapped.
+
+This is useful for situations where you want to "set up" a single package that relies on other packages being set up.
+
+```sh
+$ lerna bootstrap --scope my-component --include-filtered-dependencies
+# my-component and all of its dependencies will be bootstrapped
+```
+
+```sh
+$ lerna bootstrap --scope "package-*" --ignore "package-util-*" --include-filtered-dependencies
+# all packages matching "package-util-*" will be ignored unless they are
+# depended upon by a package whose name matches "package-*"
+```

No alert changes

Improved metrics

Total package byte prevSize

7107

increased by103.23%

Number of package files

5

increased by25%

Number of lines in readme file

69

increased by762.5%

No dependency changes