@yuu1111/comment-check 2.1.0 → 2.2.1

package/README.ja.md

@@ -30,11 +30,18 @@ Checked 42 files: 1 new, 0 resolved, 3 baselined
 comment-check --enable japanese-period .
 ```
 
+複数行のcommentを直前の行へ続けず空行で区切るProjectは、もう一つのopt-inのruleを指定する
+
+```bash
+comment-check --enable cramped-comment .
+```
+
 ## Rules
 
 | Rule | 検出対象 |
 |------|---------|
 | `broad-suppression` | `biome-ignore-all`、`@ts-nocheck`、ruleを書いていない `eslint-disable` |
+| `cramped-comment` | 直前の行へ空行なしで続く複数行comment（opt-in） |
 | `undocumented-directive` | 説明の無い `@ts-ignore` と `@ts-expect-error` |
 | `placeholder-comment` | `TODO`、`FIXME`、`XXX`、`HACK` |
 | `separator-comment` | 記号だけで作った装飾comment |
@@ -49,11 +56,3 @@ comment-check --enable japanese-period .
 | `--ignore <path>` | 検査から外すpath 複数指定できる |
 | `--update-baseline` | baselineを現在の検出で置き換える |
 | `--json` | 新規と解消済みの検出をJSONで出力する |
-
-## Notes
-
-生成物のディレクトリなどProjectが持つpathは `--ignore` で検査から外す 例えば `--ignore src/generated`
-
-baselineはrule、file、comment本文をキーにするため、行が動いてもそのcommentを新規とは報告しない Biomeは `biome-ignore` の理由と未使用の抑制を既に扱うため、このcheckerはBiomeが読まないcommentの細部だけを担当する
-
-`japanese-period` は `--enable` で指定するまで動かないため、既存Projectの検出結果は変わらない 最初の `。` の位置を行と桁で報告し、句点が複数あっても1 commentにつき1件にまとめ、comment本文は書き換えない

package/README.md

@@ -32,11 +32,19 @@ opt-in rule:
 comment-check --enable japanese-period .
 ```
 
+A project that keeps a blank line before every multi-line comment names the
+other opt-in rule:
+
+```bash
+comment-check --enable cramped-comment .
+```
+
 ## Rules
 
 | Rule | Detects |
 |------|---------|
 | `broad-suppression` | `biome-ignore-all`, `@ts-nocheck`, and rule-less `eslint-disable` |
+| `cramped-comment` | a multi-line block comment written directly under the previous line (opt-in) |
 | `undocumented-directive` | `@ts-ignore` or `@ts-expect-error` without a description |
 | `placeholder-comment` | `TODO`, `FIXME`, `XXX`, `HACK` |
 | `separator-comment` | decorative comments made only of punctuation |
@@ -51,18 +59,3 @@ comment-check --enable japanese-period .
 | `--ignore <path>` | Path to leave out, repeatable |
 | `--update-baseline` | Replace the baseline with the current findings |
 | `--json` | Print new and resolved findings as JSON |
-
-## Notes
-
-Generated directories and other paths that the project owns stay out of the
-check through `--ignore`, for example `--ignore src/generated`.
-
-The baseline keys on the rule, the file, and the comment text, so moving a line
-does not report the comment as new. Biome already requires a reason on
-`biome-ignore` and reports unused suppressions, so this checker only covers the
-comment trivia that Biome does not read.
-
-`japanese-period` stays off until `--enable` names it, so an existing project
-keeps the findings it had. The rule reports the first `。` of a comment at its
-own line and column, reports one finding per comment however many periods it
-holds, and never rewrites the comment.

package/bin/cli.js

@@ -0,0 +1,4 @@
+#!/usr/bin/env bun
+import { run } from "../dist/cli.js";
+
+run();

package/dist/cli.js

@@ -286,11 +286,13 @@ function extractComments(source) {
 }
 
 // src/rules.ts
