chore: run md-table-format when git commit changes (#2484)

* chore: md-plugin * chore: md-plugin * chore: md-plugin * chore: md-plugin * chore: md-plugin * chore: md-plugin * chore: test * chore: packagejson script
jdf2e · Jul 26, 2024 · 1836c50 · 1836c50
1 parent 86fe2fd
commit 1836c50
Show file tree

Hide file tree

Showing 338 changed files with 7,467 additions and 7,421 deletions.
diff --git a/.prettierignore b/.prettierignore
@@ -1,6 +1,5 @@
 **/*.html
 **/*.txt
-**/*.md
 **/*.svg
 **/*.ttf
 **/*.woff

diff --git a/.prettierrc b/.prettierrc
@@ -5,5 +5,6 @@
   "singleQuote": true,
   "printWidth": 80,
   "proseWrap": "preserve",
-  "endOfLine": "auto"
+  "endOfLine": "auto",
+  "plugins": ["@nutui/prettier-plugin"]
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/README.md b/README.md
@@ -1,4 +1,3 @@
-
 <p align="center">
     <img alt="logo" src="https://img11.360buyimg.com/imagetools/jfs/t1/211965/25/7152/22022/61b16785E433119bb/aa41d7a9f7e823f3.png" width="150" style="margin-bottom: 10px;">
 </p>
@@ -36,27 +35,26 @@
 
 ---
 
-> Nut[nʌt]: the one Squirrel Scrat pursues resolutely for a lifetime and will never let go even if it causes a catastrophe from the animated film ***Ice Age***.
+> Nut[nʌt]: the one Squirrel Scrat pursues resolutely for a lifetime and will never let go even if it causes a catastrophe from the animated film **_Ice Age_**.
 
 [简体中文](./README_ZH.md) | English
 
 ## Features
 
-* 🚀 70+ High Quality Components
-* 📖 Based on JD APP 11.0 Visual Specifications
-* 🍭 Support Tree Shaking
-* 📖 Extensive Documentation and Demos
-* 💪 Written in TypeScript
-* 💪 Support SSR (Experimental)
-* 🍭 Support Custom Themes
-* 🍭 90%+ Unit Test Coverage
-* 📖 Provide Sketch Design Resources
-
-
+- 🚀 70+ High Quality Components
+- 📖 Based on JD APP 11.0 Visual Specifications
+- 🍭 Support Tree Shaking
+- 📖 Extensive Documentation and Demos
+- 💪 Written in TypeScript
+- 💪 Support SSR (Experimental)
+- 🍭 Support Custom Themes
+- 🍭 90%+ Unit Test Coverage
+- 📖 Provide Sketch Design Resources
 
 ## Running locally
 
 ### running with H5
+
 ```sh
 # Clone repository
 git clone https://github.com/jdf2e/nutui-react.git
@@ -72,7 +70,9 @@ pnpm run dev
 
 # visit in browser: http：http://localhost:3000 (you don't have to open it manually if you've run it in the browser again)
 ```
+
 ### running with mini-program
+
 ```sh
 # Clone repository
 git clone https://github.com/jdf2e/nutui-react.git
@@ -96,12 +96,11 @@ pnpm run dev:taro:jd
 
 > If you are using AMD environment or build tools such as Webpack, Vite, etc., we recommend using the `es` version. If it is a non-module environment (such as direct reference through the `<script>` tag), it is recommended to use the `umd` compressed version.
 
-* es **nutui.es.js**
-
-* umd **nutui.umd.js**
+- es **nutui.es.js**
 
+- umd **nutui.umd.js**
 
-##  Links
+## Links
 
 <ul>
     <li>
@@ -126,33 +125,30 @@ pnpm run dev:taro:jd
     </li>
 </ul>
 
-
 ## Communication
 
 | Version | WeChat Group | JD Dongdong Group |
-| --- | --- |--- |
+| --- | --- | --- |
 | [NutUI React](https://github.com/jdf2e/nutui-react/issues) | <img src="https://storage.360buyimg.com/imgtools/17c67beff6-4acf07c0-609c-11ed-a6ef-69df15b605e4.png" width="100" /> Reply 「NutUI-React」 after following | 1025679314 |
 | [NutUI x Taro](https://github.com/jdf2e/nutui/issues) | <img src="https://camo.githubusercontent.com/db4276b4ee4b443158195e943e9e678cb4d2afb7580f70d4d817ef0a90413aec/687474703a2f2f73746f726167652e333630627579696d672e636f6d2f7461726f2d6a642d636f6d2f7374617469632f636f6e746163745f7461726f5f6e757475695f71722e706e67" width="100" />Reply 「NutUI-React」 after following | 1022545110 |
 
-
 ## Join Us
 
 #### NutUI Community
 
-[*Welcome To NutUI-React  Community*](https://github.com/jdf2e/nutui-react/discussions/348)
+[_Welcome To NutUI-React Community_](https://github.com/jdf2e/nutui-react/discussions/348)
 
 #### Contribute to NutUI
 
 There are some choices of contributing to NutUI as follows, solving issues, fixing bugs, adding new components, i18n, UI customization, platform and cross-end adaptation, etc.
 
-You are very welcome to contribute code to NutUI. Before your pull requests, please read [*NutUI Developer Contributing Guide*](https://github.com/jdf2e/nutui-react/discussions/348)。
-
+You are very welcome to contribute code to NutUI. Before your pull requests, please read [_NutUI Developer Contributing Guide_](https://github.com/jdf2e/nutui-react/discussions/348)。
 
 ## Issue & Discussion
 
 [Report issues to NutUI](https://nutui.jd.com/nutui-issue-helper/?repo=jdf2e/nutui-react&lang=zh-cn)
 
-> It is highly recommended to read [*How To Ask Questions The Smart Way*](https://github.com/ryanhanwu/, [*How To Ask Questions Of GitHub Community*](https://github.com/seajs/seajs/issues/545) and [*How to Report Bugs Effectively*](https://www.chiark.greenend.org.uk/~sgtatham/bugs.html), then you can get understanding and help more easily.
+> It is highly recommended to read [*How To Ask Questions The Smart Way*](https://github.com/ryanhanwu/, [_How To Ask Questions Of GitHub Community_](https://github.com/seajs/seajs/issues/545) and [_How to Report Bugs Effectively_](https://www.chiark.greenend.org.uk/~sgtatham/bugs.html), then you can get understanding and help more easily.
 
 [NutUI Discussion](https://github.com/jdf2e/nutui-react/discussions)
 
@@ -162,13 +158,11 @@ If you have any ideas, questions or suggestions, you can share your opinions her
 
 Thanks to all the following [developers](https://github.com/jdf2e/nutui-react/graphs/contributors)。 who have contributed code to NutUI.
 
-
 <a href="https://github.com/jdf2e/nutui-react/graphs/contributors">
   <img src="https://contrib.rocks/image?repo=jdf2e/nutui-react" alt="contributors"/>
 </a>
 
-
-## Stargazers 
+## Stargazers
 
 [![Stargazers repo roster for @jdf2e/nutui-react](https://reporoster.com/stars/jdf2e/nutui-react)](https://github.com/jdf2e/nutui-react/stargazers)
 
@@ -184,7 +178,6 @@ Thanks to all the following [developers](https://github.com/jdf2e/nutui-react/gr
 
 NutUI follows [Angular Style Commit Message Conventions](https://gist.github.com/stephenparish/9941e89d80e2bc58a153). The up-to-date release notes are available on [Release](https://github.com/jdf2e/nutui-react/releases)
 
-
 ## Open Source License
 
 This project is based on **MIT** protocol
diff --git a/README_EN.md b/README_EN.md
@@ -1,4 +1,3 @@
-
 <p align="center">
     <img alt="logo" src="https://img11.360buyimg.com/imagetools/jfs/t1/211965/25/7152/22022/61b16785E433119bb/aa41d7a9f7e823f3.png" width="150" style="margin-bottom: 10px;">
 </p>
@@ -36,33 +35,31 @@
 
 ---
 
-> Nut[nʌt]: the one Squirrel Scrat pursues resolutely for a lifetime and will never let go even if it causes a catastrophe from the animated film ***Ice Age***.
+> Nut[nʌt]: the one Squirrel Scrat pursues resolutely for a lifetime and will never let go even if it causes a catastrophe from the animated film **_Ice Age_**.
 
 [简体中文](./README.md) | English
 
 ## Features
 
-* 🚀 60+ High Quality Components
-* 📖 Based on JD APP 10.0 Visual Specifications
-* 🍭 Support Tree Shaking
-* 📖 Extensive Documentation and Demos
-* 💪 Written in TypeScript
-* 💪 Support SSR (Experimental)
-* 🍭 Support Custom Themes
-* 🍭 80%+ Unit Test Coverage
-* 📖 Provide Sketch Design Resources
-
+- 🚀 60+ High Quality Components
+- 📖 Based on JD APP 10.0 Visual Specifications
+- 🍭 Support Tree Shaking
+- 📖 Extensive Documentation and Demos
+- 💪 Written in TypeScript
+- 💪 Support SSR (Experimental)
+- 🍭 Support Custom Themes
+- 🍭 80%+ Unit Test Coverage
+- 📖 Provide Sketch Design Resources
 
 ## Build Versions
 
 > If you are using AMD environment or build tools such as Webpack, Vite, etc., we recommend using the `es` version. If it is a non-module environment (such as direct reference through the `<script>` tag), it is recommended to use the `umd` compressed version.
 
-* es **nutui.es.js**
-
-* umd **nutui.umd.js**
+- es **nutui.es.js**
 
+- umd **nutui.umd.js**
 
-##  Links
+## Links
 
 <ul>
     <li>
@@ -87,33 +84,30 @@
     </li>
 </ul>
 
-
 ## Communication
 
 | Version | WeChat Group | JD Dongdong Group |
-| --- | --- |--- |
+| --- | --- | --- |
 | [NutUI React](https://github.com/jdf2e/nutui-react/issues) | <img src="https://storage.360buyimg.com/imgtools/17c67beff6-4acf07c0-609c-11ed-a6ef-69df15b605e4.png" width="100" /> Reply 「NutUI-React」 after following | 1025679314 |
 | [NutUI x Taro](https://github.com/jdf2e/nutui/issues) | <img src="https://camo.githubusercontent.com/db4276b4ee4b443158195e943e9e678cb4d2afb7580f70d4d817ef0a90413aec/687474703a2f2f73746f726167652e333630627579696d672e636f6d2f7461726f2d6a642d636f6d2f7374617469632f636f6e746163745f7461726f5f6e757475695f71722e706e67" width="100" />Reply 「NutUI-React」 after following | 1022545110 |
 
-
 ## Join Us
 
 #### NutUI Community
 
-[*Welcome To NutUI-React  Community*](https://github.com/jdf2e/nutui-react/discussions/348)
+[_Welcome To NutUI-React Community_](https://github.com/jdf2e/nutui-react/discussions/348)
 
 #### Contribute to NutUI
 
 There are some choices of contributing to NutUI as follows, solving issues, fixing bugs, adding new components, i18n, UI customization, platform and cross-end adaptation, etc.
 
-You are very welcome to contribute code to NutUI. Before your pull requests, please read [*NutUI Developer Contributing Guide*](https://github.com/jdf2e/nutui-react/discussions/348)。
-
+You are very welcome to contribute code to NutUI. Before your pull requests, please read [_NutUI Developer Contributing Guide_](https://github.com/jdf2e/nutui-react/discussions/348)。
 
 ## Issue & Discussion
 
 [Report issues to NutUI](https://nutui.jd.com/nutui-issue-helper/?repo=jdf2e/nutui-react&lang=zh-cn)
 
-> It is highly recommended to read [*How To Ask Questions The Smart Way*](https://github.com/ryanhanwu/, [*How To Ask Questions Of GitHub Community*](https://github.com/seajs/seajs/issues/545) and [*How to Report Bugs Effectively*](https://www.chiark.greenend.org.uk/~sgtatham/bugs.html), then you can get understanding and help more easily.
+> It is highly recommended to read [*How To Ask Questions The Smart Way*](https://github.com/ryanhanwu/, [_How To Ask Questions Of GitHub Community_](https://github.com/seajs/seajs/issues/545) and [_How to Report Bugs Effectively_](https://www.chiark.greenend.org.uk/~sgtatham/bugs.html), then you can get understanding and help more easily.
 
 [NutUI Discussion](https://github.com/jdf2e/nutui-react/discussions)
 
@@ -123,13 +117,11 @@ If you have any ideas, questions or suggestions, you can share your opinions her
 
 Thanks to all the following [developers](https://github.com/jdf2e/nutui-react/graphs/contributors)。 who have contributed code to NutUI.
 
-
 <a href="https://github.com/jdf2e/nutui-react/graphs/contributors">
   <img src="https://contrib.rocks/image?repo=jdf2e/nutui-react" alt="contributors"/>
 </a>
 
-
-## Stargazers 
+## Stargazers
 
 [![Stargazers repo roster for @jdf2e/nutui-react](https://reporoster.com/stars/jdf2e/nutui-react)](https://github.com/jdf2e/nutui-react/stargazers)
 
@@ -145,7 +137,6 @@ Thanks to all the following [developers](https://github.com/jdf2e/nutui-react/gr
 
 NutUI follows [Angular Style Commit Message Conventions](https://gist.github.com/stephenparish/9941e89d80e2bc58a153). The up-to-date release notes are available on [Release](https://github.com/jdf2e/nutui-react/releases)
 
-
 ## Open Source License
 
-This project is based on **MIT** protocol
+This project is based on **MIT** protocol
diff --git a/README_ZH.md b/README_ZH.md
@@ -1,4 +1,3 @@
-
 <p align="center">
     <img alt="logo" src="https://img11.360buyimg.com/imagetools/jfs/t1/211965/25/7152/22022/61b16785E433119bb/aa41d7a9f7e823f3.png" width="150" style="margin-bottom: 10px;">
 </p>
@@ -35,26 +34,27 @@
 </p>
 
 ---
+
 > Nut[nʌt]，源自电影《冰河世纪》里松鼠 Scrat "执迷不悟"，一生追求，即便引发大灾难也绝不松手的坚果。
 
 简体中文 | [English](./README.md)
 
-##  特性
-
-* 🚀 70+ 高质量组件, 覆盖移动端主流场景
-* 📖 基于京东 APP 11.0 视觉规范
-* 🍭 支持按需引用
-* 📖 详尽的文档和示例
-* 💪 支持 TypeScript
-* 💪 支持服务端渲染（测试阶段）
-* 🍭 支持定制主题
-* 🍭 单元测试覆盖率超过90%, 保障稳定性
-* 📖 提供 Sketch 设计资源
+## 特性
 
+- 🚀 70+ 高质量组件, 覆盖移动端主流场景
+- 📖 基于京东 APP 11.0 视觉规范
+- 🍭 支持按需引用
+- 📖 详尽的文档和示例
+- 💪 支持 TypeScript
+- 💪 支持服务端渲染（测试阶段）
+- 🍭 支持定制主题
+- 🍭 单元测试覆盖率超过90%, 保障稳定性
+- 📖 提供 Sketch 设计资源
 
 ## 项目运行
 
 ### 本地运行H5
+
 ```sh
 # 克隆仓库
 git clone https://github.com/jdf2e/nutui-react.git
@@ -70,7 +70,9 @@ pnpm install
 pnpm run dev
 
 ```
+
 ### 本地运行小程序
+
 ```sh
 # 克隆仓库
 git clone https://github.com/jdf2e/nutui-react.git
@@ -94,10 +96,9 @@ pnpm run dev:taro:jd
 
 > AMD 环境、Webpack、Vite 等构建工具环境、服务端建议使用 es 版，非模块化环境（如通过 `<script>` 标签直接引用）建议使用 umd 压缩版。
 
-* es **nutui.react.es.js**
-
-* umd **nutui.umd.js**
+- es **nutui.react.es.js**
 
+- umd **nutui.umd.js**
 
 ## 链接
 
@@ -125,14 +126,15 @@ pnpm run dev:taro:jd
 </ul>
 
 ## 开发交流
-| 版本 | 微信群 |内部咚咚群 |
-| --- | --- |--- |
+
+| 版本 | 微信群 | 内部咚咚群 |
+| --- | --- | --- |
 | [NutUI React](https://github.com/jdf2e/nutui-react/issues) | <img src="https://storage.360buyimg.com/imgtools/17c67beff6-4acf07c0-609c-11ed-a6ef-69df15b605e4.png" width="100" /> 关注后回复「NutUI-React」 | 1025679314 |
 | [NutUI x Taro](https://github.com/jdf2e/nutui/issues) | <img src="https://camo.githubusercontent.com/db4276b4ee4b443158195e943e9e678cb4d2afb7580f70d4d817ef0a90413aec/687474703a2f2f73746f726167652e333630627579696d672e636f6d2f7461726f2d6a642d636f6d2f7374617469632f636f6e746163745f7461726f5f6e757475695f71722e706e67" width="100" /> 关注后回复「NutUI-React」 | 1022545110 |
 
 ## 参与共建
 
-如果您对这个项目感兴趣，欢迎参与贡献，也欢迎 "Star" 支持一下 ^_^
+如果您对这个项目感兴趣，欢迎参与贡献，也欢迎 "Star" 支持一下 ^\_^
 
 #### NutUI 社区共建倡议
 
@@ -162,7 +164,7 @@ NutUI 的共建方向主要分为：解决 issue、修复 bug、新增组件、
   <img src="https://contrib.rocks/image?repo=jdf2e/nutui-react" />
 </a>
 
-## Stargazers 
+## Stargazers
 
 [![Stargazers repo roster for @jdf2e/nutui-react](https://reporoster.com/stars/jdf2e/nutui-react)](https://github.com/jdf2e/nutui-react/stargazers)