docs(sh): update plugin description (#185)

un-ts · Jun 26, 2022 · a6c699e · a6c699e
1 parent 5c8abfc
commit a6c699e
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 7 deletions.
diff --git a/.changeset/good-wasps-jump.md b/.changeset/good-wasps-jump.md
@@ -0,0 +1,5 @@
+---
+"prettier-plugin-sh": patch
+---
+
+docs(sh): update plugin description
diff --git a/README.md b/README.md
@@ -19,11 +19,11 @@
 
 This repository is a monorepo managed by [changesets][] what means we actually publish several packages to npm from same codebase, including:
 
-| Package                                | Description                                                                                                                 | Version                                                                                                           | Peer Dependencies                                                                                                                                                   | Dependencies                                                                                                                         |
-| -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
-| [`prettier-plugin-pkg`](/packages/pkg) | An opinionated package.json formatter plugin for Prettier                                                                   | [![npm](https://img.shields.io/npm/v/prettier-plugin-pkg.svg)](https://www.npmjs.com/package/prettier-plugin-pkg) | [![David Peer](https://img.shields.io/david/peer/rx-ts/prettier.svg?path=packages/pkg)](https://david-dm.org/rx-ts/prettier-plugin-pkg?path=packages/pkg&type=peer) | [![David](https://img.shields.io/david/rx-ts/prettier.svg?path=packages/pkg)](https://david-dm.org/rx-ts/prettier?path=packages/pkg) |
-| [`prettier-plugin-sh`](/packages/sh)   | An opinionated `shellscript、Dockerfile、properties、gitignore、dotenv、hosts、jvmoptions...` formatter plugin for Prettier | [![npm](https://img.shields.io/npm/v/prettier-plugin-sh.svg)](https://www.npmjs.com/package/prettier-plugin-sh)   | [![David Peer](https://img.shields.io/david/peer/rx-ts/prettier.svg?path=packages/sh)](https://david-dm.org/rx-ts/prettier?path=packages/sh&type=peer)              | [![David](https://img.shields.io/david/rx-ts/prettier.svg?path=packages/sh)](https://david-dm.org/rx-ts/prettier?path=packages/sh)   |
-| [`prettier-plugin-sql`](/packages/sql) | An opinionated sql formatter plugin for Prettier                                                                            | [![npm](https://img.shields.io/npm/v/prettier-plugin-sql.svg)](https://www.npmjs.com/package/prettier-plugin-sql) | [![David Peer](https://img.shields.io/david/peer/rx-ts/prettier.svg?path=packages/sql)](https://david-dm.org/rx-ts/prettier?path=packages/sql&type=peer)            | [![David](https://img.shields.io/david/rx-ts/prettier.svg?path=packages/sql)](https://david-dm.org/rx-ts/prettier?path=packages/sql) |
+| Package                                | Description                                                                                                                                                           | Version                                                                                                           | Peer Dependencies                                                                                                                                                   | Dependencies                                                                                                                         |
+| -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
+| [`prettier-plugin-pkg`](/packages/pkg) | An opinionated package.json formatter plugin for Prettier                                                                                                             | [![npm](https://img.shields.io/npm/v/prettier-plugin-pkg.svg)](https://www.npmjs.com/package/prettier-plugin-pkg) | [![David Peer](https://img.shields.io/david/peer/rx-ts/prettier.svg?path=packages/pkg)](https://david-dm.org/rx-ts/prettier-plugin-pkg?path=packages/pkg&type=peer) | [![David](https://img.shields.io/david/rx-ts/prettier.svg?path=packages/pkg)](https://david-dm.org/rx-ts/prettier?path=packages/pkg) |
+| [`prettier-plugin-sh`](/packages/sh)   | An opinionated `shellscript` formatter plugin for Prettier, also support simple format of `Dockerfile`, `properties`, `gitignore`, `dotenv`, `hosts`, `jvmoptions`... | [![npm](https://img.shields.io/npm/v/prettier-plugin-sh.svg)](https://www.npmjs.com/package/prettier-plugin-sh)   | [![David Peer](https://img.shields.io/david/peer/rx-ts/prettier.svg?path=packages/sh)](https://david-dm.org/rx-ts/prettier?path=packages/sh&type=peer)              | [![David](https://img.shields.io/david/rx-ts/prettier.svg?path=packages/sh)](https://david-dm.org/rx-ts/prettier?path=packages/sh)   |
+| [`prettier-plugin-sql`](/packages/sql) | An opinionated sql formatter plugin for Prettier                                                                                                                      | [![npm](https://img.shields.io/npm/v/prettier-plugin-sql.svg)](https://www.npmjs.com/package/prettier-plugin-sql) | [![David Peer](https://img.shields.io/david/peer/rx-ts/prettier.svg?path=packages/sql)](https://david-dm.org/rx-ts/prettier?path=packages/sql&type=peer)            | [![David](https://img.shields.io/david/rx-ts/prettier.svg?path=packages/sql)](https://david-dm.org/rx-ts/prettier?path=packages/sql) |
 
 ## Changelog
 

diff --git a/packages/sh/README.md b/packages/sh/README.md
@@ -4,7 +4,7 @@
 
 # prettier-plugin-sh ![npm bundle size](https://img.shields.io/bundlephobia/min/prettier-plugin-sh) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/prettier-plugin-sh)
 
-> An opinionated `shellscript、Dockerfile、properties、gitignore、dotenv、hosts、jvmoptions...` formatter plugin for [Prettier][]
+> An opinionated `shellscript` formatter plugin for [Prettier][], also support simple format of `Dockerfile`, `properties`, `gitignore`, `dotenv`, `hosts`, `jvmoptions`...
 
 Prettier is an opinionated code formatter. It enforces a consistent style by parsing your code and re-printing, taking various rules into account.
 

diff --git a/packages/sh/package.json b/packages/sh/package.json
@@ -2,7 +2,7 @@
   "name": "prettier-plugin-sh",
   "version": "0.12.1",
   "type": "module",
-  "description": "An opinionated `shellscript、Dockerfile、properties、gitignore、dotenv、hosts、jvmoptions...` formatter plugin for Prettier",
+  "description": "An opinionated `shellscript` formatter plugin for Prettier, also support simple format of `Dockerfile`, `properties`, `gitignore`, `dotenv`, `hosts`, `jvmoptions`...",
   "repository": "[email protected]/rx-ts/prettier.git",
   "homepage": "https://github.com/rx-ts/prettier/blob/master/packages/sh",
   "author": "JounQin <[email protected]>",