-var OPT_IN_RULE_IDS = ["japanese-period"];
+var OPT_IN_RULE_IDS = ["cramped-comment", "japanese-period"];
 var PLACEHOLDER_PATTERN = /\b(TODO|FIXME|XXX|HACK)\b/;
 var SEPARATOR_PATTERN = /^[-=*_#~+./\\|]{4,}$/;
 var DIRECTIVE_PATTERN = /^@ts-(?:ignore|expect-error)\b([\s\S]*)$/;
 var JAPANESE_PERIOD = "\u3002";
+var BLOCK_OPENER = /(?:=>|[{(,[])\s*$/;
+var COMMENT_CONTINUATION = /^(?:\/\/|\*|\/\*)/;
 function parseEnabledRules(values) {
   const enabled = [];
   for (const value of values) {
@@ -307,6 +309,21 @@ function parseEnabledRules(values) {
 function findJapanesePeriod(text) {
   return text.indexOf(JAPANESE_PERIOD);
 }
+function isCrampedComment(source, start) {
+  const lineStart = source.lastIndexOf(`
+`, start - 1) + 1;
+  if (lineStart === 0 || source.slice(lineStart, start).trim() !== "") {
+    return false;
+  }
+  const previousEnd = lineStart - 1;
+  const previousStart = source.lastIndexOf(`
+`, previousEnd - 1) + 1;
+  const previous = source.slice(previousStart, previousEnd).trim();
+  if (previous === "" || previous.endsWith("*/")) {
+    return false;
+  }
+  return !(COMMENT_CONTINUATION.test(previous) || BLOCK_OPENER.test(previous));
+}
 function normalizeComment(body) {
   return body.split(`
 `).map((line) => line.replace(/^\s*\*+\s?/, "")).join(" ").replace(/\s+/g, " ").trim();
@@ -370,6 +387,17 @@ function scanSource(source, file, enabled = []) {
         text
       });
     }
+    if (enabled.includes("cramped-comment") && comment.kind === "block" && source.slice(comment.start, comment.end).includes(`
+`) && isCrampedComment(source, comment.start)) {
+      const position2 = positionAt(source, comment.start);
+      findings.push({
+        column: position2.column,
+        file,
+        line: position2.line,
+        rule: "cramped-comment",
+        text
+      });
+    }
     if (!enabled.includes("japanese-period")) {
       continue;
     }
@@ -564,6 +592,7 @@ function runCli(main) {
 var DEFAULT_BASELINE = "comment-baseline.json";
 var RULE_MESSAGES = {
   "broad-suppression": "file-wide suppression hides too much",
+  "cramped-comment": "a multi-line comment needs a blank line before it",
   "japanese-period": "a Japanese sentence in a comment does not end with a period",
   "placeholder-comment": "placeholder comment should be resolved or tracked",
   "separator-comment": "decorative separator comment adds no information",
@@ -618,10 +647,14 @@ function main(argv) {
   }
   return comparison.added.length > 0 ? 1 : 0;
 }
-if (import.meta.main) {
+function run() {
   runCli(main);
 }
+if (import.meta.main) {
+  run();
+}
 export {
+  run,
   parseArguments,
   main
 };

package/dist/scan.js

@@ -284,11 +284,13 @@ function extractComments(source) {
 }
 
 // src/rules.ts
-var OPT_IN_RULE_IDS = ["japanese-period"];
+var OPT_IN_RULE_IDS = ["cramped-comment", "japanese-period"];
 var PLACEHOLDER_PATTERN = /\b(TODO|FIXME|XXX|HACK)\b/;
 var SEPARATOR_PATTERN = /^[-=*_#~+./\\|]{4,}$/;
 var DIRECTIVE_PATTERN = /^@ts-(?:ignore|expect-error)\b([\s\S]*)$/;
 var JAPANESE_PERIOD = "\u3002";
+var BLOCK_OPENER = /(?:=>|[{(,[])\s*$/;
+var COMMENT_CONTINUATION = /^(?:\/\/|\*|\/\*)/;
 function parseEnabledRules(values) {
   const enabled = [];
   for (const value of values) {
@@ -305,6 +307,21 @@ function parseEnabledRules(values) {
 function findJapanesePeriod(text) {
   return text.indexOf(JAPANESE_PERIOD);
 }
+function isCrampedComment(source, start) {
+  const lineStart = source.lastIndexOf(`
+`, start - 1) + 1;
+  if (lineStart === 0 || source.slice(lineStart, start).trim() !== "") {
+    return false;
+  }
+  const previousEnd = lineStart - 1;
+  const previousStart = source.lastIndexOf(`
+`, previousEnd - 1) + 1;
+  const previous = source.slice(previousStart, previousEnd).trim();
+  if (previous === "" || previous.endsWith("*/")) {
+    return false;
+  }
+  return !(COMMENT_CONTINUATION.test(previous) || BLOCK_OPENER.test(previous));
+}
 function normalizeComment(body) {
   return body.split(`
 `).map((line) => line.replace(/^\s*\*+\s?/, "")).join(" ").replace(/\s+/g, " ").trim();
@@ -368,6 +385,17 @@ function scanSource(source, file, enabled = []) {
         text
       });
     }
+    if (enabled.includes("cramped-comment") && comment.kind === "block" && source.slice(comment.start, comment.end).includes(`
+`) && isCrampedComment(source, comment.start)) {
+      const position2 = positionAt(source, comment.start);
+      findings.push({
+        column: position2.column,
+        file,
+        line: position2.line,
+        rule: "cramped-comment",
+        text
+      });
+    }
     if (!enabled.includes("japanese-period")) {
       continue;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@yuu1111/comment-check",
-	"version": "2.1.0",
+	"version": "2.2.1",
 	"description": "Shared comment and suppression checker",
 	"repository": {
 		"type": "git",
@@ -9,13 +9,14 @@
 	},
 	"type": "module",
 	"bin": {
-		"comment-check": "dist/cli.js"
+		"comment-check": "bin/cli.js"
 	},
 	"exports": {
 		".": "./dist/scan.js"
 	},
 	"files": [
 		"README.ja.md",
+		"bin",
 		"dist"
 	],
 	"scripts": {