Skip to content
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.

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

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

Merged
merged 2 commits into from
Jun 3, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
23 changes: 23 additions & 0 deletions .eslintrc.js
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
10 changes: 4 additions & 6 deletions doc/api/crypto.md
Original file line number Diff line number Diff line change
Expand Up @@ -1518,9 +1518,7 @@ hash.end();
Example: Using `Hash` and piped streams:

```mjs
const {
createReadStream,
} = require('fs');
import { createReadStream } from 'fs';

const {
createHash,
Expand Down Expand Up @@ -1551,7 +1549,7 @@ Example: Using the [`hash.update()`][] and [`hash.digest()`][] methods:
```mjs
const {
createHash,
} = require('crypto');
} = await import('crypto');

const hash = createHash('sha256');

Expand Down Expand Up @@ -1596,7 +1594,7 @@ its [`hash.digest()`][] method has been called.
// Calculate a rolling hash.
const {
createHash,
} = require('crypto');
} = await import('crypto');

const hash = createHash('sha256');

Expand Down Expand Up @@ -1691,7 +1689,7 @@ Example: Using `Hmac` objects as streams:
```mjs
const {
createHmac,
} = require('crypto');
} = await import('crypto');

const hmac = createHmac('sha256', 'a secret');

Expand Down
2 changes: 1 addition & 1 deletion doc/api/esm.md
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
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