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.
- Visit textlint - Visual Studio Marketplace
- Click the "Install" button
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.
textlint.autoFixOnSave- Default:
false. When set totrue, the extension will automatically fix auto-fixable errors on save.
- Default:
textlint.run- Controls when the linter runs. Options:
onSaveoronType. Default:onSave.
- Controls when the linter runs. Options:
textlint.nodePath- Use this setting if an installed textlint package can't be detected, for example
/myGlobalNodePackages/node_modules.
- Use this setting if an installed textlint package can't be detected, for example
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.
textlint.ignorePath- Absolute path to textlint ignore file.
- See here for more information about ignore files.
textlint.targetPath- Set a glob pattern to determine which files to lint.
textlint.languages- Languages to lint with textlint.
This extension contributes the following commands to the Command palette:
- Create '.textlintrc' File
- Creates a new
.textlintrcconfiguration file in your workspace.
- Creates a new
- Fix all auto-fixable Problems
- Applies textlint auto-fix resolutions to all fixable problems in the current document.
- Changed notification level from
ERRORtoWARNwhen executable file is not found (#6)- Thanks to @azu
- Improved
.textlintignoresupport usinglinter.scanFilePath()API (#7)- Thanks to @frozenbonito
- Enabled to emit activation events on all language files (#8)
- Thanks to @iku12phycho
- Fixed highlight range issue
- Thanks to @Yuiki
- Added VS Code workspace support
- Prepared for web-extension
- Added
.textlintignoresupport- Thanks to @frozenbonito
- Added option to choose languages and improved positioning of highlighted text
- Thanks to @linhtto
- Added target path support
- Thanks to @bells17
- Changed default value of
textlint.runtoonSave - Added Azure Pipelines for CI testing
- Added tex file support including
.tex,.latex,.doctex- This feature works with LaTeX Workshop and textlint-plugin-latex2e
- Added
configPathto configuration. Recommend to use your user settings
- Added ability to read configuration file from
HOMEdirectory- If you want to use global configuration, you should install textlint and plugins globally
- Updated runtime dependencies
- Added a tracing option
- Fixed various bugs
- Added progress notification to StatusBar
- Added support for fixing errors
- Initial Release
This project was originally created as taichi/vscode-textlint.
Since v0.12.0, it has been transferred to the textlint organization for continued maintenance and development.
We'd like to express our gratitude to @taichi and all contributors. For more details, please see github.com/orgs/textlint/discussions/2.
The MIT License from the upstream repository continues to be honored and upheld.
See the contributing guide for development setup and release process.