From 9f05b7784331a472922e732ed2aeb9dc3116db94 Mon Sep 17 00:00:00 2001 From: Aru Hyunseung Jeon Date: Tue, 23 Apr 2024 13:22:52 +0900 Subject: [PATCH] chore(docs): correct case and match installation guide (#16) --- README.md | 10 +++--- packages/eslint-config/README.md | 8 ++--- packages/eslint-config/package.json | 2 +- packages/eslint-plugin/README.md | 45 ++++++++++++++++--------- packages/eslint-plugin/package.json | 2 +- packages/prettier-config/README.md | 12 +++++-- packages/prettier-config/package.json | 2 +- packages/stylelint-config/README.md | 33 +++++++++++++----- packages/stylelint-config/package.json | 2 +- packages/typescript-config/README.md | 14 ++++++-- packages/typescript-config/package.json | 2 +- 11 files changed, 90 insertions(+), 42 deletions(-) diff --git a/README.md b/README.md index 4e4445c..2af5443 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,8 @@ | Name | Description | | ----------------------------------------------- | -------------------- | -| [eslint-config](packages/eslint-config) | custom eslint config | -| [eslint-plugin](packages/eslint-plugin) | eslint plugin | -| [prettier-config](packages/prettier-config) | prettier config | -| [stylelint-config](packages/stylelint-config) | stylelint config | -| [typescript-config](packages/typescript-config) | typescript config | +| [eslint-config](packages/eslint-config) | ESLint config | +| [eslint-plugin](packages/eslint-plugin) | ESLint plugin | +| [prettier-config](packages/prettier-config) | Prettier config | +| [stylelint-config](packages/stylelint-config) | Stylelint config | +| [typescript-config](packages/typescript-config) | TypeScript config | diff --git a/packages/eslint-config/README.md b/packages/eslint-config/README.md index 861b0dc..29654a7 100644 --- a/packages/eslint-config/README.md +++ b/packages/eslint-config/README.md @@ -1,18 +1,18 @@ -# eslint-config +# `@channel.io/eslint-config` -An eslint configuration for channel web projects. +ESLint configuration for Channel.io web projects ## Installation ### npm -``` +```sh $ npm install --dev @channel.io/eslint-config ``` ### Yarn -``` +```sh $ yarn add --dev @channel.io/eslint-config ``` diff --git a/packages/eslint-config/package.json b/packages/eslint-config/package.json index 8d67b18..a41ac60 100644 --- a/packages/eslint-config/package.json +++ b/packages/eslint-config/package.json @@ -1,7 +1,7 @@ { "name": "@channel.io/eslint-config", "version": "2.0.6", - "description": "eslint configuration for channel.io web", + "description": "ESLint configuration for Channel.io web projects", "main": "default.js", "scripts": { "test": "echo \"Error: no test specified\" && exit 1", diff --git a/packages/eslint-plugin/README.md b/packages/eslint-plugin/README.md index 4308de0..da534ad 100644 --- a/packages/eslint-plugin/README.md +++ b/packages/eslint-plugin/README.md @@ -1,20 +1,35 @@ -# eslint-plugin +# `@channel.io/eslint-plugin` + +ESLint plugins for Channel.io web projects ## Installation -1. `$ npm install --dev @channel.io/eslint-plugin` - -2. Edit `.eslintrc.js` - - ```js - module.exports = { - // ... - plugins: ['@channel.io'], - rules: { - '@channel.io/no-classnames-with-one-argument': 'error', - '@channel.io/hooks-deps-element-newline': 'warn' - } - } - ``` + +### npm + +```sh +$ npm install --dev @channel.io/eslint-plugin +``` + +### Yarn + +```sh +$ yarn add --dev @channel.io/eslint-plugin +``` + +## Usage + +Edit `.eslintrc.js` + +```js +module.exports = { + // ... + plugins: ['@channel.io'], + rules: { + '@channel.io/no-classnames-with-one-argument': 'error', + '@channel.io/hooks-deps-element-newline': 'warn' + } +} +``` ## Docs > Documents are written by Korean only. diff --git a/packages/eslint-plugin/package.json b/packages/eslint-plugin/package.json index fd73c57..de0a6f0 100644 --- a/packages/eslint-plugin/package.json +++ b/packages/eslint-plugin/package.json @@ -1,7 +1,7 @@ { "name": "@channel.io/eslint-plugin", "version": "1.2.3", - "description": "eslint plugin for channel.io web", + "description": "ESLint plugins for Channel.io web projects", "author": "Channel Corp.", "main": "index.js", "scripts": { diff --git a/packages/prettier-config/README.md b/packages/prettier-config/README.md index f0be407..297243d 100644 --- a/packages/prettier-config/README.md +++ b/packages/prettier-config/README.md @@ -1,10 +1,18 @@ # `@channel-io/prettier-config` -Shared prettier configuration +Shared Prettier configuration ## Installation -```bash +### npm + +```sh +$ npm install --dev @channel.io/prettier-config +``` + +### Yarn + +```sh $ yarn add --dev @channel.io/prettier-config ``` diff --git a/packages/prettier-config/package.json b/packages/prettier-config/package.json index d79aeef..52aa9c7 100644 --- a/packages/prettier-config/package.json +++ b/packages/prettier-config/package.json @@ -2,7 +2,7 @@ "name": "@channel.io/prettier-config", "version": "0.0.1", "license": "MIT", - "description": "Shared prettier configuration", + "description": "Shared Prettier configuration", "main": "index.json", "sideEffects": false, "author": "Channel Corp.", diff --git a/packages/stylelint-config/README.md b/packages/stylelint-config/README.md index d5e13d9..235361b 100644 --- a/packages/stylelint-config/README.md +++ b/packages/stylelint-config/README.md @@ -1,24 +1,41 @@ -# stylelint-config +# `@channel.io/stylelint-config` -An Configuration for stylelint by Channel. +Configuration for Stylelint by Channel.io ## Installation -`$ npm install --dev @channel.io/stylelint-config` + +### npm + +```sh +$ npm install --dev @channel.io/stylelint-config +``` + +### Yarn + +```sh +$ yarn add --dev @channel.io/stylelint-config +``` ## Install Packages + Get peer dependency lists and install them. -`$ npm info @channel.io/stylelint-config peerDependencies ` +```sh +$ npm info @channel.io/stylelint-config peerDependencies +``` Or install with `install-peerdeps`. -`$ npx install-peerdeps --dev @channel.io/stylelint-config` +```sh +$ npx install-peerdeps --dev @channel.io/stylelint-config +``` + +## Configure + +Create `.stylelintrc` file and extend this library. -### Configure -create `.stylelintrc` file and extend this library. ```js { "extends": ["@channel-io/stylelint-config"], } - ``` diff --git a/packages/stylelint-config/package.json b/packages/stylelint-config/package.json index 11e4982..dd11d5f 100644 --- a/packages/stylelint-config/package.json +++ b/packages/stylelint-config/package.json @@ -1,7 +1,7 @@ { "name": "@channel.io/stylelint-config", "version": "1.2.0", - "description": "Configuration for stylelint by Channel", + "description": "Configuration for Stylelint by Channel.io", "main": "index.js", "files": [ "index.js" diff --git a/packages/typescript-config/README.md b/packages/typescript-config/README.md index 11fcea2..a017885 100644 --- a/packages/typescript-config/README.md +++ b/packages/typescript-config/README.md @@ -1,10 +1,18 @@ -# typescript-config +# `@channel.io/typescript-config` -Base typescript configuration for Channel.io +Base TypeScript configuration for Channel.io ## Installation -```bash +### npm + +```sh +$ npm install --dev @channel.io/typescript-config +``` + +### Yarn + +```sh $ yarn add --dev @channel.io/typescript-config ``` diff --git a/packages/typescript-config/package.json b/packages/typescript-config/package.json index b337764..4dbeae5 100644 --- a/packages/typescript-config/package.json +++ b/packages/typescript-config/package.json @@ -1,7 +1,7 @@ { "name": "@channel.io/typescript-config", "version": "0.0.1", - "description": "Typescript configuration for Channel.io", + "description": "Base TypeScript configuration for Channel.io", "author": "Channel Corp.", "bugs": { "url": "https://github.com/channel-io/shared-configs/issues"