Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/yutotnh/word-divider

VS Code extension for word-by-word cursor movement in Japanese and Chinese sentences
https://github.com/yutotnh/word-divider

typescript vscode-extension

Last synced: about 2 months ago
JSON representation

VS Code extension for word-by-word cursor movement in Japanese and Chinese sentences

Host: GitHub
URL: https://github.com/yutotnh/word-divider
Owner: yutotnh
License: mit
Created: 2024-01-11T15:02:02.000Z (12 months ago)
Default Branch: main
Last Pushed: 2024-04-12T22:50:48.000Z (9 months ago)
Last Synced: 2024-04-13T16:32:51.053Z (9 months ago)
Topics: typescript, vscode-extension
Language: TypeScript
Homepage: https://marketplace.visualstudio.com/items?itemName=yutotnh.word-divider
Size: 2.6 MB
Stars: 4
Watchers: 1
Forks: 0
Open Issues: 9
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        # Word Divider

[![Format](https://github.com/yutotnh/word-divider/actions/workflows/format.yml/badge.svg)](https://github.com/yutotnh/word-divider/actions/workflows/format.yml)

[![Lint](https://github.com/yutotnh/word-divider/actions/workflows/lint.yml/badge.svg)](https://github.com/yutotnh/word-divider/actions/workflows/lint.yml)

[![Publish](https://github.com/yutotnh/word-divider/actions/workflows/publish.yml/badge.svg)](https://github.com/yutotnh/word-divider/actions/workflows/publish.yml)

[![Test](https://github.com/yutotnh/word-divider/actions/workflows/test.yml/badge.svg)](https://github.com/yutotnh/word-divider/actions/workflows/test.yml)

[![CodeQL](https://github.com/yutotnh/word-divider/actions/workflows/codeql.yml/badge.svg)](https://github.com/yutotnh/word-divider/actions/workflows/codeql.yml)

[![Create package](https://github.com/yutotnh/word-divider/actions/workflows/package.yml/badge.svg)](https://github.com/yutotnh/word-divider/actions/workflows/package.yml)

[![Dependency Review](https://github.com/yutotnh/word-divider/actions/workflows/dependency-review.yml/badge.svg)](https://github.com/yutotnh/word-divider/actions/workflows/dependency-review.yml)

[![Dev Containers](https://github.com/yutotnh/word-divider/actions/workflows/devcontainer.yml/badge.svg)](https://github.com/yutotnh/word-divider/actions/workflows/devcontainer.yml)

Enable cursor movement in Japanese and Chinese sentences on a word-by-word basis.

![examples](./docs/examples.gif)

## Features

| Command                              | Keybinding for Windows and Linux | Keybinding for Mac | Command to be overwritten | Description                      |

| ------------------------------------ | -------------------------------- | ------------------ | ------------------------- | -------------------------------- |

| wordDivider.cursorWordLeft           | `Ctrl`+`LeftArrow`               | `⌥` `←`            | cursorWordLeft            | Move cursor to the previous word |

| wordDivider.cursorWordEndRight       | `Ctrl`+`RightArrow`              | `⌥` `→`            | cursorWordEndRight        | Move cursor to the next word     |

| wordDivider.cursorWordLeftSelect     | `Ctrl`+`Shift`+`LeftArrow`       | `⇧` `⌥` `←`        | cursorWordLeftSelect      | Select the previous word         |

| wordDivider.cursorWordEndRightSelect | `Ctrl`+`Shift`+`RightArrow`      | `⇧` `⌥` `→`        | cursorWordEndRightSelect  | Select the next word             |

| wordDivider.deleteWordLeft           | `Ctrl`+`Backspace`               | `⌥` `Backspace`    | deleteWordLeft            | Remove the previous word         |

| wordDivider.deleteWordEndRight       | `Ctrl`+`Delete`                  | `⌥` `Delete`       | deleteWordRight           | Remove the next word             |

## Differences from Japanese Word Handler

This extension is inspired by [sgryjp/japanese-word-handler](https://github.com/sgryjp/japanese-word-handler).

Japanese Word Handler move based on character type, while Word Divider move based on word recognition.

### Using Word Handler

![examples](./docs/examples.gif)

### Using Japanese Word Handler

While Word Divider divides `拡張機能` into `拡張` and `機能`, and `使うと` into `使う` and `と`, we can see that the Japanese Word Handler treats `拡張機能` as `拡張機能` and `使うと` as `使` and `と`.

![Japanese Word Handler examples](./docs/examples-japanese-word-handler.gif)

## Extension Settings

- `wordDivider.locale`: The locale to use for word divider

  - `auto`: Use VS Code's configured display language (default)

  - `ja`: Japanese

  - `zh-CN`: Simplified Chinese

  - `zh-TW`: Traditional Chinese

## Known Issues

- Cannot double click to select a word. [#50](https://github.com/yutotnh/word-divider/issues/50)

- Cannot move word by word in SOURCE CONTROL message box. [#48](https://github.com/yutotnh/word-divider/issues/48)

## Release Notes

See [CHANGELOG.md](CHANGELOG.md)