Skip to content

tools,doc: forbid CJS globals in ESM code snippets #38889

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aduh95 merged 2 commits into from
Jun 3, 2021
Merged

tools,doc: forbid CJS globals in ESM code snippets #38889

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
47548d0
doc: fix .mjs syntax in crypto.md
himself65 Jun 1, 2021
2481fac
tools,doc: forbid CJS globals in ESM code snippets
aduh95 Jun 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
tools,doc: forbid CJS globals in ESM code snippets 
PR-URL: #38889
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Danielle Adams <[email protected]>
Reviewed-By: Zeyu Yang <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Darshan Sen <[email protected]>
  • Loading branch information
@aduh95
aduh95 committed Jun 3, 2021
commit 2481facd9ff3af57924c2391c507f13abf73ba3a
23 changes: 23 additions & 0 deletions .eslintrc.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,29 @@ module.exports = {
'doc/api/packages.md/*.js',
],
parserOptions: { sourceType: 'module' },
rules: { 'no-restricted-globals': [
'error',
{
name: '__filename',
message: 'Use import.meta.url instead',
},
{
name: '__dirname',
message: 'Not available in ESM',
},
{
name: 'exports',
message: 'Not available in ESM',
},
{
name: 'module',
message: 'Not available in ESM',
},
{
name: 'require',
message: 'Use import instead',
},
] },
},
],
rules: {
Expand Down
2 changes: 1 addition & 1 deletion doc/api/esm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -387,7 +387,7 @@ analysis process.

For example, consider a CommonJS module written:

```js
```cjs
// cjs.cjs
exports.name = 'exported';
```
Expand Down
8 changes: 4 additions & 4 deletions doc/api/packages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -704,7 +704,7 @@ import { another } from 'a-package/m.mjs';
Self-referencing is also available when using `require`, both in an ES module,
and in a CommonJS one. For example, this code will also work:

```js
```cjs
// ./a-module.js
const { something } = require('a-package/foo'); // Loads from ./foo.js.
```
Expand Down Expand Up @@ -807,7 +807,7 @@ to be treated as ES modules, just as `"type": "commonjs"` would cause them
to be treated as CommonJS.
See [Enabling](#esm_enabling).

```js
```cjs
// ./node_modules/pkg/index.cjs
exports.name = 'value';
```
Expand Down Expand Up @@ -920,7 +920,7 @@ CommonJS and ES module instances of the package:
CommonJS and ES module versions of the package. For example, if the CommonJS
and ES module entry points are `index.cjs` and `index.mjs`, respectively:

```js
```cjs
// ./node_modules/pkg/index.cjs
const state = require('./state.cjs');
module.exports.state = state;
Expand Down Expand Up @@ -1034,7 +1034,7 @@ The `"main"` field defines the script that is used when the [package directory
is loaded via `require()`](modules.md#modules_folders_as_modules). Its value
is a path.

```js
```cjs
require('./path/to/directory'); // This resolves to ./path/to/directory/main.js.
```

Expand Down