This extension is the community-based maintenance version under the textlint organization. It has been transferred for continued maintenance and development. For more details, please refer to https://github.com/orgs/textlint/discussions/2.
Integrates textlint into VS Code. If you are new to textlint, check the documentation.
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.
When working with new projects, you might need to create a .textlintrc configuration file. You can do this by either running textlint --init in a terminal or by using the VS Code command Create '.textlintrc' file.
Settings options
textlint.autoFixOnSave
Default: false. When set to true, the extension will automatically fix auto-fixable errors on save.
textlint.run
Controls when the linter runs. Options: onSave or onType. Default: onType.
textlint.nodePath
Use this setting if an installed textlint package can't be detected, for example /myGlobalNodePackages/node_modules.
textlint.trace
Traces the communication between VS Code and the textlint linter service.
textlint.configPath
Absolute path to textlint config file.
Workspace settings take priority over this setting.
