From 25b305830be0892bbbf0245aee2eebdb76ee2ce3 Mon Sep 17 00:00:00 2001 From: Chen XI Date: Tue, 12 Jul 2022 04:32:18 +0800 Subject: [PATCH] docs: naming of files in example code should be consistent (#5043) The use of `a` workspace have some inconsistency in terms of naming, making the doc not easy to follow. --- docs/content/using-npm/workspaces.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/content/using-npm/workspaces.md b/docs/content/using-npm/workspaces.md index 26d6a5d7551dc..82491cd74af82 100644 --- a/docs/content/using-npm/workspaces.md +++ b/docs/content/using-npm/workspaces.md @@ -57,7 +57,7 @@ structure of files and folders: ``` . +-- node_modules -| `-- packages/a -> ../packages/a +| `-- a -> ../packages/a +-- package-lock.json +-- package.json `-- packages @@ -112,15 +112,15 @@ respect the provided `workspace` configuration. Given the [specifities of how Node.js handles module resolution](https://nodejs.org/dist/latest-v14.x/docs/api/modules.html#modules_all_together) it's possible to consume any defined workspace by its declared `package.json` `name`. Continuing from the example defined -above, let's also create a Node.js script that will require the `workspace-a` +above, let's also create a Node.js script that will require the workspace `a` example module, e.g: ``` -// ./workspace-a/index.js +// ./packages/a/index.js module.exports = 'a' // ./lib/index.js -const moduleA = require('workspace-a') +const moduleA = require('a') console.log(moduleA) // -> a ```