docs: fix textlint

vuejs · Dec 22, 2021 · 15b6c75 · 15b6c75
1 parent daa6404
commit 15b6c75
Show file tree

Hide file tree

Showing 8 changed files with 26 additions and 29 deletions.
diff --git a/changelog-unpublished/1.9/index.md b/changelog-unpublished/1.9/index.md
@@ -118,7 +118,7 @@ Type inference supports [ISO Language Code](http://www.lingoes.net/en/translator
 
 ### Context API
 
-VuePress's configuration can also be a function, while its first parameter is the current [app context](https://vuepress.vuejs.org/plugin/context-api.html#context-api):
+VuePress’s configuration can also be a function, while its first parameter is the current [app context](https://vuepress.vuejs.org/plugin/context-api.html#context-api):
 
 ```ts
 import { defineConfig } from "vuepress/config";
@@ -131,7 +131,7 @@ export default defineConfig(ctx => ({
 
 ## Limitations
 
-It is worth noting that third-party plugins do not support [Plugin Shorthand](https://vuepress.vuejs.org/plugin/using-a-plugin.html#plugin-shorthand) if you're using [Tuple Style](https://vuepress.vuejs.org/plugin/using-a-plugin.html#plugin-options) to write your config, this is because from the perspective of the type system, the unknown shortcut is equivalent to `string`, which results in the failure of type inference.
+It is worth noting that third-party plugins do not support [Plugin Shorthand](https://vuepress.vuejs.org/plugin/using-a-plugin.html#plugin-shorthand) if you’re using [Tuple Style](https://vuepress.vuejs.org/plugin/using-a-plugin.html#plugin-options) to write your config, this is because from the perspective of the type system, the unknown shortcut is equivalent to `string`, which results in the failure of type inference.
 
 By default, only officially maintained and plugins under [VuePress Community](https://vuepress-community.netlify.app/en/) support shortcut, feel free to submit pull request to add your plugin at this [file](https://github.com/vuejs/vuepress/blob/master/packages/vuepress/types/third-party-plugins.ts).
 

diff --git a/packages/@vuepress/markdown/README.md b/packages/@vuepress/markdown/README.md
@@ -22,7 +22,7 @@ console.log(isRequiredPlugin(PLUGINS.HIGHLIGHT_LINES)) // false
 
 Remove the specified built-in markdown-it plugin in VuePress.
 
-It's needed to use with VuePress's [Plugin API > chainMarkdown](https://vuepress.vuejs.org/plugin/option-api.html#chainmarkdown).
+It's needed to use with VuePress’s [Plugin API > chainMarkdown](https://vuepress.vuejs.org/plugin/option-api.html#chainmarkdown).
 
 - **Usage**:
 

diff --git a/packages/docs/.textlint.terms.json b/packages/docs/.textlint.terms.json
diff --git a/packages/docs/.textlintrc.js b/packages/docs/.textlintrc.js
@@ -1,23 +1,28 @@
 module.exports = {
   rules: {
-    '@textlint-rule/no-unmatched-pair': true,
+    "@textlint-rule/no-unmatched-pair": true,
     apostrophe: true,
-    'common-misspellings': true,
+    "common-misspellings": true,
     diacritics: true,
-    'en-capitalization': {
-      allowHeading: false
-    },
-    'stop-words': {
-      severity: 'warning'
+    "en-capitalization": false,
+    "stop-words": {
+      severity: "warning"
     },
     terminology: {
-      terms: `${__dirname}/.textlint.terms.json`
+      terms: [
+        "VuePress",
+        "sass",
+        [
+          "front[- ]matter",
+          "frontmatter"
+        ]
+      ]
     },
-    'write-good': {
-      severity: 'warning'
+    "write-good": {
+      severity: "warning"
     }
   },
   filters: {
     comments: true
   }
-}
+};
diff --git a/packages/docs/docs/guide/deploy.md b/packages/docs/docs/guide/deploy.md
@@ -57,15 +57,15 @@ You can also run the above script in your CI setup to enable automatic deploymen
 :::
 
 ::: tip
-When you use a **Custom Domain name**, you MUST add the CNAME file into /docs/.vuepress/public folder (Create the folder if it isn't there). Otherwise, your CNAME file will always be removed with each deploy and never work.
+When you use a **Custom Domain name**, you MUST add the CNAME file into /docs/.vuepress/public folder (Create the folder if it isn’t there). Otherwise, your CNAME file will always be removed with each deploy and never work.
 :::
 
 
 ### GitHub Pages and GitHub Actions
 
 1. [Create a personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token);
 2. Create [encrypted secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets) under your repository;
-3. Create a `.yml` or `.yaml` file in the `.github/workflows` directory in the root of your repository. e.g:`vuepress-deploy.yml`:
+3. Create a `.yml` or `.yaml` file in the `.github/workflows` directory in the root of your repository. e.g. `vuepress-deploy.yml`:
 
 ```yml
 name: Build and Deploy

diff --git a/packages/docs/docs/guide/typescript-as-config.md b/packages/docs/docs/guide/typescript-as-config.md
@@ -101,7 +101,7 @@ The illustration snapshot is omitted here, you can try it yourself.
 
 ## Third Plugins
 
-It is worth noting that third-party plugins do not support [Plugin Shorthand](../plugin/using-a-plugin.md#plugin-shorthand) if you're using [Tuple Style](../plugin/using-a-plugin.md#plugin-options) to write your config, this is because from the perspective of the type system, the unknown shortcut is equivalent to `string`, which results in the failure of type inference.
+It is worth noting that third-party plugins do not support [Plugin Shorthand](../plugin/using-a-plugin.md#plugin-shorthand) if you’re using [Tuple Style](../plugin/using-a-plugin.md#plugin-options) to write your config, this is because from the perspective of the type system, the unknown shortcut is equivalent to `string`, which results in the failure of type inference.
 
 By default, only officially maintained and plugins under [VuePress Community](https://vuepress-community.netlify.app/en/) support shortcut, feel free to submit pull request to add your plugin at this [file](https://github.com/vuejs/vuepress/blob/master/packages/vuepress/types/third-party-plugins.ts).
 
@@ -113,7 +113,7 @@ Type inference supports [ISO Language Code](http://www.lingoes.net/en/translator
 
 ## Context API
 
-VuePress's configuration can also be a function, while its first parameter is the current [app context](../plugin/context-api.md#context-api):
+VuePress’s configuration can also be a function, while its first parameter is the current [app context](../plugin/context-api.md#context-api):
 
 ```ts
 import { defineConfig } from "vuepress/config";

diff --git a/packages/docs/docs/zh/guide/typescript-as-config.md b/packages/docs/docs/zh/guide/typescript-as-config.md
@@ -101,7 +101,7 @@ The illustration snapshot is omitted here, you can try it yourself.
 
 ## Third Plugins
 
-It is worth noting that third-party plugins do not support [Plugin Shorthand](../plugin/using-a-plugin.md#plugin-shorthand) if you're using [Tuple Style](../plugin/using-a-plugin.md#plugin-options) to write your config, this is because from the perspective of the type system, the unknown shortcut is equivalent to `string`, which results in the failure of type inference.
+It is worth noting that third-party plugins do not support [Plugin Shorthand](../plugin/using-a-plugin.md#plugin-shorthand) if you’re using [Tuple Style](../plugin/using-a-plugin.md#plugin-options) to write your config, this is because from the perspective of the type system, the unknown shortcut is equivalent to `string`, which results in the failure of type inference.
 
 By default, only officially maintained and plugins under [VuePress Community](https://vuepress-community.netlify.app/en/) support shortcut, feel free to submit pull request to add your plugin at this [file](https://github.com/vuejs/vuepress/blob/master/packages/vuepress/types/third-party-plugins.ts).
 
@@ -113,7 +113,7 @@ Type inference supports [ISO Language Code](http://www.lingoes.net/en/translator
 
 ## Context API
 
-VuePress's configuration can also be a function, while its first parameter is the current [app context](../plugin/context-api.md#context-api):
+VuePress’s configuration can also be a function, while its first parameter is the current [app context](../plugin/context-api.md#context-api):
 
 ```ts
 import { defineConfig } from "vuepress/config";

diff --git a/rfcs/README.md b/rfcs/README.md
@@ -31,6 +31,6 @@ You should consider using this process if you intend to make `"substantial"` cha
 - The author of an RFC is not obligated to implement it. Of course, the RFC author (like any other developer) is welcome to post an implementation for review after the RFC has been accepted.
 - If you are interested in working on the implementation for an `'active'` RFC, but cannot determine if someone else is already working on it, feel free to ask (e.g. by leaving a comment on the associated issue).
 - It's worth noting that even if RFC becomes `'active'`, it doesn't mean that the pull request of this implementation will eventually be merged.
-- **VuePress's RFC process owes its inspiration to the [Yarn RFC process]**.
+- **VuePress’s RFC process owes its inspiration to the [Yarn RFC process]**.
 
 [Yarn RFC process]: https://github.com/yarnpkg/rfcs