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: add support for meta info in JS snippet linting #37311

Merged
merged 1 commit into from
Mar 6, 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
21 changes: 13 additions & 8 deletions .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -53,12 +53,6 @@ module.exports = {
overrides: [
{
files: [
'doc/api/esm.md/*.js',
'doc/api/fs.md/*.js',
'doc/api/module.md/*.js',
'doc/api/modules.md/*.js',
'doc/api/packages.md/*.js',
'doc/api/wasi.md/*.js',
'test/es-module/test-esm-type-flag.js',
'test/es-module/test-esm-type-flag-alias.js',
'*.mjs',
Expand All @@ -71,10 +65,21 @@ module.exports = {
processor: 'markdown/markdown',
},
{
files: ['**/*.md/*.js'],
parserOptions: { ecmaFeatures: { impliedStrict: true } },
files: ['**/*.md/*.cjs', '**/*.md/*.js'],
parserOptions: {
sourceType: 'script',
ecmaFeatures: { impliedStrict: true }
},
rules: { strict: 'off' },
},
{
files: [
'**/*.md/*.mjs',
'doc/api/esm.md/*.js',
'doc/api/packages.md/*.js',
],
parserOptions: { sourceType: 'module' },
},
],
rules: {
// ESLint built-in rules
Expand Down
1 change: 1 addition & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -1220,6 +1220,7 @@ lint-js-fix:
.PHONY: lint-js-doc
# Note that on the CI `lint-js-ci` is run instead.
# Lints the JavaScript code with eslint.
lint-js-doc: LINT_JS_TARGETS=doc
lint-js lint-js-doc:
@if [ "$(shell $(node_use_openssl))" != "true" ]; then \
echo "Skipping $@ (no crypto)"; \
Expand Down
2 changes: 0 additions & 2 deletions doc/api/buffer.md
Original file line number Diff line number Diff line change
Expand Up @@ -2647,7 +2647,6 @@ buf.writeFloatBE(0xcafebabe, 0);

console.log(buf);
// Prints: <Buffer 4f 4a fe bb>

```

### `buf.writeFloatLE(value[, offset])`
Expand Down Expand Up @@ -2856,7 +2855,6 @@ buf.writeIntBE(0x1234567890ab, 0, 6);

console.log(buf);
// Prints: <Buffer 12 34 56 78 90 ab>

```

### `buf.writeIntLE(value, offset, byteLength)`
Expand Down
10 changes: 5 additions & 5 deletions doc/api/module.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,13 @@ if a module is maintained by a third party or not.
`module` in this context isn't the same object that's provided
by the [module wrapper][]. To access it, require the `Module` module:

```js
```mjs
// module.mjs
// In an ECMAScript module
import { builtinModules as builtin } from 'module';
```

```js
```cjs
// module.cjs
// In a CommonJS module
const builtin = require('module').builtinModules;
Expand All @@ -51,7 +51,7 @@ added: v12.2.0
string.
* Returns: {require} Require function

```js
```mjs
import { createRequire } from 'module';
const require = createRequire(import.meta.url);

Expand Down Expand Up @@ -114,13 +114,13 @@ To enable source map parsing, Node.js must be run with the flag
[`--enable-source-maps`][], or with code coverage enabled by setting
[`NODE_V8_COVERAGE=dir`][].

```js
```mjs
// module.mjs
// In an ECMAScript module
import { findSourceMap, SourceMap } from 'module';
```

```js
```cjs
// module.cjs
// In a CommonJS module
const { findSourceMap, SourceMap } = require('module');
Expand Down
1 change: 0 additions & 1 deletion doc/api/stream.md
Original file line number Diff line number Diff line change
Expand Up @@ -2090,7 +2090,6 @@ const myWritable = new Writable({
});
// Later, abort the operation closing the stream
controller.abort();

```
#### `writable._construct(callback)`
<!-- YAML
Expand Down
2 changes: 1 addition & 1 deletion doc/api/wasi.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The WASI API provides an implementation of the [WebAssembly System Interface][]
specification. WASI gives sandboxed WebAssembly applications access to the
underlying operating system via a collection of POSIX-like functions.

```js
```mjs
import fs from 'fs';
import { WASI } from 'wasi';

Expand Down
1 change: 0 additions & 1 deletion doc/guides/writing-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,6 @@ const server = http.createServer(common.mustCall((req, res) => {
server.close();
}));
}));

```

**Note:** Many functions invoke their callback with an `err` value as the first
Expand Down