Skip to content

Commit

Permalink
docs: naming of files in example code should be consistent (#5043)
Browse files Browse the repository at this point in the history
The use of `a` workspace have some inconsistency in terms of naming, making the doc not easy to follow.
  • Loading branch information
xc1427 authored Jul 11, 2022
1 parent da5a4ba commit 25b3058
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/content/using-npm/workspaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ structure of files and folders:
```
.
+-- node_modules
| `-- packages/a -> ../packages/a
| `-- a -> ../packages/a
+-- package-lock.json
+-- package.json
`-- packages
Expand Down Expand Up @@ -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
```

Expand Down

0 comments on commit 25b3058

Please sign in to comment.