|
1 | 1 | # VS Code textlint extension |
2 | 2 |
|
3 | | -Integrates [textlint](https://textlint.github.io/) into VS Code. If you are new to textlint check the [documentation](https://textlint.github.io/). |
| 3 | +Integrates [textlint](https://textlint.github.io/) into VS Code. If you are new to textlint, check the [documentation](https://textlint.github.io/). |
4 | 4 |
|
5 | 5 |  |
6 | 6 |
|
7 | 7 |  |
8 | 8 |
|
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. |
| 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, you can do so by running `npm install textlint` in the workspace folder for a local install or `npm install -g textlint` for a global install. |
10 | 10 |
|
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`. |
| 11 | +When working with new projects, you might 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`. |
12 | 12 |
|
13 | | -## Settings Options |
| 13 | +## Settings options |
14 | 14 |
|
15 | 15 | - `textlint.autoFixOnSave` |
16 | | - - by default is `false`. if you set `true`, Automatically fix auto-fixable errors on save. |
| 16 | + - Default: `false`. When set to `true`, the extension will automatically fix auto-fixable errors on save. |
17 | 17 | - `textlint.run` |
18 | | - - run the linter `onSave` or `onType`, default is `onType`. |
| 18 | + - Controls when the linter runs. Options: `onSave` or `onType`. Default: `onType`. |
19 | 19 | - `textlint.nodePath` |
20 | | - - use this setting if an installed textlint package can't be detected, for example `/myGlobalNodePackages/node_modules`. |
| 20 | + - Use this setting if an installed textlint package can't be detected, for example `/myGlobalNodePackages/node_modules`. |
21 | 21 | - `textlint.trace` |
22 | 22 | - Traces the communication between VS Code and the textlint linter service. |
23 | 23 | - `textlint.configPath` |
24 | | - - absolute path to textlint config file. |
25 | | - - workspace settings are prioritize. |
| 24 | + - Absolute path to textlint config file. |
| 25 | + - Workspace settings take priority over this setting. |
26 | 26 | - `textlint.ignorePath` |
27 | | - - absolute path to textlint ignore file. |
28 | | - - see [here](https://textlint.github.io/docs/ignore.html#ignoring-files-textlintignore) for ignore file. |
| 27 | + - Absolute path to textlint ignore file. |
| 28 | + - See [here](https://textlint.github.io/docs/ignore.html#ignoring-files-textlintignore) for more information about ignore files. |
29 | 29 | - `textlint.targetPath` |
30 | | - - set a glob pattern. |
| 30 | + - Set a glob pattern to determine which files to lint. |
31 | 31 | - `textlint.languages` |
32 | 32 | - Languages to lint with textlint. |
33 | 33 |
|
34 | 34 | ## Commands |
35 | 35 |
|
36 | | -This extension contributes the following commands to the Command palette. |
| 36 | +This extension contributes the following commands to the Command palette: |
37 | 37 |
|
38 | 38 | - Create '.textlintrc' File |
39 | | - - Creates a new `.textlintrc` file. |
| 39 | + - Creates a new `.textlintrc` configuration file in your workspace. |
40 | 40 | - Fix all auto-fixable Problems |
41 | | - - Applies textlint auto-fix resolutions to all fixable problems. |
| 41 | + - Applies textlint auto-fix resolutions to all fixable problems in the current document. |
42 | 42 |
|
43 | | -## Release Notes |
| 43 | +## Release notes |
44 | 44 |
|
45 | 45 | ### 0.12.0 |
46 | 46 |
|
47 | | -- Change notification level from `ERROR` to `WARN` when executable file is not found ([#6](https://github.com/textlint/vscode-textlint/pull/6)) |
| 47 | +- Changed notification level from `ERROR` to `WARN` when executable file is not found ([#6](https://github.com/textlint/vscode-textlint/pull/6)) |
48 | 48 | - Thanks to @azu |
49 | | -- Improve `.textlintignore` support using `linter.scanFilePath()` API ([#7](https://github.com/textlint/vscode-textlint/pull/7)) |
| 49 | +- Improved `.textlintignore` support using `linter.scanFilePath()` API ([#7](https://github.com/textlint/vscode-textlint/pull/7)) |
50 | 50 | - Thanks to @frozenbonito |
51 | | -- Enable to emit activation events on all language files ([#8](https://github.com/textlint/vscode-textlint/pull/8)) |
| 51 | +- Enabled to emit activation events on all language files ([#8](https://github.com/textlint/vscode-textlint/pull/8)) |
52 | 52 | - Thanks to @iku12phycho |
53 | 53 |
|
54 | 54 | ### 0.11.0 |
55 | 55 |
|
56 | | -- Fix highlight range issue |
| 56 | +- Fixed highlight range issue |
57 | 57 | - Thanks to @Yuiki |
58 | 58 |
|
59 | 59 | ### 0.10.0 |
60 | 60 |
|
61 | | -- Add VS Code workspace support |
62 | | -- Prepare for web-extension |
| 61 | +- Added VS Code workspace support |
| 62 | +- Prepared for web-extension |
63 | 63 |
|
64 | 64 | ### 0.9.0 |
65 | 65 |
|
66 | | -- Add `.textlintignore` support |
| 66 | +- Added `.textlintignore` support |
67 | 67 | - Thanks to @frozenbonito |
68 | 68 |
|
69 | 69 | ### 0.8.0 |
70 | 70 |
|
71 | | -- Add option to choose languages and improve positioning of highlighted |
| 71 | +- Added option to choose languages and improved positioning of highlighted text |
72 | 72 | - Thanks to @linhtto |
73 | 73 |
|
74 | 74 | ### 0.7.0 |
75 | 75 |
|
76 | | -- Add sets a target path support |
| 76 | +- Added target path support |
77 | 77 | - Thanks to @bells17 |
78 | 78 |
|
79 | 79 | ### 0.6.8 |
80 | 80 |
|
81 | | -- Change default value of `textlint.run` to `onSave` |
82 | | -- Run tests on Azure Pipelines |
| 81 | +- Changed default value of `textlint.run` to `onSave` |
| 82 | +- Added Azure Pipelines for CI testing |
83 | 83 |
|
84 | 84 | ### 0.6.5 |
85 | 85 |
|
86 | | -- Add tex file support including `.tex`, `.latex`, `.doctex` |
| 86 | +- Added tex file support including `.tex`, `.latex`, `.doctex` |
87 | 87 | - This feature works with [LaTeX Workshop](https://marketplace.visualstudio.com/items?itemName=James-Yu.latex-workshop) and [textlint-plugin-latex2e](https://github.com/ta2gch/textlint-plugin-latex2e) |
88 | 88 |
|
89 | 89 | ### 0.5.0 |
90 | 90 |
|
91 | | -- Add `configPath` to configuration. Recommend to use your user settings |
| 91 | +- Added `configPath` to configuration. Recommend to use your user settings |
92 | 92 |
|
93 | 93 | ### 0.4.0 |
94 | 94 |
|
95 | | -- Read configuration file from `HOME` dir |
| 95 | +- Added ability to read configuration file from `HOME` directory |
96 | 96 | - If you want to use global configuration, you should install textlint and plugins globally |
97 | 97 |
|
98 | 98 | ### 0.3.0 |
99 | 99 |
|
100 | | -- Update runtime dependencies |
| 100 | +- Updated runtime dependencies |
101 | 101 |
|
102 | 102 | ### 0.2.3 |
103 | 103 |
|
104 | | -- Add tracing option |
| 104 | +- Added a tracing option |
105 | 105 |
|
106 | 106 | ### 0.2.2 |
107 | 107 |
|
108 | | -- Fix some bug |
| 108 | +- Fixed various bugs |
109 | 109 |
|
110 | 110 | ### 0.2.1 |
111 | 111 |
|
112 | | -- Add progress notification to StatusBar |
| 112 | +- Added progress notification to StatusBar |
113 | 113 |
|
114 | 114 | ### 0.2.0 |
115 | 115 |
|
116 | | -- Add support for fixing errors |
| 116 | +- Added support for fixing errors |
117 | 117 |
|
118 | 118 | ### 0.1.0 |
119 | 119 |
|
|
0 commit comments