@tai-kun/vp-lint-plugins 0.0.4 → 0.0.6

package/dist/src/rules/overload-signatures-adjacent.js

@@ -1,5 +1,5 @@
 import { defineRule } from "vite-plus/lint/plugins";
-import { getNextStatement, getRemoveBlankLineFix } from "./blank-line.js";
+import { getNextStatement, getRemoveBlankLineFix } from "./_blank-line-utils.js";
 function getFunction(node) {
     if (node.type === "FunctionDeclaration" || node.type === "TSDeclareFunction") {
         return node;

package/dist/src/rules/sort-import-export-specifiers.js

@@ -1,5 +1,5 @@
 import { defineRule } from "vite-plus/lint/plugins";
-import { compareNames } from "./object-sort-utils.js";
+import { compareNames } from "./_object-sort-utils.js";
 function getSpecifierName(node) {
     if (node.type === "Identifier") {
         return node.name;

package/dist/src/rules/sort-jsx-props.js

@@ -1,5 +1,5 @@
 import { defineRule } from "vite-plus/lint/plugins";
-import { compareNames } from "./object-sort-utils.js";
+import { compareNames } from "./_object-sort-utils.js";
 function isNamedAttribute(attribute) {
     return attribute.type === "JSXAttribute" && attribute.name.type === "JSXIdentifier";
 }

package/dist/src/rules/sort-object-properties.js

@@ -1,5 +1,5 @@
 import { defineRule } from "vite-plus/lint/plugins";
-import { getSortPlan } from "./object-sort-utils.js";
+import { getSortPlan } from "./_object-sort-utils.js";
 /**
  * オブジェクトリテラルのプロパティーを、名前の長さが短い順、同じ長さなら名前順に並べます。
  *

package/dist/src/rules/sort-type-members.js

@@ -1,5 +1,5 @@
 import { defineRule } from "vite-plus/lint/plugins";
-import { compareNames } from "./object-sort-utils.js";
+import { compareNames } from "./_object-sort-utils.js";
 function getLineStarts(text) {
     const starts = [0];
     for (let index = 0; index < text.length; index += 1) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tai-kun/vp-lint-plugins",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "description": "",
   "homepage": "https://tai-kun.github.io/vp-lint-plugins/",
   "license": "MIT",

package/src/index.ts

@@ -1,9 +1,4 @@
-export { default as blankLineAfterControlBlock } from "./rules/blank-line-after-control-block.js";
-export { default as blankLineAfterDeclaration } from "./rules/blank-line-after-declaration.js";
-export { default as blankLineAfterVariableDeclaration } from "./rules/blank-line-after-variable-declaration.js";
-export { default as blankLineBeforeReturn } from "./rules/blank-line-before-return.js";
-export { default as blankLineBetweenClassMembers } from "./rules/blank-line-between-class-members.js";
-export { default as blankLineBetweenSwitchCases } from "./rules/blank-line-between-switch-cases.js";
+export { default as blankLine } from "./rules/blank-line.js";
 export { default as commentJapaneseSpacing } from "./rules/comment-japanese-spacing.js";
 export { default as commentOneSentencePerLine } from "./rules/comment-one-sentence-per-line.js";
 export { default as jsdocParamOrder } from "./rules/jsdoc-param-order.js";

package/src/plugin.ts

@@ -1,11 +1,6 @@
 import { definePlugin } from "vite-plus/lint/plugins";
 
-import blankLineAfterControlBlock from "./rules/blank-line-after-control-block.js";
-import blankLineAfterDeclaration from "./rules/blank-line-after-declaration.js";
-import blankLineAfterVariableDeclaration from "./rules/blank-line-after-variable-declaration.js";
-import blankLineBeforeReturn from "./rules/blank-line-before-return.js";
-import blankLineBetweenClassMembers from "./rules/blank-line-between-class-members.js";
-import blankLineBetweenSwitchCases from "./rules/blank-line-between-switch-cases.js";
+import blankLine from "./rules/blank-line.js";
 import commentJapaneseSpacing from "./rules/comment-japanese-spacing.js";
 import commentOneSentencePerLine from "./rules/comment-one-sentence-per-line.js";
 import jsdocParamOrder from "./rules/jsdoc-param-order.js";
@@ -25,6 +20,7 @@ import typeLiteralPropertiesNewline from "./rules/type-literal-properties-newlin
 export default definePlugin({
   meta: { name: "tai-kun" },
   rules: {
+    "blank-line": blankLine,
     "merge-imports": mergeImports,
     "sort-jsx-props": sortJsxProps,
     "spaced-comment": spacedComment,
@@ -34,17 +30,11 @@ export default definePlugin({
     "jsdoc-param-order": jsdocParamOrder,
     "sort-type-members": sortTypeMembers,
     "sort-object-properties": sortObjectProperties,
-    "blank-line-before-return": blankLineBeforeReturn,
     "comment-japanese-spacing": commentJapaneseSpacing,
     "object-properties-newline": objectPropertiesNewline,
-    "blank-line-after-declaration": blankLineAfterDeclaration,
     "overload-signatures-adjacent": overloadSignaturesAdjacent,
     "comment-one-sentence-per-line": commentOneSentencePerLine,
     "sort-import-export-specifiers": sortImportExportSpecifiers,
-    "blank-line-after-control-block": blankLineAfterControlBlock,
-    "blank-line-between-switch-cases": blankLineBetweenSwitchCases,
     "type-literal-properties-newline": typeLiteralPropertiesNewline,
-    "blank-line-between-class-members": blankLineBetweenClassMembers,
-    "blank-line-after-variable-declaration": blankLineAfterVariableDeclaration,
   },
 });

package/src/rules/_blank-line-utils.ts

@@ -0,0 +1,165 @@
+import type { Fix, Fixer, ESTree, Comment, SourceCode } from "vite-plus/lint/plugins";
+
+/**
+ * 文の配列を持つ親から、その文が属する配列を取得します。
+ */
+function getStatementBody(node: ESTree.Node): readonly ESTree.Node[] | null {
+  const { parent } = node;
+
+  if (parent === null) {
+    return null;
+  }
+
+  if (
+    parent.type === "Program" ||
+    parent.type === "BlockStatement" ||
+    parent.type === "StaticBlock" ||
+    parent.type === "TSModuleBlock"
+  ) {
+    return parent.body;
+  }
+
+  if (parent.type === "SwitchCase") {
+    return parent.consequent;
+  }
+
+  return null;
+}
+
+function getNextStatement(node: ESTree.Node): ESTree.Node | null {
+  const body = getStatementBody(node);
+
+  if (body === null) {
+    return null;
+  }
+
+  const index = body.indexOf(node);
+
+  if (index === -1 || index === body.length - 1) {
+    return null;
+  }
+
+  return body[index + 1] ?? null;
+}
+
+function getPreviousStatement(node: ESTree.Node): ESTree.Node | null {
+  const body = getStatementBody(node);
+
+  if (body === null) {
+    return null;
+  }
+
+  const index = body.indexOf(node);
+
+  if (index <= 0) {
+    return null;
+  }
+
+  return body[index - 1] ?? null;
+}
+
+/**
+ * 空行の挿入位置を返します。
+ *
+ * 次の文に付くコメントがある場合は、そのコメントの前を挿入位置にします。
+ * 同じ行の末尾コメントは対象外です。
+ */
+function getInsertionTarget(
+  node: ESTree.Node,
+  nextStatement: ESTree.Node,
+  sourceCode: SourceCode,
+): ESTree.Node | Comment {
+  return (
+    sourceCode
+      .getAllComments()
+      .find(
+        (comment) =>
+          comment.range[0] >= node.range[1] &&
+          comment.range[1] <= nextStatement.range[0] &&
+          comment.loc.start.line > node.loc.end.line,
+      ) ?? nextStatement
+  );
+}
+
+function hasBlankLine(node: ESTree.Node, target: ESTree.Node | Comment): boolean {
+  return target.loc.start.line > node.loc.end.line + 1;
+}
+
+/**
+ * 挿入対象がコメントかどうかを返します。
+ *
+ * コメントを挟む場合、前後の空行は任意とします。
+ */
+function isComment(target: ESTree.Node | Comment): target is Comment {
+  const { type } = target as { type: string };
+
+  return type === "Line" || type === "Block" || type === "Shebang";
+}
+
+/**
+ * JSDoc 形式のブロックコメント（`/**` で始まる）かどうかを返します。
+ *
+ * JSDoc 形式のブロックコメントの 1 行上は空行にします。
+ */
+function isDocComment(target: ESTree.Node | Comment): target is Comment {
+  return isComment(target) && target.type === "Block" && target.value.startsWith("*");
+}
+
+function getBlankLineFix(
+  fixer: Fixer,
+  sourceCode: SourceCode,
+  node: ESTree.Node,
+  target: ESTree.Node | Comment,
+): Fix | null {
+  if (target.loc.start.line === node.loc.end.line) {
+    return fixer.insertTextAfterRange([node.range[1], node.range[1]], "\n\n");
+  }
+
+  const lineEnd = sourceCode.text.indexOf("\n", node.range[1]);
+
+  if (lineEnd === -1) {
+    return null;
+  }
+
+  return fixer.insertTextBeforeRange([lineEnd, lineEnd + 1], "\n");
+}
+
+/**
+ * 指定したノードと対象の間の空行を削除します。
+ */
+function getRemoveBlankLineFix(
+  fixer: Fixer,
+  sourceCode: SourceCode,
+  node: ESTree.Node,
+  target: ESTree.Node | Comment,
+): Fix | null {
+  if (target.loc.start.line <= node.loc.end.line + 1) {
+    return null;
+  }
+
+  const fromLineEnd = sourceCode.text.indexOf("\n", node.range[1]);
+
+  if (fromLineEnd === -1) {
+    return null;
+  }
+
+  const targetLineStart = sourceCode.text.lastIndexOf("\n", target.range[0]) + 1;
+  const indent = sourceCode.text.slice(targetLineStart, target.range[0]);
+
+  if (indent.trim() !== "") {
+    return null;
+  }
+
+  return fixer.replaceTextRange([fromLineEnd, target.range[0]], `\n${indent}`);
+}
+
+export {
+  isComment,
+  hasBlankLine,
+  isDocComment,
+  getBlankLineFix,
+  getNextStatement,
+  getInsertionTarget,
+  getPreviousStatement,
+  getRemoveBlankLineFix,
+};

package/src/rules/{comment-utils.ts → _comment-utils.ts}

@@ -8,7 +8,8 @@ interface CommentLine {
   start: number;
 }
 
-const SENTENCE_END = /[。．.!?！？]$/u;
+// ラベル行とは別に、閉じ括弧付きのコロン終わりも文末とします。
+const SENTENCE_END = /[。．.!?！？:：]$/u;
 const TRAILING_CLOSERS = /[」』】）》）〕〉］｝"'”’]+$/u;
 const DIRECTIVE_PREFIXES = [
   "#!",

package/src/rules/{jsdoc-utils.ts → _jsdoc-utils.ts}

@@ -1,6 +1,6 @@
 import type { ESTree, Comment, SourceCode } from "vite-plus/lint/plugins";
 
-import { isFence } from "./comment-utils.js";
+import { isFence } from "./_comment-utils.js";
 
 interface JSDocLine {
   content: string;