docs: Switch to named export in examples

lerna · Dec 8, 2020 · c489810 · c489810
1 parent c1303f1
commit c489810
Show file tree

Hide file tree

Showing 7 changed files with 7 additions and 11 deletions.
diff --git a/utils/check-working-tree/README.md b/utils/check-working-tree/README.md
@@ -5,7 +5,7 @@
 ## Usage
 
 ```js
-const checkWorkingTree = require("@lerna/check-working-tree");
+const { checkWorkingTree } = require("@lerna/check-working-tree");
 
 // values listed here are their defaults
 const options = {

diff --git a/utils/collect-uncommitted/README.md b/utils/collect-uncommitted/README.md
@@ -5,7 +5,7 @@
 ## Usage
 
 ```js
-const collectUncommitted = require("@lerna/collect-uncommitted");
+const { collectUncommitted } = require("@lerna/collect-uncommitted");
 
 // values listed here are their defaults
 const options = {

diff --git a/utils/describe-ref/README.md b/utils/describe-ref/README.md
@@ -5,7 +5,7 @@
 ## Usage
 
 ```js
-const describe = require("@lerna/describe-ref");
+const { describe } = require("@lerna/describe-ref");
 
 (async () => {
   const { lastTagName, lastVersion, refCount, sha, isDirty } = await describe();

diff --git a/utils/has-npm-version/README.md b/utils/has-npm-version/README.md
@@ -5,18 +5,14 @@
 ## Usage
 
 ```js
-const hasNpmVersion = require("@lerna/has-npm-version");
+const { hasNpmVersion } = require("@lerna/has-npm-version");
 
 // `npm --version` === 6.3.0
 hasNpmVersion(">=6"); // => true
 
 // `npm --version` === 5.6.0
 hasNpmVersion(">=6"); // => false
 
-// makePredicate() caches the call to `npm --version`
-// useful if you're calling it repeatedly in a loop
-const predicate = hasNpmVersion.makePredicate();
-
 // `npm --version` === 6.3.0
 hasNpmVersion(">=5"); // => true
 ```

diff --git a/utils/log-packed/README.md b/utils/log-packed/README.md
@@ -8,7 +8,7 @@ Extracted from the [npm source](https://github.com/npm/cli/blob/4f801d8a476f7ca5
 
 ```js
 const execa = require("execa");
-const logPacked = require("@lerna/log-packed");
+const { logPacked } = require("@lerna/log-packed");
 
 execa("npm", ["pack", "--json"]).then(result => {
   const tarballs = JSON.parse(result.stdout);

diff --git a/utils/prerelease-id-from-version/README.md b/utils/prerelease-id-from-version/README.md
@@ -5,7 +5,7 @@
 ## Usage
 
 ```js
-const prereleaseIdFromVersion = require("@lerna/prerelease-id-from-version");
+const { prereleaseIdFromVersion } = require("@lerna/prerelease-id-from-version");
 
 prereleaseIdFromVersion(1.0.0-alpha.0); // => "alpha"
 

diff --git a/utils/rimraf-dir/README.md b/utils/rimraf-dir/README.md
@@ -5,7 +5,7 @@
 ## Usage
 
 ```js
-const rimrafDir = require("@lerna/rimraf-dir");
+const { rimrafDir } = require("@lerna/rimraf-dir");
 
 rimrafDir("/path/to/directory").then(removedDir => {
   console.log("removed", removedDir);