Merge pull request #5 from webpack/master

20220317

Author: xp44mm

.alexignore

@@ -1,16 +1,17 @@
 {
   "presets": [
     "@babel/preset-env",
-    "@babel/preset-react"
-  ],
-  "plugins": [
-    "@babel/plugin-proposal-class-properties"
+    [
+      "@babel/preset-react",
+      {
+        "runtime": "automatic"
+      }
+    ]
   ],
+  "plugins": ["@babel/plugin-proposal-class-properties"],
   "env": {
     "development": {
-      "plugins": [
-        "react-refresh/babel"
-      ]
+      "plugins": ["react-refresh/babel"]
     }
   }
 }

.alexrc

@@ -0,0 +1,2 @@
+defaults
+not ie 11

.babelrc

@@ -7,7 +7,7 @@ trim_trailing_whitespace = true
 insert_final_newline = true
 
 # Format Source Code
-[*.{md,js,jsx,json,scss,hbs}]
+[*.{md,mdx,js,jsx,json,scss,hbs}]
 charset = utf-8
 indent_style = space
 indent_size = 2

.browserslistrc

@@ -1,3 +1,6 @@
 dist/
-src/content/loaders/_*.md
-src/content/plugins/_*.md
+examples/
+src/content/loaders/_*.mdx
+src/content/plugins/_*.mdx
+.github/**/*.md
+README.md

.editorconfig

@@ -0,0 +1,58 @@
+module.exports = {
+  root: true,
+  extends: ['eslint:recommended', 'plugin:react/recommended', 'prettier'],
+  parser: '@babel/eslint-parser',
+  env: {
+    browser: true,
+    es6: true,
+    node: true,
+    jest: true,
+    'cypress/globals': true,
+  },
+  plugins: ['cypress', 'react-hooks'],
+  rules: {
+    'no-console': 'off',
+    semi: ['error', 'always'],
+    quotes: ['error', 'single'],
+    'no-duplicate-imports': 'error',
+    'react/jsx-uses-react': 'off', // no longer needed with new jsx transform
+    'react/react-in-jsx-scope': 'off', // ditto
+    'react-hooks/rules-of-hooks': 'error',
+    'react-hooks/exhaustive-deps': 'warn',
+  },
+  settings: {
+    react: {
+      version: 'detect',
+    },
+  },
+  overrides: [
+    { files: ['src/**/*.jsx'] }, // eslint would lint .js only by default
+    {
+      files: ['**/*.mdx'],
+      extends: ['plugin:mdx/recommended'],
+      globals: {
+        Badge: true,
+        StackBlitzPreview: true,
+      },
+      rules: {
+        semi: ['off'],
+      },
+      settings: {
+        'mdx/code-blocks': true,
+      },
+    },
+    {
+      files: ['**/*.mdx/*.{js,javascript}'], // we don't lint ts at the moment
+      rules: {
+        indent: ['error', 2],
+        quotes: ['error', 'single', { allowTemplateLiterals: true }],
+        'no-undef': 'off',
+        'no-unused-vars': 'off',
+        'no-constant-condition': 'off',
+        'no-useless-escape': 'off',
+        'no-dupe-keys': 'off',
+        'no-duplicate-imports': 'off',
+      },
+    },
+  ],
+};

.eslintignore

@@ -1,5 +1,4 @@
-Code of Conduct
----------------
+## Code of Conduct
 
 At webpack and all webpack/webpack-contrib repositories we follow the
 [JSFoundation Code of Conduct][1]. Please adhere to the guidelines there and

.eslintrc

@@ -1,42 +1,34 @@
-Contributing
-------------
+## Contributing
 
 From opening an issue for a documentation suggestion to creating a pull request: every
 contribution is appreciated and welcome. If you're planning to implement a new section or
 page please create an issue first.
 
-
 ## Setup
 
 Start by ensuring that you have Node.js installed and forking the repository:
 
 - Install [Node.js][1] if you have not already.
+- Install [Yarn][13] if you have not already. Yarn is an alternative to npm, and it is required for building the site as we use `yarn` specific features like `resolutions` which are not available in other package managers like `pnpm`.
 - Fork the **webpack.js.org** repo from [the main repository][2].
 - `git clone <your-clone-url> && cd webpack.js.org`
 
 Once you are in the project directory, run the following commands:
 
-- `npm install` to pull all dependencies. Make sure to check notes below if you prefer Yarn.
-- `npm run build` to create a production version of the site.
-- `npm start` to develop on a local webpack-dev-server: [localhost:3000][3].
+- `yarn` to pull all dependencies.
+- `yarn build` to create a production version of the site.
+- `yarn start` to develop on a local webpack-dev-server: [localhost:3000][3].
 
-> NOTE: run `npm fetch` before running `npm start` command for the first time
+> NOTE: run `yarn fetch` before running `yarn start` command for the first time
 
-- `npm run fetch` to retrieve external documentation/data.
+- `yarn fetch` to retrieve external documentation/data.
 
-The final command, `npm run fetch`, is optional as both `npm run build` and `npm start`
+The final command, `yarn fetch`, is optional as both `yarn build` and `yarn start`
 will do this automatically. This step pulls in documentation for loaders/plugins hosted
 in separate repositories such as the ones found in the [webpack-contrib][4] organization.
 See the `package.json` for the full list of `scripts`.
 
