diff --git a/README.md b/README.md index 83fe2a7..5abc38b 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ This monorepo contains shareable configurations for various coding-style/best pr | Commitlint | [@lmc-eu/commitlint-config](packages/commitlint-config) | [![@lmc-eu/commitlint-config][clc-badge]][clc-npm] | | Conventional Changelog | [@lmc-eu/conventional-changelog-lmc-bitbucket](packages/conventional-changelog-lmc-bitbucket) | [![@lmc-eu/conventional-changelog-lmc-bitbucket][cc-bb-badge]][cc-bb-npm] | | Conventional Changelog | [@lmc-eu/conventional-changelog-lmc-github](packages/conventional-changelog-lmc-github) | [![@lmc-eu/conventional-changelog-lmc-github][cc-gh-badge]][cc-gh-npm] | -| ESLint | [@lmc-eu/eslint-config-base](packages/eslint-config-base) | [![@lmc-eu/eslint-config-base][ec-base-badge]][ec-base-npm] | +| ESLint | [@lmc-eu/eslint-config-base](packages/eslint-config-base) | [![@lmc-eu/eslint-config-base][ec-base-badge]][ec-base-npm] | | ESLint | [@lmc-eu/eslint-config-graphql](packages/eslint-config-graphql) | [![@lmc-eu/eslint-config-graphql][ec-gql-badge]][ec-gql-npm] | | ESLint | [@lmc-eu/eslint-config-react](packages/eslint-config-react) | [![@lmc-eu/eslint-config-react][ec-react-badge]][ec-react-npm] | | ESLint | [@lmc-eu/eslint-config-jest](packages/eslint-config-jest) | [![@lmc-eu/eslint-config-jest][ec-jest-badge]][ec-jest-npm] | diff --git a/packages/browserslist-config/README.md b/packages/browserslist-config/README.md index bca6a58..92c07af 100644 --- a/packages/browserslist-config/README.md +++ b/packages/browserslist-config/README.md @@ -16,7 +16,7 @@ npm install --save-dev @lmc-eu/browserslist-config Add this to `.browserslistrc` file: -``` +```txt extends @lmc-eu/browserslist-config ``` @@ -32,7 +32,7 @@ Alternatively, add this to your `package.json` file: To support Internet Explorer (or any other browser): -``` +```txt extends @lmc-eu/browserslist-config ie # sorry! @@ -46,13 +46,14 @@ To get the data from Google Analytics, use one of the following tools: - [browserslist-ga-export](https://github.com/browserslist/browserslist-ga-export) — create a custom report in GA and export it to CSV, + - [browserslist-ga](https://github.com/browserslist/browserslist-ga) — easier if you are OK with providing your Google password to a third-party tool. Make the resulting file available to Browserslist by saving it right next to your `.browserslistrc` (or `package.json`, wherever you store your config): -``` +```txt # Project root - .browserslistrc @@ -63,7 +64,7 @@ your `.browserslistrc` (or `package.json`, wherever you store your config): As mentioned in the stats file in your Browserslist configuration: -``` +```txt extends @lmc-eu/browserslist-config > 0.5% in my stats diff --git a/packages/conventional-changelog-lmc-bitbucket/README.md b/packages/conventional-changelog-lmc-bitbucket/README.md index ec271f5..b499d6b 100644 --- a/packages/conventional-changelog-lmc-bitbucket/README.md +++ b/packages/conventional-changelog-lmc-bitbucket/README.md @@ -8,13 +8,13 @@ NPM: -``` +```sh npm i --dev @commitlint/cli @commitlint/config-conventional @lmc-eu/conventional-changelog-lmc-bitbucket ``` Yarn: -``` +```sh yarn add --dev @commitlint/cli @commitlint/config-conventional @lmc-eu/conventional-changelog-lmc-bitbucket ``` diff --git a/packages/conventional-changelog-lmc-github/README.md b/packages/conventional-changelog-lmc-github/README.md index 6a19305..50ab2d1 100644 --- a/packages/conventional-changelog-lmc-github/README.md +++ b/packages/conventional-changelog-lmc-github/README.md @@ -8,13 +8,13 @@ NPM: -``` +```sh npm i --dev @commitlint/cli @commitlint/config-conventional @lmc-eu/conventional-changelog-lmc-github ``` Yarn: -``` +```sh yarn add --dev @commitlint/cli @commitlint/config-conventional @lmc-eu/conventional-changelog-lmc-github ``` diff --git a/packages/conventional-changelog-lmc/README.md b/packages/conventional-changelog-lmc/README.md index 9668be4..cc3f390 100644 --- a/packages/conventional-changelog-lmc/README.md +++ b/packages/conventional-changelog-lmc/README.md @@ -6,13 +6,13 @@ NPM: -``` +```sh npm i --dev @lmc-eu/conventional-changelog-lmc ``` Yarn: -``` +```sh yarn add --dev @lmc-eu/conventional-changelog-lmc ``` diff --git a/packages/eslint-config-base/README.md b/packages/eslint-config-base/README.md index abb36f3..ad39670 100644 --- a/packages/eslint-config-base/README.md +++ b/packages/eslint-config-base/README.md @@ -10,21 +10,21 @@ These rules are meant to be shared across all ESLint rulesets. ## Configurations -### `@lmc-eu/eslint-config-base` +- **`@lmc-eu/eslint-config-base`** Use this ruleset to configure ESLint to work with every JavaScript code. -### `@lmc-eu/eslint-config-base/optional` +- **`@lmc-eu/eslint-config-base/optional`** Use this ruleset together with the above ruleset. Provides additional insights into potential inconsistencies in the project. > For new projects, it is recommended to enable this ruleset. For existing projects, it is only recommended for the brave. -### `@lmc-eu/eslint-config-base/legacy` +- **`@lmc-eu/eslint-config-base/legacy`** Lints ES5 and below. -### `@lmc-eu/eslint-config-base/whitespace` +- **`@lmc-eu/eslint-config-base/whitespace`** This entry point only errors on whitespace rules and sets all other rules to warnings. View [the list of whitespace rules](https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/whitespace.js). diff --git a/packages/eslint-config-react/README.md b/packages/eslint-config-react/README.md index 9fb5e7b..f76e9a4 100644 --- a/packages/eslint-config-react/README.md +++ b/packages/eslint-config-react/README.md @@ -6,19 +6,19 @@ Wee need to install everything needed by the config using (installs package and also peer dependencies): -``` +```sh npx install-peerdeps --dev @lmc-eu/eslint-config-react ``` -You can see in your package.json there are now a big list of devDependencies. +You can see in your package.json there is now a big list of devDependencies. ## Configurations -### `@lmc-eu/eslint-config-react` +- **`@lmc-eu/eslint-config-react`** Use this ruleset to configure ESLint to work with React code. -### `@lmc-eu/eslint-config-react/optional` +- **`@lmc-eu/eslint-config-react/optional`** Use this ruleset together with the above ruleset. Provides additional insights into potential inconsistencies in the project. diff --git a/packages/eslint-config-typescript/README.md b/packages/eslint-config-typescript/README.md index b9f6d1f..9c14d71 100644 --- a/packages/eslint-config-typescript/README.md +++ b/packages/eslint-config-typescript/README.md @@ -14,7 +14,7 @@ See the example _.eslintrc.js_ file below for more details and make sure you rea ## Configurations -### `@lmc-eu/eslint-config-typescript` +- **`@lmc-eu/eslint-config-typescript`** Suitable for linting TypeScript source files. @@ -65,7 +65,7 @@ module.exports = { A full configuration for a TypeScript on React project: -> Please note, that you need to have [eslint-config-react] installed as well +> Please note, that you need to have [eslint-config-react][eslint-config-react] installed as well ```js // .eslintrc.js diff --git a/packages/prettier-config/README.md b/packages/prettier-config/README.md index 49ea18c..405bece 100644 --- a/packages/prettier-config/README.md +++ b/packages/prettier-config/README.md @@ -59,7 +59,7 @@ module.exports = { ### Prettier Version -Versions of `prettier` before v1.17 did not feature the possibility to use a shared config via _package.json_. The way to do it is similar to when [extending](#Extending), except that you can just export the config directly: +Versions of `prettier` before v1.17 did not feature the possibility of using a shared config via _package.json_. The way to do it is similar to when [extending](#Extending), except that you can just export the config directly: ```js // .prettierrc.js diff --git a/packages/stylelint-config/README.md b/packages/stylelint-config/README.md index 5811ac9..04cbcc5 100644 --- a/packages/stylelint-config/README.md +++ b/packages/stylelint-config/README.md @@ -29,7 +29,7 @@ This config: ## Configuration -### `@lmc-eu/stylelint-config` +- **`@lmc-eu/stylelint-config`** Use this ruleset to configure Stylelint to work with your code.