chore: allow cjs and mjs info strings by aduh95 · Pull Request #176 · nodejs/remark-preset-lint-node

aduh95 · 2021-02-23T10:27:11Z

It seems ESLint folks are not interested in my meta string proposal, I guess the right move would be to move from

```js esm
// ES module
export {};
```

```js cjs
// CJS module
module.exports = {};
```

```js
// Whichever
console.log();
```

to

```mjs
// ES module
export {};
```

```cjs
// CJS module
module.exports = {};
```

```js
// Whichever
console.log();
```

Refs: nodejs/node#37162
Refs: nodejs/node#37311
Refs: eslint/markdown#170

FWIW, I'd be up to fork the eslint markdown plugin and maintain ourselves support for the meta string instead, but maybe it's not worth the maintenance burden.

Refs: nodejs/node#37162 Refs: nodejs/node#37311 Refs: eslint/markdown#170

nschonni

I'm assuming this works with HighlightJS/Prism and that maybe there is a downstream need to update those CSS/JS bundles to support this when building the docs in nodejs/node

nschonni · 2021-02-23T20:46:37Z

This was the other "metadata" style I was trying to think of before https://prettier.io/blog/2020/11/20/2.2.0.html#align-code-block-language-detection-with-other-popular-tools-9365httpsgithubcomprettierprettierpull9365-by-kachkaevhttpsgithubcomkachkaev

aduh95 · 2021-02-23T22:46:59Z

I'm assuming this works with HighlightJS

Yes, it works with highlight.js (not sure for Prism), so no need to change the nodejs/node doc generation tooling.

aduh95 · 2021-03-01T22:46:57Z

@nodejs/linting Should we land this?

aduh95 · 2021-03-04T12:33:24Z

@Trott Any chance you'll have time to publish this to npm? I don't think I have the permission to do it myself.

Trott · 2021-03-04T19:20:36Z

Published 2.1.1 which includes this.

Refs: nodejs#37162 Refs: nodejs/remark-preset-lint-node#176

Refs: nodejs/remark-preset-lint-node#176

Refs: nodejs#37162 Refs: nodejs/remark-preset-lint-node#176

Refs: nodejs/remark-preset-lint-node#176 PR-URL: nodejs#37605 Refs: nodejs#37162 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Danielle Adams <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]>

Refs: nodejs#37162 Refs: nodejs/remark-preset-lint-node#176 PR-URL: nodejs#37311 Refs: eslint/markdown#172 Reviewed-By: Rich Trott <[email protected]>

Refs: nodejs/remark-preset-lint-node#176 PR-URL: #37605 Refs: #37162 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Danielle Adams <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]>

Refs: #37162 Refs: nodejs/remark-preset-lint-node#176 PR-URL: #37311 Refs: eslint/markdown#172 Reviewed-By: Rich Trott <[email protected]>

Refs: nodejs/remark-preset-lint-node#176 PR-URL: nodejs#37605 Refs: nodejs#37162 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Danielle Adams <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]>

Refs: nodejs/remark-preset-lint-node#176 PR-URL: #37605 Refs: #37162 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Danielle Adams <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]>

chore: allow cjs and mjs info strings

8d37c0e

Refs: nodejs/node#37162 Refs: nodejs/node#37311 Refs: eslint/markdown#170

nschonni reviewed Feb 23, 2021

View reviewed changes

aduh95 mentioned this pull request Feb 23, 2021

tools,doc: add support for several flavors of JS code snippets nodejs/node#37162

Merged

4 tasks

Trott approved these changes Mar 2, 2021

View reviewed changes

jasnell mentioned this pull request Mar 3, 2021

doc: crypto esm examples nodejs/node#37594

Closed

Trott merged commit 5a93237 into nodejs:master Mar 4, 2021

aduh95 deleted the doc-multi-syntax-snippets branch March 4, 2021 20:32

aduh95 added a commit to aduh95/node that referenced this pull request Mar 4, 2021

tools: add support for mjs and cjs JS snippet linting

93c4095

Refs: nodejs#37162 Refs: nodejs/remark-preset-lint-node#176

aduh95 added a commit to aduh95/node that referenced this pull request Mar 4, 2021

doc: change lang info string in fs JS snippets

b0cee38

Refs: nodejs/remark-preset-lint-node#176

aduh95 mentioned this pull request Mar 4, 2021

doc: change lang info string in fs JS snippets nodejs/node#37605

Merged

aduh95 added a commit to aduh95/node that referenced this pull request Mar 4, 2021

doc: change lang info string in fs JS snippets

1039470

Refs: nodejs/remark-preset-lint-node#176

aduh95 added a commit to aduh95/node that referenced this pull request Mar 4, 2021

tools: add support for mjs and cjs JS snippet linting

a95ef66

Refs: nodejs#37162 Refs: nodejs/remark-preset-lint-node#176

danielleadams pushed a commit to nodejs/node that referenced this pull request Mar 16, 2021

tools: add support for mjs and cjs JS snippet linting

07fc61b

Refs: #37162 Refs: nodejs/remark-preset-lint-node#176 PR-URL: #37311 Refs: eslint/markdown#172 Reviewed-By: Rich Trott <[email protected]>

targos pushed a commit to nodejs/node that referenced this pull request May 30, 2021

tools: add support for mjs and cjs JS snippet linting

281936e

Refs: #37162 Refs: nodejs/remark-preset-lint-node#176 PR-URL: #37311 Refs: eslint/markdown#172 Reviewed-By: Rich Trott <[email protected]>

targos pushed a commit to nodejs/node that referenced this pull request Jun 5, 2021

tools: add support for mjs and cjs JS snippet linting

0876e20

Refs: #37162 Refs: nodejs/remark-preset-lint-node#176 PR-URL: #37311 Refs: eslint/markdown#172 Reviewed-By: Rich Trott <[email protected]>

targos pushed a commit to nodejs/node that referenced this pull request Jun 5, 2021

tools: add support for mjs and cjs JS snippet linting

893576c

Refs: #37162 Refs: nodejs/remark-preset-lint-node#176 PR-URL: #37311 Refs: eslint/markdown#172 Reviewed-By: Rich Trott <[email protected]>

targos pushed a commit to nodejs/node that referenced this pull request Jun 11, 2021

tools: add support for mjs and cjs JS snippet linting

8399766

Refs: #37162 Refs: nodejs/remark-preset-lint-node#176 PR-URL: #37311 Refs: eslint/markdown#172 Reviewed-By: Rich Trott <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Comments

chore: allow cjs and mjs info strings#176

chore: allow cjs and mjs info strings#176
Trott merged 1 commit intonodejs:masterfrom
aduh95:doc-multi-syntax-snippets

aduh95 commented Feb 23, 2021 •

edited

Loading

Uh oh!

nschonni left a comment

Uh oh!

nschonni commented Feb 23, 2021

Uh oh!

aduh95 commented Feb 23, 2021

Uh oh!

aduh95 commented Mar 1, 2021

Uh oh!

aduh95 commented Mar 4, 2021

Uh oh!

Trott commented Mar 4, 2021 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Comments

Conversation

aduh95 commented Feb 23, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nschonni left a comment

Choose a reason for hiding this comment

Uh oh!

nschonni commented Feb 23, 2021

Uh oh!

aduh95 commented Feb 23, 2021

Uh oh!

aduh95 commented Mar 1, 2021

Uh oh!

aduh95 commented Mar 4, 2021

Uh oh!

Trott commented Mar 4, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

aduh95 commented Feb 23, 2021 •

edited

Loading

Trott commented Mar 4, 2021 •

edited

Loading