Gathering detailed insights and metrics for textlint-rule-preset-japanese
Gathering detailed insights and metrics for textlint-rule-preset-japanese
Installations
npm install textlint-rule-preset-japaneseDeveloper
Developer Guide
BETA
Module System
CommonJS
Min. Node Version
Typescript Support
No
Node Version
18.19.0
NPM Version
10.2.3
Statistics
110 Stars
212 Commits
5 Forks
3 Watching
7 Branches
8 Contributors
Updated on 22 Nov 2024
Bundle Size
384.51 kB
Minified
110.27 kB
Minified + Gzipped
Languages
JavaScript (100%)
Total Downloads
Cumulative downloads
Total Downloads
690,767
Last day
9.3%
847
Compared to previous day
Last week
-36.9%
3,603
Compared to previous week
Last month
-8%
20,465
Compared to previous month
Last year
1.8%
184,155
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
14
@textlint-rule/textlint-rule-no-invalid-control-character@textlint/module-interoptextlint-rule-max-tentextlint-rule-no-double-negative-jatextlint-rule-no-doubled-conjunctiontextlint-rule-no-doubled-conjunctive-particle-gatextlint-rule-no-doubled-joshitextlint-rule-no-dropping-the-ratextlint-rule-no-kangxi-radicalstextlint-rule-no-mix-dearu-desumasutextlint-rule-no-nfdtextlint-rule-no-zero-width-spacestextlint-rule-prhtextlint-rule-sentence-length
Dev Dependencies
2
Versions
textlint-rule-preset-japanese 
textlint rule preset for Japanese.
日本語向けのtextlint ruleのpresetです。
目的
- 一般的な文書で利用するためのルール集
- 入れても誤検知が少ないルールに限定する
- 明らかな誤爆がある場合は、Issueを立ててください
- スタイル(スペースの有無など)に関連するルールは含めない
技術的な文章を書くためにより厳しいルールを求める方は次のプリセットを参照してください。
Installation
npmコマンドを使ってインストールできます。
npm install textlint-rule-preset-japanese
安定版は、半年(1月と7月)に一度更新されます。
次のように@nextをつけることで、次期バージョンをインストールして試せます。
安定版と次期バージョンの差分はVersion PackagesのPRで確認できます。
npm install textlint-rule-preset-japanese@next
このpresetは以下のルールを含んでいます。
- https://github.com/textlint-ja/textlint-rule-max-ten
- 一文で使える"、"の数
- https://github.com/takahashim/textlint-rule-no-doubled-conjunctive-particle-ga
- 逆接の接続助詞「が」が、同一文中に複数回出現していないかどうか
- https://github.com/takahashim/textlint-rule-no-doubled-conjunction
- 同じ接続詞で開始されていることを検出
- https://github.com/textlint-ja/textlint-rule-no-double-negative-ja
- 二重否定の検出
- https://github.com/textlint-ja/textlint-rule-no-doubled-joshi
- 二重助詞の検出
- https://github.com/azu/textlint-rule-sentence-length
- 一文の最大の長さ
- https://github.com/azu/textlint-rule-no-dropping-the-ra
- ら抜き言葉を使用しない
- https://github.com/textlint-ja/textlint-rule-no-mix-dearu-desumasu
- 文の敬体(ですます調)、常体(である調)の混合をチェック
- https://github.com/azu/textlint-rule-no-nfd
- ホ゜ケット エンシ゛ン のような、Mac OS XでPDFやFinderからのコピペで発生する濁点のチェック
- https://github.com/textlint-rule/textlint-rule-no-invalid-control-character
- 制御文字の検出
- https://github.com/textlint-rule/textlint-rule-no-zero-width-spaces
- ゼロ幅スペースの検出
- https://github.com/xl1/textlint-rule-no-kangxi-radicals
- 康煕部首の検出
Usage
Via .textlintrc
1{ 2 "rules": { 3 "preset-japanese": true 4 } 5}
Options
1{ 2 "rules": { 3 // それぞれのルールのデフォルト値 4 "preset-japanese": { 5 // https://github.com/textlint-ja/textlint-rule-max-ten 6 // 一文で使える"、"の数 7 "max-ten": { 8 "max": 3 9 }, 10 // https://github.com/takahashim/textlint-rule-no-doubled-conjunctive-particle-ga 11 // 逆接の接続助詞「が」が、同一文中に複数回出現していないかどうか 12 // e.g.) 今日は早朝から出発したが、定刻には間に合わなかったが、無事会場に到着した。 13 "no-doubled-conjunctive-particle-ga": true, 14 // https://github.com/takahashim/textlint-rule-no-doubled-conjunction 15 // 同じ接続詞が連続して出現していないかどうか 16 "no-doubled-conjunction": true, 17 // https://github.com/textlint-ja/textlint-rule-no-double-negative-ja 18 // 二重否定の検出 19 "no-double-negative-ja": true, 20 // https://github.com/textlint-ja/textlint-rule-no-doubled-joshi 21 // 二重助詞の検出 22 // 連続して同じ助詞が出た場合のみを検出 23 "no-doubled-joshi": { 24 "min_interval": 1 25 }, 26 // https://github.com/azu/textlint-rule-sentence-length 27 // 一文の最大の長さ 28 "sentence-length": { 29 "max": 100 30 }, 31 // https://github.com/textlint-ja/textlint-rule-no-dropping-the-ra 32 // ら抜き言葉を使用しない 33 "no-dropping-the-ra": true, 34 // https://github.com/azu/textlint-rule-no-mix-dearu-desumasu 35 // 文の敬体(ですます調)、常体(である調)のチェック 36 "no-mix-dearu-desumasu": true, 37 // https://github.com/azu/textlint-rule-no-nfd 38 // ホ゜ケット エンシ゛ン 39 // のような、Mac OS XでPDFやFinderからのコピペで発生する濁点のチェック 40 "no-nfd": true, 41 // https://github.com/textlint-rule/textlint-rule-no-invalid-control-character 42 // 制御文字の検出 43 "no-invalid-control-character": true, 44 // https://github.com/textlint-rule/textlint-rule-no-zero-width-spaces 45 // ゼロ幅スペースの検出 46 "no-zero-width-spaces": true, 47 // https://github.com/xl1/textlint-rule-no-kangxi-radicals 48 // 康煕部首の検出 49 "no-kangxi-radicals": true 50 } 51 } 52}
Semantic Versioning Policy
次のルールでバージョンが更新されます。
- Patch リリース
- 各ルールのバグ修正 (警告を減らす方向への修正)
- ドキュメントの改善
- 内部的な変更 (リファクタリングやテストの改善など)
- リリース失敗時の再リリース
- Minor リリース
- 各ルールのバグ修正 (警告を増やす方向への修正)
- 新オプションの追加
- 既存ルールの非推奨化
- Major リリース
- プリセットへのルールの追加
- プリセットからルールの削除
- 既存のオプション値の変更
textlint-rule-preset-japaneseは、6ヶ月ごとにmajorアップデートを行います。
更新内容はReleases pageを参照してください。
Community
質問は以下のGitterでお願いします。
その他のルール
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.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
3 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Reason
5 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 4
Reason
Found 1/12 approved changesets -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/prepare-release.yml:1
- Warn: topLevel 'contents' permission set to 'write': .github/workflows/release.yml:9
- Warn: no topLevel permission defined: .github/workflows/test.yml:1
- Warn: no topLevel permission defined: .github/workflows/website.yml:1
- Info: no jobLevel write permissions found
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/prepare-release.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/textlint-ja/textlint-rule-preset-japanese/prepare-release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/textlint-ja/textlint-rule-preset-japanese/release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/textlint-ja/textlint-rule-preset-japanese/release.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/textlint-ja/textlint-rule-preset-japanese/release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/textlint-ja/textlint-rule-preset-japanese/test.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/textlint-ja/textlint-rule-preset-japanese/test.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/website.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/textlint-ja/textlint-rule-preset-japanese/website.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/website.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/textlint-ja/textlint-rule-preset-japanese/website.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/website.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/textlint-ja/textlint-rule-preset-japanese/website.yml/master?enable=pin
- Info: 0 out of 6 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 3 third-party GitHubAction dependencies pinned
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 26 are checked with a SAST tool
Score
3.5
/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