Skip to content

Commit 8b4a6bd

Browse files
committed
docs: apply textlint suggestions
1 parent 9d89be4 commit 8b4a6bd

File tree

2 files changed

+8
-12
lines changed

2 files changed

+8
-12
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
![integration-tests](https://github.com/textlint/vscode-textlint/actions/workflows/integration-tests.yaml/badge.svg)
44

5-
Extension to integrate [textlint](https://textlint.github.io/) into VSCode.
5+
Extension to integrate [textlint](https://textlint.github.io/) into VS Code.
66

77
## How to install
88

packages/textlint/README.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,9 @@ Integrates [textlint](https://textlint.github.io/) into VS Code. If you are new
66

77
![codeaction](https://github.com/textlint/vscode-textlint/raw/main/imgs/codeaction.png?raw=true)
88

9-
The extension uses the textlint library installed in the opened workspace folder. If the folder doesn't provide one the
10-
extension looks for a global install version. If you haven't installed textlint either locally or globally do so by running
11-
`npm install textlint` in the workspace folder for a local install or `npm install -g textlint` for a global install.
9+
The extension uses the textlint library installed in the opened workspace folder. If the folder doesn't provide one the extension looks for a global install version. If you haven't installed textlint either locally or globally do so by running `npm install textlint` in the workspace folder for a local install or `npm install -g textlint` for a global install.
1210

13-
On new folders you might also need to create a `.textlintrc` configuration file. You can do this by either running
14-
[`textlint --init`](https://github.com/textlint/textlint/blob/master/docs/getting-started.md#configuration) in a terminal or by using the VS Code
15-
command `Create '.textlintrc' file`.
11+
On new folders you might also need to create a `.textlintrc` configuration file. You can do this by either running [`textlint --init`](https://github.com/textlint/textlint/blob/master/docs/getting-started.md#configuration) in a terminal or by using the VS Code command `Create '.textlintrc' file`.
1612

1713
## Settings Options
1814

@@ -23,7 +19,7 @@ command `Create '.textlintrc' file`.
2319
- `textlint.nodePath`
2420
- use this setting if an installed textlint package can't be detected, for example `/myGlobalNodePackages/node_modules`.
2521
- `textlint.trace`
26-
- Traces the communication between VSCode and the textlint linter service.
22+
- Traces the communication between VS Code and the textlint linter service.
2723
- `textlint.configPath`
2824
- absolute path to textlint config file.
2925
- workspace settings are prioritize.
@@ -40,9 +36,9 @@ command `Create '.textlintrc' file`.
4036
This extension contributes the following commands to the Command palette.
4137

4238
- Create '.textlintrc' File
43-
- creates a new .textlintrc file.
39+
- Creates a new `.textlintrc` file.
4440
- Fix all auto-fixable Problems
45-
- applies textlint auto-fix resolutions to all fixable problems.
41+
- Applies textlint auto-fix resolutions to all fixable problems.
4642

4743
## Release Notes
4844

@@ -62,12 +58,12 @@ This extension contributes the following commands to the Command palette.
6258

6359
### 0.10.0
6460

65-
- Add vscode workspace support
61+
- Add VS Code workspace support
6662
- Prepare for web-extension
6763

6864
### 0.9.0
6965

70-
- Add .textlintignore support
66+
- Add `.textlintignore` support
7167
- Thanks to @frozenbonito
7268

7369
### 0.8.0

0 commit comments

Comments
 (0)