diff --git a/.eslintrc.js b/.eslintrc.js index b584e0b742f..0c8e2e4f974 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -1,31 +1,29 @@ module.exports = { - "root": true, - "plugins": ["node"], - "extends": ["eslint:recommended", "plugin:node/recommended"], - "env": { - "node": true, - "es6": true, - "jest": true + extends: ["eslint:recommended"], + env: { + node: true, + es6: true, + jest: true }, - "parserOptions": { "ecmaVersion": 2017, "sourceType": "module"}, - "rules": { + parserOptions: { ecmaVersion: 2017, sourceType: "module" }, + rules: { "no-useless-escape": "off", "quote-props": ["error", "as-needed"], "no-dupe-keys": "error", - "quotes": ["error", "double"], + quotes: ["error", "double"], "no-undef": "error", "no-extra-semi": "error", - "semi": "error", + semi: "error", "no-template-curly-in-string": "error", "no-caller": "error", - "yoda": "error", - "eqeqeq": "error", + yoda: "error", + eqeqeq: "error", "global-require": "off", "brace-style": "error", "key-spacing": "error", "space-in-parens": ["error", "never"], "space-infix-ops": "error", - "indent": ["error", "tab", { "SwitchCase": 1 }], + indent: ["error", "tab", { SwitchCase: 1 }], "no-extra-bind": "warn", "no-empty": "off", "no-multiple-empty-lines": "error", @@ -33,78 +31,31 @@ module.exports = { "no-process-exit": "off", "no-trailing-spaces": "error", "no-use-before-define": "off", - "no-unused-vars": ["error", { "args": "none" }], + "no-unused-vars": ["error", { args: "none" }], "no-unsafe-negation": "error", "no-loop-func": "warn", "space-before-function-paren": ["error", "never"], "space-before-blocks": "error", "object-curly-spacing": ["error", "always"], - "object-curly-newline": ["error", { "consistent": true }], - "keyword-spacing": ["error", { - "after": true, - "overrides": { - "const": { "after": true }, - "try": { "after": true }, - "throw": { "after": true }, - "case": { "after": true }, - "return": { "after": true }, - "finally": { "after": true }, - "do": { "after": true } - } - }], - "no-console": "off", - "valid-jsdoc": "error", - "node/no-unsupported-features": ["error", { "version": 6 }], - "node/no-deprecated-api": "error", - "node/no-missing-import": "error", - "node/no-missing-require": [ - "error", - { - "resolvePaths": ["./packages"], - "allowModules": [ - "webpack", - "@webpack-cli/generators", - "@webpack-cli/init", - "@webpack-cli/migrate", - "@webpack-cli/utils", - "@webpack-cli/generate-loader", - "@webpack-cli/generate-plugin", - "@webpack-cli/webpack-scaffold" - ] - } - ], - "node/no-unpublished-bin": "error", - "node/no-unpublished-require": [ + "object-curly-newline": ["error", { consistent: true }], + "keyword-spacing": [ "error", { - "allowModules": [ - "webpack", - "webpack-dev-server", - "@webpack-cli/generators", - "@webpack-cli/init", - "@webpack-cli/migrate", - "@webpack-cli/utils", - "@webpack-cli/generate-loader", - "@webpack-cli/generate-plugin", - "@webpack-cli/webpack-scaffold" - ] - } - ], - "node/no-extraneous-require": [ - "error", - { - "allowModules": [ - "@webpack-cli/migrate", - "@webpack-cli/generators", - "@webpack-cli/utils", - "@webpack-cli/generate-loader", - "@webpack-cli/generate-plugin", - "@webpack-cli/webpack-scaffold" - ] + after: true, + overrides: { + const: { after: true }, + try: { after: true }, + throw: { after: true }, + case: { after: true }, + return: { after: true }, + finally: { after: true }, + do: { after: true } + } } ], + "no-console": "off", + "valid-jsdoc": "error", "eol-last": ["error", "always"], - "newline-per-chained-call": "off", - "node/process-exit-as-throw": "error" + "newline-per-chained-call": "off" } }; diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 4ed7f17ccba..704d573270a 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -5,6 +5,34 @@ appreciated and welcomed. If you're planning a new feature or changing the API, please create an issue first. This way we can ensure that your precious work is not in vain. +Table of Contents + +- [Issues](#issues) +- [Your first Contribution](#your-first-contribution) +- [Setup](#setup) + - [Using npm](#using-npm) + - [Using yarn](#using-yarn) +- [Running Tests](#running-tests) + - [Using npm](#using-npm-1) + - [Using yarn](#using-yarn-1) +- [Editor Config](#editor-config) +- [Dependencies](#dependencies) +- [Branching Model](#branching-model) +- [Naming a branch](#naming-a-branch) + - [Features](#features) + - [Fixes](#fixes) +- [Testing](#testing) +- [Pull Requests](#pull-requests) +- [Submitting a good Pull Request](#submitting-a-good-pull-request) +- [Commit message](#commit-message) + - [Commit Message Format](#commit-message-format) +- [Migrate with the CLI](#migrate-with-the-cli) + - [How it's being done](#how-its-being-done) + - [Structure of a transform](#structure-of-a-transform) + - [Further Work](#further-work) +- [Contributor License Agreement](#contributor-license-agreement) +- [Documentation](#documentation) + ## Issues Most of the time, when webpack does not work correctly, it might be a configuration issue. @@ -19,7 +47,7 @@ that include your `webpack.config.js` and relevant files. This way you help othe First of all, you will need to create an issue in Github for the feature or bugfix that you want to work on. When you open a new issue, there will be a template that will be automatically added to the text of the issue, which you would need to fill in. Doing this will help us to understand better what the ticket is about. -After you've created the issue, we will have a look, and provide feedback to your ticket. +After you've created the issue, we will have a look, and provide feedback to your ticket. In case it is a bug that you want to fix, we might help you with background information about the issue, so you can make an informed fix. @@ -27,14 +55,14 @@ In case you are suggesting a new feature, we will match your idea with our curre ## Setup -* Install [Node.js](https://nodejs.org/) if you don't have it already. - *Note: Node 6 or greater would be better for "best results".* -* Fork the **webpack-cli** repo at [https://github.com/webpack/webpack-cli](https://github.com/webpack/webpack-cli). -* `git clone && cd webpack-cli` +- Install [Node.js](https://nodejs.org/) if you don't have it already. + _Note: Node 6 or greater would be better for "best results"._ +- Fork the **webpack-cli** repo at [https://github.com/webpack/webpack-cli](https://github.com/webpack/webpack-cli). +- `git clone && cd webpack-cli` ### Using npm -* Install the dependencies and link them: +- Install the dependencies and link them: ```bash npm install @@ -42,7 +70,7 @@ In case you are suggesting a new feature, we will match your idea with our curre npm link webpack-cli ``` -* Bootstrap all the submodules before building for the first time +- Bootstrap all the submodules before building for the first time ```bash npm run bootstrap @@ -51,13 +79,13 @@ In case you are suggesting a new feature, we will match your idea with our curre ### Using yarn -* If you don't have yarn yet: - +- If you don't have yarn yet: + ```bash npm install -g yarn ``` - -* Install the dependencies and link them + +- Install the dependencies and link them ```bash yarn @@ -65,74 +93,103 @@ In case you are suggesting a new feature, we will match your idea with our curre yarn link webpack-cli ``` -* Bootstrap all the submodules before building for the first time +- Bootstrap all the submodules before building for the first time ```bash yarn bootstrap yarn build ``` - -## Testing +## Running Tests ### Using npm -* Run all the tests with: - +- Run all the tests with: + ```bash npm run test ``` -* Test a single CLI test case: - +- Run CLI tests with: + ```bash - npx jest path/to/my-test.js + npm run test:cli ``` -* You can also install jest globally and run tests without npx: +- Run tests of all packages: + + ```bash + npm run test:packages + ``` + +- Test a single CLI test case: + + ```bash + npx jest path/to/my-test.js + ``` + +- You can also install jest globally and run tests without npx: ```bash npm i -g jest jest path/to/my-test.js ``` -* You can run the linters: +- You can run the linters: ```bash - npm run lint && npm run tslint + npm run lint ``` ### Using yarn -* Run all the tests with: - +- Run all the tests with: + ```bash yarn test ``` -* Test a single CLI test case: - +- Run CLI tests with: + + ```bash + yarn test:cli` + ``` + +- Run tests of all packages: + + ```bash + yarn test:packages + ``` + +- Test a single CLI test case: + ```bash yarn jest path/to/my-test.js ``` - -* You can also install jest globally and run tests: + +- You can also install jest globally and run tests: ```bash yarn global add jest jest path/to/my-test.js ``` -* You can run the linters: +- You can run the linters: ```bash - yarn lint && yarn tslint + yarn lint ``` ## Editor Config The [.editorconfig](https://github.com/webpack/webpack-cli/blob/master/.editorconfig) in the root should ensure consistent formatting. Please make sure you've [installed the plugin](http://editorconfig.org/#download) if your text editor needs one. +## Dependencies + +This is a multi-package repository and dependencies are managed using [lerna](https://lerna.js.org/) + +> If you are adding or updating any dependency, please commit the updated `package-lock.json` file. + ## Branching Model We base our branching model on [git flow](http://nvie.com/posts/a-successful-git-branching-model/). Instead of working with a `develop` base branch, we use the `master` branch. We do it to ease the workflow a bit. However, we find that adding prefixes to the branches is useful. @@ -141,15 +198,15 @@ We base our branching model on [git flow](http://nvie.com/posts/a-successful-git Making a branch in your fork for your contribution is helpful in the following ways: -* It allows you to submit more than one contribution in a single PR. -* It allows us to identify what your contribution is about from the branch name. +- It allows you to submit more than one contribution in a single PR. +- It allows us to identify what your contribution is about from the branch name. You will want to checkout the `master` branch locally before creating your new branch. There are two types of branches: -* Feature -* Bugfix +- Feature +- Bugfix ### Features @@ -165,7 +222,7 @@ If you are fixing an existing bug, you can create a branch with the following pr ## Testing -Every bugfix or feature that you submit, needs to be tested. Writing tests for code is very important to prevent future bugs, and help to discover possible new bugs promptly. +Every bugfix or feature that you submit, needs to be tested. Writing tests for the code is very important to prevent future bugs, and help to discover possible new bugs promptly. It is important that you test the logic of the code you're writing, and that your tests really go through all your lines, branches and statements. This is the only way to ensure that the code coverage is high enough to ensure the users of the cli, that they are using a solid tool. @@ -180,11 +237,11 @@ In case you've got a small change in most of the cases, your pull request would ## Submitting a good Pull Request -* Write tests -* Follow the existing coding style -* Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) +- Write tests +- Follow the existing coding style +- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) -## Commit message format +## Commit message Our commit messages format follows the [angular.js commits format](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#commit-message-format). @@ -193,27 +250,30 @@ You can use `npm run commit` script to have an interactive way of making commits We don't use the scope. The template of a commit would look like this: ### Commit Message Format -Each commit message consists of a **header**, a **body** and a **footer**. The header has a special + +Each commit message consists of a **header**, a **body** and a **footer**. The header has a special format that includes a **type** and a **subject**: -``` +```md : +