fix(misc): change ensureDependencies to ensurePackage (#13735)

nrwl · Dec 9, 2022 · 440112d · 440112d · vercel · Dec 9, 2022
1 parent 75de165
commit 440112d
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 4 deletions.
diff --git a/docs/generated/devkit/index.md b/docs/generated/devkit/index.md
@@ -1175,7 +1175,7 @@ Ensure that dependencies and devDependencies from package.json are installed at
 For example:
 
 ```typescript
-ensureDependencies(tree, {}, { '@nrwl/jest': nxVersion });
+ensurePackage(tree, {}, { '@nrwl/jest': nxVersion });
 ```
 
 This will check that @nrwl/jest@<nxVersion> exists in devDependencies.

diff --git a/docs/generated/packages/devkit.json b/docs/generated/packages/devkit.json
diff --git a/packages/devkit/src/utils/package-json.spec.ts b/packages/devkit/src/utils/package-json.spec.ts
@@ -311,7 +311,7 @@ describe('addDependenciesToPackageJson', () => {
   });
 });
 
-describe('ensureDependencies', () => {
+describe('ensurePackage', () => {
   let tree: Tree;
 
   beforeEach(() => {

diff --git a/packages/devkit/src/utils/package-json.ts b/packages/devkit/src/utils/package-json.ts
@@ -289,7 +289,7 @@ function requiresRemovingOfPackages(
  *
  * For example:
  * ```typescript
- * ensureDependencies(tree, {}, { '@nrwl/jest': nxVersion })
+ * ensurePackage(tree, {}, { '@nrwl/jest': nxVersion })
  * ```
  * This will check that @nrwl/jest@<nxVersion> exists in devDependencies.
  * If it exists then function returns, otherwise it will install the package before continuing.