Skip to content

docs: improve README grammar and formatting consistency #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
3w36zj6 merged 1 commit into from
Apr 5, 2025
Merged

docs: improve README grammar and formatting consistency #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 15 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,29 @@

Extension to integrate [textlint](https://textlint.github.io/) into VS Code.

## How to install
## Installation

1. Visit [Visual Studio Code: textlint](https://marketplace.visualstudio.com/items?itemName=3w36zj6.textlint)
2. Click Install
1. Visit [textlint - Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=3w36zj6.textlint)
2. Click the "Install" button

## Development setup

1. open `vscode-textlint.code-workspace` by VS Code
2. run `npm ci` inside the **root** folder
3. hit F5 to build and debug the extension
1. Open `vscode-textlint.code-workspace` in VS Code
2. Run `npm ci` in the **root** folder
3. Press F5 to build and launch the extension in debug mode

## How to release
## Release process

1. run `npm ci` inside the **root** folder
2. run `npm run package` inside the **root** folder
3. run `npx vsce publish --packagePath ./packages/textlint/textlint-*.vsix` inside the **root** folder
1. Run `npm ci` in the **root** folder
2. Run `npm run package` in the **root** folder
3. Run `npx vsce publish --packagePath ./packages/textlint/textlint-*.vsix` in the **root** folder

## Acknowledgements

This project was originally created as [taichi/vscode-textlint](https://github.com/taichi/vscode-textlint). It has been transferred to the textlint organization since [v0.12.0](https://github.com/textlint/vscode-textlint/releases/tag/v0.12.0) for continued maintenance and development. We'd like to express our gratitude to [@taichi](https://github.com/taichi) and all contributors. For more details, please see [github.com/orgs/textlint/discussions/2](https://github.com/orgs/textlint/discussions/2).
This project was originally created as [taichi/vscode-textlint](https://github.com/taichi/vscode-textlint).

Since [v0.12.0](https://github.com/textlint/vscode-textlint/releases/tag/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](https://github.com/taichi) and all contributors. For more details, please see [github.com/orgs/textlint/discussions/2](https://github.com/orgs/textlint/discussions/2).

The [MIT License](LICENSE) from the upstream repository continues to be honored and upheld.
70 changes: 35 additions & 35 deletions packages/textlint/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,119 +1,119 @@
# VS Code textlint extension

Integrates [textlint](https://textlint.github.io/) into VS Code. If you are new to textlint check the [documentation](https://textlint.github.io/).
Integrates [textlint](https://textlint.github.io/) into VS Code. If you are new to textlint, check the [documentation](https://textlint.github.io/).

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

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

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.
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.

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`.
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`.

## Settings Options
## Settings options

- `textlint.autoFixOnSave`
- by default is `false`. if you set `true`, Automatically fix auto-fixable errors on save.
- Default: `false`. When set to `true`, the extension will automatically fix auto-fixable errors on save.
- `textlint.run`
- run the linter `onSave` or `onType`, default is `onType`.
- 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`.
- 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 are prioritize.
- Absolute path to textlint config file.
- Workspace settings take priority over this setting.
- `textlint.ignorePath`
- absolute path to textlint ignore file.
- see [here](https://textlint.github.io/docs/ignore.html#ignoring-files-textlintignore) for ignore file.
- Absolute path to textlint ignore file.
- See [here](https://textlint.github.io/docs/ignore.html#ignoring-files-textlintignore) for more information about ignore files.
- `textlint.targetPath`
- set a glob pattern.
- Set a glob pattern to determine which files to lint.
- `textlint.languages`
- Languages to lint with textlint.

## Commands

This extension contributes the following commands to the Command palette.
This extension contributes the following commands to the Command palette:

- Create '.textlintrc' File
- Creates a new `.textlintrc` file.
- Creates a new `.textlintrc` configuration file in your workspace.
- Fix all auto-fixable Problems
- Applies textlint auto-fix resolutions to all fixable problems.
- Applies textlint auto-fix resolutions to all fixable problems in the current document.

## Release Notes
## Release notes

### 0.12.0

- Change notification level from `ERROR` to `WARN` when executable file is not found ([#6](https://github.com/textlint/vscode-textlint/pull/6))
- Changed notification level from `ERROR` to `WARN` when executable file is not found ([#6](https://github.com/textlint/vscode-textlint/pull/6))
- Thanks to @azu
- Improve `.textlintignore` support using `linter.scanFilePath()` API ([#7](https://github.com/textlint/vscode-textlint/pull/7))
- Improved `.textlintignore` support using `linter.scanFilePath()` API ([#7](https://github.com/textlint/vscode-textlint/pull/7))
- Thanks to @frozenbonito
- Enable to emit activation events on all language files ([#8](https://github.com/textlint/vscode-textlint/pull/8))
- Enabled to emit activation events on all language files ([#8](https://github.com/textlint/vscode-textlint/pull/8))
- Thanks to @iku12phycho

### 0.11.0

- Fix highlight range issue
- Fixed highlight range issue
- Thanks to @Yuiki

### 0.10.0

- Add VS Code workspace support
- Prepare for web-extension
- Added VS Code workspace support
- Prepared for web-extension

### 0.9.0

- Add `.textlintignore` support
- Added `.textlintignore` support
- Thanks to @frozenbonito

### 0.8.0

- Add option to choose languages and improve positioning of highlighted
- Added option to choose languages and improved positioning of highlighted text
- Thanks to @linhtto

### 0.7.0

- Add sets a target path support
- Added target path support
- Thanks to @bells17

### 0.6.8

- Change default value of `textlint.run` to `onSave`
- Run tests on Azure Pipelines
- Changed default value of `textlint.run` to `onSave`
- Added Azure Pipelines for CI testing

### 0.6.5

- Add tex file support including `.tex`, `.latex`, `.doctex`
- Added tex file support including `.tex`, `.latex`, `.doctex`
- 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)

### 0.5.0

- Add `configPath` to configuration. Recommend to use your user settings
- Added `configPath` to configuration. Recommend to use your user settings

### 0.4.0

- Read configuration file from `HOME` dir
- Added ability to read configuration file from `HOME` directory
- If you want to use global configuration, you should install textlint and plugins globally

### 0.3.0

- Update runtime dependencies
- Updated runtime dependencies

### 0.2.3

- Add tracing option
- Added a tracing option

### 0.2.2

- Fix some bug
- Fixed various bugs

### 0.2.1

- Add progress notification to StatusBar
- Added progress notification to StatusBar

### 0.2.0

- Add support for fixing errors
- Added support for fixing errors

### 0.1.0

Expand Down