From 3dbe4b20381c3ecc8ada39a6b9cfc902179808ce Mon Sep 17 00:00:00 2001 From: fisker Cheung Date: Fri, 18 Oct 2019 16:36:24 +0800 Subject: [PATCH] Docs: add link to `devDependencies` (#6682) --- docs/integrating-with-linters.md | 14 ++++++++------ docs/precommit.md | 2 +- .../version-stable/integrating-with-linters.md | 16 +++++++++------- .../versioned_docs/version-stable/precommit.md | 2 +- 4 files changed, 19 insertions(+), 15 deletions(-) diff --git a/docs/integrating-with-linters.md b/docs/integrating-with-linters.md index c2a92330a..57fa98f72 100644 --- a/docs/integrating-with-linters.md +++ b/docs/integrating-with-linters.md @@ -9,13 +9,13 @@ This allows you to use Prettier for code formatting concerns, while letting your Whatever linting tool you wish to integrate with, the steps are broadly similar. First disable any existing formatting rules in your linter that may conflict with how Prettier wishes to format your code. Then you can either add an extension to your linting tool to format your file with Prettier - so that you only need a single command for format a file, or run your linter then Prettier as separate steps. -All these instructions assume you have already installed `prettier` in your `devDependencies`. +All these instructions assume you have already installed `prettier` in your [`devDependencies`]. ## ESLint ### Disable formatting rules -[`eslint-config-prettier`](https://github.com/prettier/eslint-config-prettier) is a config that disables rules that conflict with Prettier. Add it to your `devDependencies`, then extend from it within your `.eslintrc` configuration. Make sure to put it last in the `extends` array, so it gets the chance to override other configs. +[`eslint-config-prettier`](https://github.com/prettier/eslint-config-prettier) is a config that disables rules that conflict with Prettier. Add it to your [`devDependencies`], then extend from it within your `.eslintrc` configuration. Make sure to put it last in the `extends` array, so it gets the chance to override other configs. ```bash yarn add --dev eslint-config-prettier @@ -31,7 +31,7 @@ Then in `.eslintrc.json`: ### Use ESLint to run Prettier -[`eslint-plugin-prettier`](https://github.com/prettier/eslint-plugin-prettier) is a plugin that adds a rule that formats content using Prettier. Add it to your `devDependencies`, then enable the plugin and rule. +[`eslint-plugin-prettier`](https://github.com/prettier/eslint-plugin-prettier) is a plugin that adds a rule that formats content using Prettier. Add it to your [`devDependencies`], then enable the plugin and rule. ```bash yarn add --dev eslint-plugin-prettier @@ -68,7 +68,7 @@ Then in `.eslintrc.json`: ### Disable formatting rules -[`tslint-config-prettier`](https://github.com/alexjoverm/tslint-config-prettier) is a config that disables rules that conflict with Prettier. Add it to your `devDependencies`, then extend from it within your `tslint.json` configuration. Make sure to put it last in the `extends` array, so it gets the chance to override other configs. +[`tslint-config-prettier`](https://github.com/alexjoverm/tslint-config-prettier) is a config that disables rules that conflict with Prettier. Add it to your [`devDependencies`], then extend from it within your `tslint.json` configuration. Make sure to put it last in the `extends` array, so it gets the chance to override other configs. ```bash yarn add --dev tslint-config-prettier @@ -84,7 +84,7 @@ Then in `tslint.json`: ### Use TSLint to run Prettier -[`tslint-plugin-prettier`](https://github.com/ikatyang/tslint-plugin-prettier) is a plugin that adds a rule that formats content using Prettier. Add it to your `devDependencies`, then enable the plugin and rule. +[`tslint-plugin-prettier`](https://github.com/ikatyang/tslint-plugin-prettier) is a plugin that adds a rule that formats content using Prettier. Add it to your [`devDependencies`], then enable the plugin and rule. ```bash yarn add --dev tslint-plugin-prettier @@ -140,7 +140,7 @@ Then in `.stylelintrc`: ### Use Stylelint to run Prettier -[`stylelint-prettier`](https://github.com/prettier/stylelint-prettier) is a plugin that adds a rule that formats content using Prettier. Add it to your `devDependencies`, then enable the plugin and rule. +[`stylelint-prettier`](https://github.com/prettier/stylelint-prettier) is a plugin that adds a rule that formats content using Prettier. Add it to your [`devDependencies`], then enable the plugin and rule. ```bash yarn add --dev stylelint-prettier @@ -172,3 +172,5 @@ Then in `.stylelintrc`: "extends": ["stylelint-prettier/recommended"] } ``` + +[`devdependencies`]: https://docs.npmjs.com/specifying-dependencies-and-devdependencies-in-a-package-json-file diff --git a/docs/precommit.md b/docs/precommit.md index a5b817213..ac4e83e91 100644 --- a/docs/precommit.md +++ b/docs/precommit.md @@ -9,7 +9,7 @@ You can use Prettier with a pre-commit tool. This can re-format your files that **Use Case:** Useful for when you want to use other code quality tools along with Prettier (e.g. ESLint, Stylelint, etc.) or if you need support for partially staged files (`git add --patch`). -_Make sure Prettier is installed and is in your `devDependencies` before you proceed._ +_Make sure Prettier is installed and is in your [`devDependencies`](https://docs.npmjs.com/specifying-dependencies-and-devdependencies-in-a-package-json-file) before you proceed._ ```bash npx mrm lint-staged diff --git a/website/versioned_docs/version-stable/integrating-with-linters.md b/website/versioned_docs/version-stable/integrating-with-linters.md index 70bff501e..a6b762f5b 100644 --- a/website/versioned_docs/version-stable/integrating-with-linters.md +++ b/website/versioned_docs/version-stable/integrating-with-linters.md @@ -10,13 +10,13 @@ This allows you to use Prettier for code formatting concerns, while letting your Whatever linting tool you wish to integrate with, the steps are broadly similar. First disable any existing formatting rules in your linter that may conflict with how Prettier wishes to format your code. Then you can either add an extension to your linting tool to format your file with Prettier - so that you only need a single command for format a file, or run your linter then Prettier as separate steps. -All these instructions assume you have already installed `prettier` in your `devDependencies`. +All these instructions assume you have already installed `prettier` in your [`devDependencies`]. ## ESLint ### Disable formatting rules -[`eslint-config-prettier`](https://github.com/prettier/eslint-config-prettier) is a config that disables rules that conflict with Prettier. Add it to your `devDependencies`, then extend from it within your `.eslintrc` configuration. Make sure to put it last in the `extends` array, so it gets the chance to override other configs. +[`eslint-config-prettier`](https://github.com/prettier/eslint-config-prettier) is a config that disables rules that conflict with Prettier. Add it to your [`devDependencies`], then extend from it within your `.eslintrc` configuration. Make sure to put it last in the `extends` array, so it gets the chance to override other configs. ```bash yarn add --dev eslint-config-prettier @@ -32,7 +32,7 @@ Then in `.eslintrc.json`: ### Use ESLint to run Prettier -[`eslint-plugin-prettier`](https://github.com/prettier/eslint-plugin-prettier) is a plugin that adds a rule that formats content using Prettier. Add it to your `devDependencies`, then enable the plugin and rule. +[`eslint-plugin-prettier`](https://github.com/prettier/eslint-plugin-prettier) is a plugin that adds a rule that formats content using Prettier. Add it to your [`devDependencies`], then enable the plugin and rule. ```bash yarn add --dev eslint-plugin-prettier @@ -69,7 +69,7 @@ Then in `.eslintrc.json`: ### Disable formatting rules -[`tslint-config-prettier`](https://github.com/alexjoverm/tslint-config-prettier) is a config that disables rules that conflict with Prettier. Add it to your `devDependencies`, then extend from it within your `tslint.json` configuration. Make sure to put it last in the `extends` array, so it gets the chance to override other configs. +[`tslint-config-prettier`](https://github.com/alexjoverm/tslint-config-prettier) is a config that disables rules that conflict with Prettier. Add it to your [`devDependencies`], then extend from it within your `tslint.json` configuration. Make sure to put it last in the `extends` array, so it gets the chance to override other configs. ```bash yarn add --dev tslint-config-prettier @@ -85,7 +85,7 @@ Then in `tslint.json`: ### Use TSLint to run Prettier -[`tslint-plugin-prettier`](https://github.com/ikatyang/tslint-plugin-prettier) is a plugin that adds a rule that formats content using Prettier. Add it to your `devDependencies`, then enable the plugin and rule. +[`tslint-plugin-prettier`](https://github.com/ikatyang/tslint-plugin-prettier) is a plugin that adds a rule that formats content using Prettier. Add it to your [`devDependencies`], then enable the plugin and rule. ```bash yarn add --dev tslint-plugin-prettier @@ -125,7 +125,7 @@ Then in `tslint.json`: ### Disable formatting rules -[`stylelint-config-prettier`](https://github.com/prettier/stylelint-config-prettier) is a config that disables rules that conflict with Prettier. Add it to your `devDependencies`, then extend from it within your `.stylelintrc` configuration. Make sure to put it last in the `extends` array, so it gets the chance to override other configs. +[`stylelint-config-prettier`](https://github.com/prettier/stylelint-config-prettier) is a config that disables rules that conflict with Prettier. Add it to your [`devDependencies`], then extend from it within your `.stylelintrc` configuration. Make sure to put it last in the `extends` array, so it gets the chance to override other configs. ```bash yarn add --dev stylelint-config-prettier @@ -141,7 +141,7 @@ Then in `.stylelintrc`: ### Use Stylelint to run Prettier -[`stylelint-prettier`](https://github.com/prettier/stylelint-prettier) is a plugin that adds a rule that formats content using Prettier. Add it to your `devDependencies`, then enable the plugin and rule. +[`stylelint-prettier`](https://github.com/prettier/stylelint-prettier) is a plugin that adds a rule that formats content using Prettier. Add it to your [`devDependencies`], then enable the plugin and rule. ```bash yarn add --dev stylelint-prettier @@ -173,3 +173,5 @@ Then in `.stylelintrc`: "extends": ["stylelint-prettier/recommended"] } ``` + +[`devdependencies`]: https://docs.npmjs.com/specifying-dependencies-and-devdependencies-in-a-package-json-file diff --git a/website/versioned_docs/version-stable/precommit.md b/website/versioned_docs/version-stable/precommit.md index 382992149..9024b7744 100644 --- a/website/versioned_docs/version-stable/precommit.md +++ b/website/versioned_docs/version-stable/precommit.md @@ -10,7 +10,7 @@ You can use Prettier with a pre-commit tool. This can re-format your files that **Use Case:** Useful for when you want to use other code quality tools along with Prettier (e.g. ESLint, Stylelint, etc.) or if you need support for partially staged files (`git add --patch`). -_Make sure Prettier is installed and is in your `devDependencies` before you proceed._ +_Make sure Prettier is installed and is in your [`devDependencies`](https://docs.npmjs.com/specifying-dependencies-and-devdependencies-in-a-package-json-file) before you proceed._ ```bash npx mrm lint-staged