-> Note that __Node 6.9.x__ or above is required for the build process to run properly.
-
-> Note that a __Python version between v2.5.0 and 3.0.0__ is required for the [proselint][12] dependency.
-
-> Although __Yarn__ is not required to work with webpack docs, the core team is using it more extensively. If you prefer to use Yarn make sure that you [get it installed][13] and run `yarn` to pull all dependencies, `yarn build` to build the project, or `yarn start` to start the development server.
-
-> On Debian and Ubuntu operating systems you may have to use `node >= 7.0.0` to avoid build errors with `node-sass`. Please note that we don't officially support building on these systems.
-
+> Note that **Node 12.x** or above is required for the build process to run properly.
 
 ## Contributor License Agreement
 
@@ -47,35 +39,31 @@ not the same as your email used on GitHub, the CLA bot can't accept your contrib
 
 Run `git config user.email` to see your Git email, and verify it with your [GitHub email][5].
 
-
 ## Editor Config
 
 The [.editorconfig][6] in the root should ensure consistent formatting. Please make sure
 you've [installed the plugin][7] if your text editor needs one.
 
-
 ## Branching Your Changes
 
 Making a branch in your fork for your contribution is helpful in the following ways:
 
 - It allows you to have multiple contributions in as PRs at once.
 - It allows us to identify what your contribution is about from the branch name.
 
-
 ## Committing Your Changes
 
 Please follow the [conventional commits][10] specification. For example, for documentation
 changes, a short commit message may resemble the following:
 
-``` md
+```md
 docs(config): clarify `output.filename` usage
 ```
 
 Note that you can add a body/footer if more details are necessary. Soon we will
 start utilizing [`standard-version`][11] for releases/changelog generation. This
 will also potentially tie in to having archived docs for each major version.
 
-
 ## Submitting Changes
 
 After getting some feedback, push to your fork branch and submit a pull request. We may
@@ -86,13 +74,12 @@ Issue the PR to the [master][8] branch.
 
 > See [GitHub documentation][9] for more help.
 
-
 ## Recognition
 
 You can choose to add your GitHub username for recognition at the top of any markdown
 document you edit:
 
-__example.md__
+**example.md**
 
 ```markdown
 ---
@@ -111,13 +98,11 @@ Some documentation...
 This will add your name and GitHub profile photo to the document in production. It's a
 great way to own the awesome work that you do and we encourage you to do this in your PRs.
 
-
 ## Thank You
 
-webpack is a feature rich, low level tool and documentation is a huge time sink. We appreciate
+Webpack is a feature rich, low level tool and documentation is a huge time sink. We appreciate
 any time spent fixing typos or clarifying sections in the documentation.
 
-
 [1]: https://nodejs.org/
 [2]: https://github.com/webpack/webpack.js.org
 [3]: http://localhost:3000/
@@ -129,5 +114,4 @@ any time spent fixing typos or clarifying sections in the documentation.
 [9]: https://help.github.com/articles/proposing-changes-to-your-work-with-pull-requests/
 [10]: http://conventionalcommits.org/
 [11]: https://github.com/conventional-changelog/standard-version
-[12]: https://github.com/amperser/proselint
 [13]: https://yarnpkg.com/lang/en/docs/install

.eslintrc.js

@@ -4,4 +4,4 @@
 - [ ] For the document of Chinese translation（中文版文档), go to https://github.com/docschina/webpack.js.org.
 - [ ] For loader/plugin docs, consider opening an issue in the corresponding repository.
 - [ ] No existing issue? Go ahead and open a new one.
-- __Remove these instructions from your PR as they are for your eyes only.__
+- **Remove these instructions from your PR as they are for your eyes only.**

.github/CODE_OF_CONDUCT.md

@@ -3,16 +3,16 @@ name: Documentation request
 about: Create a documentation request for a new feature or functionality change.
 ---
 
-__Feature to document__
+**Feature to document**
 
 <!-- Name of the feature(s) and a link to related pull request of the feature implementation. -->
 
-__Author(s)__
+**Author(s)**
 
 <!-- Mention feature author(s) in order to know who is assignable for review outside of the documentation team. -->
 
-__Additional information__
+**Additional information**
 
 <!-- Please provide any additional information that is required in order to document the feature in the best possible way or say N/A if linked PR has more than enough details. -->
 
-[ ] I am willing to work on this issue and submit a pull request.
+[ ] I am willing to work on this issue and submit a pull request.

.github/CONTRIBUTING.md

@@ -4,9 +4,8 @@ _describe your changes..._
 - [ ] Make sure your PR complies with the [writer's guide][2].
 - [ ] Review the diff carefully as sometimes this can reveal issues.
 - [ ] Do not abandon your Pull Request: [Stale Pull Requests][3].
-- __Remove these instructions from your PR as they are for your eyes only.__
+- **Remove these instructions from your PR as they are for your eyes only.**
 
-
-[1]: https://cla.js.foundation/webpack/webpack.js.org
+[1]: https://github.com/openjs-foundation/EasyCLA#openjs-foundation-cla
 [2]: https://webpack.js.org/contribute/writers-guide/
 [3]: https://webpack.js.org/contribute/#pull-requests

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,9 @@
+version: 2
+updates:
+  - package-ecosystem: "npm"
+    directory: "/"
+    open-pull-requests-limit: 10
+    schedule:
+      interval: "daily"
+    labels:
+      - "dependencies"