Installations

npm install textlint-rule-ja-space-around-code

Score

94.6

Supply Chain

98.5

Quality

83.3

Maintenance

100

Vulnerability

99.3

License

Pull Requests

Open

1

Total

66

Closed

7

Merged

58

Issues

Open

2

Total

12

Closed

10

Releases

14

v2.4.3

Published on 26 Apr 2024

v2.4.2

Published on 24 Apr 2024

v2.4.1

Published on 20 Apr 2024

v2.4.0

Published on 20 Apr 2024

v2.3.1

Published on 10 Mar 2024

v2.3.0

Published on 23 Jan 2023

View all 14 releases

Contributors

12

View all 12 contributors

Developer

textlint-ja

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

No

Node Version

20.12.0

NPM Version

lerna/7.1.4/node@v20.12.0+arm64 (darwin)

Statistics

73 Stars

155 Commits

14 Forks

4 Watching

4 Branches

12 Contributors

Updated on 30 Oct 2024

Bundle Size

1.15 kB

Minified

621.00 B

Minified + Gzipped

Bundlephobia

Languages

JavaScript (99.93%)

Shell (0.07%)

Total Downloads

Cumulative downloads

Total Downloads

2,616,141

Last day

32.9%

5,599

Compared to previous day

Last week

5.5%

23,769

Compared to previous week

Last month

14.6%

104,066

Compared to previous month

Last year

27.5%

928,226

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

2

match-index textlint-rule-helper

Dev Dependencies

1

textlint-scripts

Versions

textlint-rule-preset-ja-spacing

textlintのスペース関連のmonorepoです。

日本語周りにおけるスペースの有無を決定するtextlintルールプリセットを提供します。

textlint-rule-preset-ja-spacing

Demo

Visit playground:

https://textlint-ja.github.io/textlint-rule-preset-ja-spacing/

Install

Install with npm:

npm install textlint-rule-preset-ja-spacing

Usage

Via .textlintrc(Recommended)

1{
2    "rules": {
3        "preset-ja-spacing": true
4    }
5}

Via CLI

textlint --preset preset-ja-spacing README.md

それぞれのルールは個別のモジュールであるため、必要なルールのみをインストールすることも可能です。

ルール一覧

textlint-rule-ja-space-between-half-and-full-width

半角文字と全角文字の間にスペースを入れるかどうかのルール。デフォルトでは、スペースを入れません。

textlint-rule-ja-no-space-between-full-width

全角文字同士の間のスペースについてのtextlintルール。デフォルトでは、全角文字どうしの間にスペースを入れません。

textlint-rule-ja-nakaguro-or-halfwidth-space-between-katakana

カタカナ語間の区切り文字についてのtextlintルール。カタカナ語間は中黒または半角スペースを用いてカタカナ語を区切ります。

textlint-rule-ja-no-space-around-parentheses

かっこの外側、内側ともにスペースを入れないようにするルール

textlint-rule-ja-space-after-exclamation

文末に感嘆符を使用し、後に別の文が続く場合は、直後に全角スペースを挿入します。文中に感嘆符を使用する場合はスペースを挿入しません

textlint-rule-ja-space-after-question

文末に疑問符を使用し、後に別の文が続く場合は、直後に全角スペースを挿入します。文中に疑問符を使用する場合はスペースを挿入しません。

textlint-rule-ja-space-around-code

インラインコードの周りをスペースで囲むかどうかを決めるルール。デフォルトでは、インラインコードの周りをスペースで囲みません。

textlint-rule-ja-space-around-link

リンクの周りをスペースで囲むかどうかを決めるルール。デフォルトでは、リンクの周りをスペースで囲みません。

デフォルト設定

デフォルトでは、次のような設定になっています。

1{
2    "rules": {
3        "preset-ja-spacing": {
4             "ja-nakaguro-or-halfwidth-space-between-katakana": true,
5             "ja-no-space-around-parentheses": true,
6             "ja-no-space-between-full-width": true,
7             "ja-space-between-half-and-full-width": {
8                 "space": "never"
9             },
10             "ja-space-after-exclamation": true,
11             "ja-space-after-question": true,
12             "ja-space-around-code": false,
13             "ja-space-around-link": false
14         }
15    }
16}

またデフォルトでは、次のルールは無効の状態でプリセットに含まれています。

次のように設定することで、ルールを有効にできます。ルールのオプションについての詳細はそれぞれのパッケージのREADMEを参照してください。

1{
2    "rules": {
3        "preset-ja-spacing": {
4            "ja-space-around-code": true,
5            "ja-space-around-link": true
6        }
7    }
8}

開発フロー

packagesに作成ルール名でディレクトリを作成
作成したディレクトリに通常のnpmモジュール作成と同一のフローで作成

その後、packages全体について操作したい場合はlernaを使います。

次のコマンドでmonorepoの依存をインストール。

yarn install

textlint-rule-preset-ja-spacingのテストは事前に全てのパッケージのビルドが必要です。次のコマンドで全てのパッケージをビルドします。

yarn run build

Tests

以下のコマンドで全てのルールのテストを実行できます。

yarn test

Contributing

Fork it!
Create your feature branch: git checkout -b my-new-feature
Commit your changes: git commit -am 'Add some feature'
Push to the branch: git push origin my-new-feature
Submit a pull request :D

License

MIT

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

6

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

5

Maintained

Determines if the project is "actively maintained".

3

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

Score

3.8

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More