latexlint 0.0.0-stage → 2.0.0

package/CLI.md

@@ -0,0 +1,146 @@
+# CLI
+
+English | [日本語](CLI_ja.md)
+
+LaTeX Lint integrates with pre-commit and CI.
+Node.js 22 or later and npm are required.
+
+## Installation
+
+Install with npm.
+
+Windows (PowerShell):
+
+```powershell
+npm.cmd install --save-dev latexlint
+```
+
+macOS and Linux:
+
+```sh
+npm install --save-dev latexlint
+```
+
+The remaining examples use `npm` for macOS and Linux.
+On Windows, use `npm.cmd` instead.
+
+## Checking and fixing
+
+The CLI primarily checks files; automatic fixes currently cover only the
+`LLSpaceJapanese` rule.
+
+If `paper.tex` and `notes.md` are the files you want to check, run:
+
+```sh
+npm exec -- latexlint paper.tex notes.md
+```
+
+This runs `latexlint` against both files and reports diagnostics
+as `file:line:column rule message`.
+
+You can also pass directories or quoted glob patterns instead of file names:
+
+```sh
+npm exec -- latexlint "src/**/*.tex" "docs/**/*.md"
+```
+
+### Options
+
+The options for `npm exec -- latexlint` are listed below.
+
+| Option | Meaning |
+| --- | --- |
+| `-c, --config FILE` | Read [JSON settings](#json-settings); default: `.latexlint.json` in cwd. |
+| `-f, --fix` | Fix active `LLSpaceJapanese` diagnostics in place and recheck. |
+| `--enable RULE...` | Enable extra rules; use `--` before file names. |
+| `--disable RULE...` | Disable rules; overrides settings and `--enable`. |
+| `-i, --ignore PATTERN` | Exclude a file, directory, or glob; repeatable. |
+| `-p, --ignore-path FILE` | Read [exclusions](#exclusions); default: `.latexlintignore`. |
+| `-d, --dot` | Discover names starting with `.`, such as `.a.tex`. |
+| `-q, --quiet` | Hide diagnostics; preserve exit status and execution errors. |
+| `-V, --version` | Show the version. |
+| `-h, --help` | Show help. |
+
+For `RULE`, use a rule name from the
+[rule list](https://github.com/HirokiHamaguchi/latexlint/blob/master/README.md#rules).
+
+`--fix` alone does not enable rules.
+To enable and fix Japanese spacing, the only rule with automatic fixes:
+
+```sh
+npm exec -- latexlint --fix --enable LLSpaceJapanese -- paper.tex notes.md
+```
+
+### Exit codes
+
+Exit codes follow
+[markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli#exit-codes),
+except that codes `2` and `3` are not currently used.
+
+| Exit code | Meaning |
+| --- | --- |
+| `0` | No active diagnostics remain. |
+| `1` | Active diagnostics remain, including Information diagnostics. |
+| `4` | Argument, configuration, file I/O, or other execution error. |
+
+## Configuration
+
+### JSON settings
+
+Place `.latexlint.json` in the working directory to customize settings.
+
+To always enable `LLSpaceJapanese`, which is disabled by default:
+
+```json
+{
+  "LLSpaceJapanese": true
+}
+```
+
+Set it to `false` to disable it. You can also use `"default": false` to disable
+all rules before enabling individual rules.
+
+### Exclusions
+
+Use `.latexlintignore` for gitignore-style exclusions.
+Patterns are relative to the working directory. To exclude TeX and Markdown
+files under `node_modules/` and `build/`:
+
+```gitignore
+node_modules/
+build/
+```
+
+## pre-commit
+
+pre-commit provides hooks that automatically check or fix files before a Git
+commit. LaTeX Lint can be used as a pre-commit Node hook.
+
+[Install pre-commit](https://pre-commit.com/#installation) and add the following
+to your project's `.pre-commit-config.yaml`:
+
+```yaml
+repos:
+  - repo: https://github.com/HirokiHamaguchi/latexlint
+    rev: REVISION
+    hooks:
+      - id: latexlint
+```
+
+Replace `REVISION` with the tag for the version you want to use (2.0.0 or later)
+from the [published tags](https://github.com/HirokiHamaguchi/latexlint/tags).
+To also fix files, replace the hook entry with:
+
+```yaml
+      - id: latexlint-fix
+        args: ["--enable", "LLSpaceJapanese", "--"]
+```
+
+Both hooks check `.tex` and `.md` files and use the same project configuration.
+
+Enable checks at commit time on Windows, macOS, or Linux with:
+
+```sh
+pre-commit install
+pre-commit run --all-files
+```

package/CLI_ja.md

@@ -0,0 +1,137 @@
+# CLI版
+
+[English](CLI.md) | 日本語
+
+LaTeX Lintはpre-commitやCIに組み込めます。
+Node.js 22以降とnpmが必要です。
+
+## 導入
+
+npmでインストールします。
+
+Windows (PowerShell):
+
+```powershell
+npm.cmd install --save-dev latexlint
+```
+
+macOS・Linux:
+
+```sh
+npm install --save-dev latexlint
+```
+
+以降ではmacOS・Linux向けの表記として`npm`を使います。
+Windowsでは`npm.cmd`に置き換えて下さい。
+
+## 検査と修正
+
+現状のCLI版では、検査を主機能とし、修正は`LLSpaceJapanese`ルールのみに限定しています。
+
+`paper.tex`と`notes.md`を校正したいファイルとするとき、以下を実行します:
+
+```sh
+npm exec -- latexlint paper.tex notes.md
+```
+
+これは、`latexlint`で両ファイルを検査し、指摘を`ファイル名:行:列 ルール名 メッセージ`の形式で表示するコマンドです。
+
+また、ファイル名の代わりにディレクトリや引用符で囲んだglobも指定できます。例えば、次のように出来ます:
+
+```sh
+npm exec -- latexlint "src/**/*.tex" "docs/**/*.md"
+```
+
+### オプション
+
+`npm exec -- latexlint`のオプションは次の通りです。
+
+| オプション | 意味 |
+| --- | --- |
+| `-c, --config FILE` | 読み込む[JSON設定](#json設定)を指定する。既定は作業ディレクトリの`.latexlint.json`。 |
+| `-f, --fix` | 有効な`LLSpaceJapanese`の指摘をファイルに修正し、再検査する。 |
+| `--enable RULE...` | 指定ルールを追加で有効にする。ファイル名の前を`--`で区切る。 |
+| `--disable RULE...` | 指定ルールを無効にする。設定ファイルや`--enable`より優先する。 |
+| `-i, --ignore PATTERN` | ファイル・ディレクトリ・globを除外する。繰り返し指定できる。 |
+| `-p, --ignore-path FILE` | [除外ファイル](#除外設定)を指定する。既定は`.latexlintignore`。 |
+| `-d, --dot` | 探索時に`.`で始まるファイル・ディレクトリ(`.a.tex`など)も含める。 |
+| `-q, --quiet` | 指摘の表示を抑える。終了コードと実行エラーの表示は維持する。 |
+| `-V, --version` | バージョンを表示する。 |
+| `-h, --help` | ヘルプを表示する。 |
+
+`RULE`には[ルール一覧](https://github.com/HirokiHamaguchi/latexlint/blob/master/README_ja.md#ルール)にあるルール名を指定します。
+
+なお、`--fix`だけではルールは有効になりません。
+現状唯一存在する、日本語空白を有効にして修正する例は、以下の通りです:
+
+```sh
+npm exec -- latexlint --fix --enable LLSpaceJapanese -- paper.tex notes.md
+```
+
+### 終了コード
+
+[markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli#exit-codes)の仕様に合わせて終了コードを返します。ただし、2,3は現状ありません。
+
+| 終了コード | 意味 |
+| --- | --- |
+| `0` | 有効な指摘が残っていない。 |
+| `1` | 有効な指摘が残っている。Informationも含む。 |
+| `4` | 引数・設定・読み書きなどの実行エラー。 |
+
+## 設定
+
+### JSON設定
+
+作業ディレクトリに`.latexlint.json`を置くことで、設定をカスタマイズできます。
+既定では無効の`LLSpaceJapanese`を常に有効にするには、次のようにします:
+
+```json
+{
+  "LLSpaceJapanese": true
+}
+```
+
+`false`にすると無効になります。`"default": false`ですべてのルールを無効にしてから、個別に有効化することもできます。
+
+### 除外設定
+
+`.latexlintignore`にはgitignore形式で除外対象を記述できます。
+パターンは作業ディレクトリが基準で、`node_modules/`や`build/`以下のtex・mdファイルを除外する場合は、次のようにします:
+
+```gitignore
+node_modules/
+build/
+```
+
+## pre-commit
+
+pre-commitは、gitのコミット前に自動で検査・修正を行うフックを提供するツールです。
+LaTeX Lintも、pre-commitのNodeフックとして利用できます。
+
+[pre-commitを導入](https://pre-commit.com/#installation)し、プロジェクトの`.pre-commit-config.yaml`へ次を追加します。
+
+```yaml
+repos:
+  - repo: https://github.com/HirokiHamaguchi/latexlint
+    rev: REVISION
+    hooks:
+      - id: latexlint
+```
+
+`REVISION`には、利用するバージョン(2.0.0以降)のタグを
+[公開タグ一覧](https://github.com/HirokiHamaguchi/latexlint/tags)から指定します。
+修正もしたい場合は、フックの指定を次に置き換えます:
+
+```yaml
+      - id: latexlint-fix
+        args: ["--enable", "LLSpaceJapanese", "--"]
+```
+
+どちらのフックも`.tex`・`.md`を対象とし、同じプロジェクト設定を使います。
+
+Windows・macOS・Linuxのいずれも、次のコマンドでコミット時の実行を設定できます。
+
+```sh
+pre-commit install
+pre-commit run --all-files
+```

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Hiroki Hamaguchi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.