Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit cf17f7e

Browse files
ovflowdbenhalverson
ovflowd
and
benhalverson
authored
refactor(mdx): refactored linting rules and general markdown fixes (#2757)
Co-authored-by: Ben Halverson <[email protected]>
1 parent 99ff542 commit cf17f7e

73 files changed

Lines changed: 19483 additions & 36132 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.babelrc‎

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,4 @@
11
{
2-
"generatorOpts": {
3-
"compact": true,
4-
"comments": false
5-
},
6-
"overrides": [
7-
{
8-
"test": "**/**.md",
9-
"compact": true
10-
}
11-
],
122
"plugins": [
133
[
144
"prismjs",

‎.eslintignore‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
11
.cache
22
public
3-
content/blog
4-
content/api
53
docs/
64
meetings/

‎.eslintrc.js‎

Lines changed: 41 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,40 @@
11
module.exports = {
2-
extends: ['airbnb', 'plugin:prettier/recommended'],
3-
env: {
4-
browser: true,
5-
node: true,
6-
},
72
overrides: [
83
{
9-
files: ['**/*.tsx'],
10-
plugins: ['@typescript-eslint', 'react-hooks'],
4+
files: ['**/*.{js,jsx}'],
5+
extends: ['airbnb', 'prettier'],
6+
env: { node: true },
7+
},
8+
{
9+
files: ['**/*.{ts,tsx}'],
10+
extends: ['airbnb', 'prettier', 'plugin:@typescript-eslint/recommended'],
11+
plugins: ['@typescript-eslint'],
12+
env: { browser: true, node: true },
1113
parser: '@typescript-eslint/parser',
12-
parserOptions: {
13-
ecmaFeatures: {
14-
jsx: true,
15-
},
14+
settings: { 'import/resolver': { typescript: {} } },
15+
rules: {
16+
'no-use-before-define': 'off',
17+
'@typescript-eslint/no-use-before-define': 'warn',
18+
'import/prefer-default-export': 'off',
19+
'import/extensions': 'off',
1620
},
21+
},
22+
{
23+
files: ['**/*.tsx'],
1724
extends: [
18-
'plugin:@typescript-eslint/recommended',
1925
'airbnb/hooks',
2026
'plugin:react/recommended',
2127
'plugin:jsx-a11y/recommended',
22-
'plugin:prettier/recommended',
2328
],
24-
settings: {
25-
react: {
26-
version: 'detect',
27-
},
28-
'import/resolver': {
29-
typescript: {},
30-
},
31-
},
29+
plugins: ['@typescript-eslint', 'react-hooks'],
30+
parserOptions: { ecmaFeatures: { jsx: true } },
31+
settings: { react: { version: 'detect' } },
3232
rules: {
3333
'react/no-unused-prop-types': 'off',
3434
'react/require-default-props': 'off',
3535
'react/jsx-filename-extension': 'off',
3636
'react-hooks/rules-of-hooks': 'error',
3737
'react-hooks/exhaustive-deps': 'warn',
38-
'no-use-before-define': 'off',
39-
'@typescript-eslint/no-use-before-define': 'warn',
40-
'import/extensions': 'off',
4138
'consistent-return': 'off',
4239
'react/function-component-definition': [
4340
'error',
@@ -48,48 +45,37 @@ module.exports = {
4845
],
4946
},
5047
},
51-
{
52-
files: ['**/*.ts'],
53-
plugins: ['@typescript-eslint', 'react-hooks'],
54-
parser: '@typescript-eslint/parser',
55-
settings: {
56-
'import/resolver': {
57-
typescript: {},
58-
},
59-
},
60-
extends: [
61-
'plugin:@typescript-eslint/recommended',
62-
'plugin:prettier/recommended',
63-
],
64-
rules: {
65-
'no-use-before-define': 'off',
66-
'@typescript-eslint/no-use-before-define': 'warn',
67-
'import/prefer-default-export': 'off',
68-
'import/extensions': 'off',
69-
},
70-
},
7148
{
7249
files: [
7350
'test-processor.js',
7451
'test-setup.js',
75-
'test/**',
76-
'**/**.test.js',
77-
'**/**.test.ts',
78-
'**/**.test.tsx',
52+
'test/**/**.{js,jsx,ts,tsx}',
53+
'**/**.test.{js,jsx,ts,tsx}',
7954
],
8055
extends: ['plugin:testing-library/react'],
81-
env: {
82-
jest: true,
83-
},
56+
env: { jest: true, node: true, browser: true },
8457
},
8558
{
86-
files: ['**/*.md'],
87-
plugins: ['markdown'],
88-
processor: 'markdown/markdown',
59+
// Disable linting for API as some parts are just not compatible with MDXv2
60+
files: ['content/**/*.{md,mdx}'],
61+
extends: ['plugin:mdx/recommended'],
62+
settings: { 'mdx/code-blocks': false },
63+
rules: { 'react/jsx-no-undef': 'off' },
64+
},
65+
{
66+
files: [
67+
'content/about/*.{md,mdx}',
68+
'content/download/*.{md,mdx}',
69+
'content/get-involved/*.{md,mdx}',
70+
'content/homepage/*.{md,mdx}',
71+
'content/learn/*.m{md,mdx}',
72+
],
73+
settings: { 'mdx/code-blocks': true },
8974
},
9075
{
91-
files: ['**/*.md/*.js', '**/*.md/*.ts'],
76+
files: ['content/**/*.{md,mdx}/*.{js,jsx,cjs,mjs,ts,tsx}'],
9277
rules: {
78+
camelcase: 'off',
9379
'@typescript-eslint/no-unused-vars': 'off',
9480
'consistent-return': 'off',
9581
'func-names': 'off',

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ yarn-error.log
88
.DS_Store
99
build
1010

11+
# Cache and Local files
1112
.env
1213
.env.production
1314
.firebase/*
@@ -16,6 +17,8 @@ coverage
1617
.history
1718
yarn.lock
1819
.idea/
20+
.eslintmdcache
21+
.eslintjscache
1922

2023
# Firebase
2124
firebase-debug.log

‎.remarkignore‎

Lines changed: 0 additions & 4 deletions
This file was deleted.

‎.remarkrc‎

Lines changed: 0 additions & 10 deletions
This file was deleted.

‎content/about/about.en.md‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: about
33
displayTitle: About
4-
description: "About | Node.js"
4+
description: 'About | Node.js'
55
authors: XhmikosR, mikeal, fhemberger, Fishrock123, yous, tomgco, tniessen, SMcCandlish, saadq, Trott, Gornstats, piperchester, naoufal, lpinca, j9t, bnoordhuis, harshadsabne, Chris911, benhalverson
66
category: about
77
---
@@ -24,6 +24,7 @@ const server = http.createServer((req, res) => {
2424
});
2525

2626
server.listen(port, hostname, () => {
27+
// eslint-disable-next-line no-console
2728
console.log(`Server running at http://${hostname}:${port}/`);
2829
});
2930
```
@@ -39,7 +40,7 @@ reasonable to develop in Node.js.
3940
If some of this language is unfamiliar, there is a full article on
4041
[Blocking vs. Non-Blocking][].
4142

42-
---
43+
***
4344

4445
Node.js is similar in design to, and influenced by, systems like Ruby's
4546
[Event Machine][] and Python's [Twisted][]. Node.js takes the event model a bit
@@ -62,9 +63,9 @@ communicate with. Built upon that same interface is the [`cluster`][] module,
6263
which allows you to share sockets between processes to enable load balancing
6364
over your cores.
6465

65-
[Blocking vs. Non-Blocking]: /learn/overview-of-blocking-vs-non-blocking/
66+
[blocking vs. non-blocking]: /learn/overview-of-blocking-vs-non-blocking/
6667
[`child_process.fork()`]: /api/child_process/
6768
[`cluster`]: https://nodejs.org/api/cluster.html
6869
[event loop]: /learn/the-nodejs-event-loop/
69-
[Event Machine]: https://github.com/eventmachine/eventmachine
70-
[Twisted]: https://twistedmatrix.com/trac/
70+
[event machine]: https://github.com/eventmachine/eventmachine
71+
[twisted]: https://twistedmatrix.com/trac/

‎content/about/about.fr.md‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: about
3-
displayTitle: "À propos"
4-
description: "À propos de | Node.js"
3+
displayTitle: 'À propos'
4+
description: 'À propos de | Node.js'
55
authors: XhmikosR, mikeal, fhemberger, Fishrock123, yous, tomgco, tniessen, SMcCandlish, saadq, Trott, Gornstats, piperchester, naoufal, lpinca, j9t, bnoordhuis, harshadsabne, Chris911, benhalverson, AugustinMauroy
66
category: about
77
---
@@ -24,6 +24,7 @@ const server = http.createServer((req, res) => {
2424
});
2525

2626
server.listen(port, hostname, () => {
27+
// eslint-disable-next-line no-console
2728
console.log(`Le serveur fonctionne à http://${hostname}:${port}/`);
2829
});
2930
```
@@ -37,7 +38,7 @@ Node.js n'effectue directement des E/S, de sorte que le processus ne se bloque j
3738
Si certains de ces termes ne vous sont pas familiers, vous trouverez un article complet sur le site suivant
3839
[Blocage vs. non-blocage][].
3940

40-
***
41+
---
4142

4243
Node.js est similaire dans sa conception à, et influencé par, des systèmes comme
4344
l'[Event Machine][] de Ruby et [Twisted][] de Python. Node.js présente une
@@ -61,9 +62,9 @@ en utilisant notre API [`child_process.fork()`][], et sont conçus pour être fa
6162
Construit sur cette même interface, le module [`cluster`][],
6263
qui vous permet de partager des sockets entre les processus pour équilibrer la charge sur les cœurs.
6364

64-
[Blocage vs. non-blocage]: https://nodejs.org/en/docs/guides/blocking-vs-non-blocking/
65-
[Event Machine]: https://github.com/eventmachine/eventmachine
66-
[Twisted]: https://twistedmatrix.com/trac/
65+
[blocage vs. non-blocage]: https://nodejs.org/en/docs/guides/blocking-vs-non-blocking/
66+
[event machine]: https://github.com/eventmachine/eventmachine
67+
[twisted]: https://twistedmatrix.com/trac/
6768
[`child_process.fork()`]: https://nodejs.org/api/child_process.html#child_process_child_process_fork_modulepath_args_options
6869
[`cluster`]: https://nodejs.org/api/cluster.html
6970
[boucle d'événement]: https://nodejs.org/en/docs/guides/event-loop-timers-and-nexttick/

‎content/about/governance.en.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ A guide for Collaborators is maintained at [collaborator-guide.md][].
2828
The project is governed by the [Technical Steering Committee (TSC)][]
2929
which is responsible for high-level guidance of the project.
3030

31-
[Consensus Seeking]: https://en.wikipedia.org/wiki/Consensus-seeking_decision-making
32-
[README.md]: https://github.com/nodejs/node/blob/main/README.md#current-project-team-members
33-
[TSC]: https://github.com/nodejs/TSC
34-
[Technical Steering Committee (TSC)]: https://github.com/nodejs/TSC/blob/main/TSC-Charter.md
31+
[consensus seeking]: https://en.wikipedia.org/wiki/Consensus-seeking_decision-making
32+
[readme.md]: https://github.com/nodejs/node/blob/main/README.md#current-project-team-members
33+
[tsc]: https://github.com/nodejs/TSC
34+
[technical steering committee (tsc)]: https://github.com/nodejs/TSC/blob/main/TSC-Charter.md
3535
[collaborator-guide.md]: https://github.com/nodejs/node/blob/main/doc/contributing/collaborator-guide.md
3636
[nodejs/node]: https://github.com/nodejs/node

‎content/about/governance.fr.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ Le projet est dirigé par le [Comité directeur technique (TSC)][]
3030
qui est responsable de l'orientation de haut niveau du projet
3131

3232
[recherche de consensus]: https://en.wikipedia.org/wiki/Consensus-seeking_decision-making
33-
[README.md]: https://github.com/nodejs/node/blob/main/README.md#current-project-team-members
34-
[TSC]: https://github.com/nodejs/TSC
35-
[Comité directeur technique (TSC)]: https://github.com/nodejs/TSC/blob/main/TSC-Charter.md
33+
[readme.md]: https://github.com/nodejs/node/blob/main/README.md#current-project-team-members
34+
[tsc]: https://github.com/nodejs/TSC
35+
[comité directeur technique (tsc)]: https://github.com/nodejs/TSC/blob/main/TSC-Charter.md
3636
[collaborator-guide.md]: https://github.com/nodejs/node/blob/main/doc/contributing/collaborator-guide.md
3737
[nodejs/node]: https://github.com/nodejs/node

0 commit comments

Comments
 (0)