@zgeoff/oxlint-config 0.0.3 → 0.0.4

package/README.md

@@ -2,9 +2,10 @@
 
 Shareable [oxlint](https://oxc.rs/docs/guide/usage/linter.html) config: every category at `error`,
 restriction-rule cherry-picks, comment-style enforcement via `@stylistic`, and a bundled JS plugin
-(`zgeoff/*` rules) banning AST shapes no native oxlint rule can express — top-level arrows, nested
+(`zgeoff/*` rules) banning shapes no native oxlint rule can express — top-level arrows, nested
 function declarations, bare named exports, destructured and inline-typed parameters, ternary and
-await arguments, and awaits hidden inside a control-flow condition or a `&&`/`||`/`??` chain.
+await arguments, awaits hidden inside a control-flow condition or a `&&`/`||`/`??` chain, and
+single-line `/** … */` blocks (auto-fixed to multi-line; inline `@type`/`@lends` casts exempt).
 
 ## Usage
 

package/oxlintrc.json

@@ -25,6 +25,7 @@
     "zgeoff/no-await-args": "error",
     "zgeoff/no-await-in-condition": "error",
     "zgeoff/no-await-in-logical": "error",
+    "zgeoff/no-single-line-jsdoc": "error",
 
     // enforced comment style — line comments unless JSDoc or exclamation
     "@stylistic/multiline-comment-style": [
@@ -142,8 +143,9 @@
     {
       "files": ["**/*.js", "**/*.cjs", "**/*.mjs"],
       // untyped JS is `any` end to end, so the unsafe-* rules flag every
-      // expression
+      // expression and strict-boolean-expressions every conditional
       "rules": {
+        "typescript/strict-boolean-expressions": "off",
         "typescript/no-unsafe-argument": "off",
         "typescript/no-unsafe-assignment": "off",
         "typescript/no-unsafe-call": "off",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zgeoff/oxlint-config",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "Shareable oxlint config: strict categories, house-style rules, and a custom JS plugin",
   "license": "MIT",
   "repository": {
@@ -22,9 +22,16 @@
   "publishConfig": {
     "access": "public"
   },
+  "scripts": {
+    "typecheck": "tsc"
+  },
   "dependencies": {
     "@stylistic/eslint-plugin": "5.10.0"
   },
+  "devDependencies": {
+    "@types/bun": "1.3.14",
+    "typescript": "7.0.1-rc"
+  },
   "peerDependencies": {
     "oxlint": ">=1.71.0"
   }

package/plugin.js

@@ -1,6 +1,7 @@
 // Custom lint rules, loaded through oxlint's jsPlugins (ESLint v9 rule API).
-// Each rule bans an AST shape that no native oxlint rule can express, using
-// esquery selectors.
+// Each rule bans a shape no native oxlint rule can express — esquery selectors
+// for AST shapes, a source-comment scan where the target isn't
+// esquery-selectable.
 
 function banSelectors(type, message, selectors) {
   return {
@@ -16,6 +17,82 @@ function banSelectors(type, message, selectors) {
   };
 }
 
+// mirrors eslint-plugin-jsdoc's default singleLineTags: blocks that exist to
+// cast inline (`/** @type {Foo} */ (bar)`) stay single-line by design
+const inlineTagPattern = /^@(?:type|lends)\b/u;
+
+function isSingleLineJSDoc(comment) {
+  return (
+    comment.type === 'Block' &&
+    comment.value.startsWith('*') &&
+    comment.loc.start.line === comment.loc.end.line
+  );
+}
+
+/**
+ * Builds the multi-line replacement for a single-line JSDoc comment, or null
+ * when the comment shares its line with code — expanding those in place would
+ * scramble the surrounding statement, so they are reported without a fix.
+ */
+function planExpansion(text, comment) {
+  if (!isOwnLine(text, comment)) {
+    return null;
+  }
+
+  const lineStart = text.lastIndexOf('\n', comment.range[0] - 1) + 1;
+  const indent = text.slice(lineStart, comment.range[0]);
+  const body = comment.value.slice(1).trim();
+  const bodyLine = body === '' ? `${indent} *` : `${indent} * ${body}`;
+
+  return `/**\n${bodyLine}\n${indent} */`;
+}
+
+function isOwnLine(text, comment) {
+  const [start, end] = comment.range;
+  const lineStart = text.lastIndexOf('\n', start - 1) + 1;
+  const lineEnd = text.indexOf('\n', end);
+  const sliceEnd = lineEnd === -1 ? text.length : lineEnd;
+
+  return /^[ \t]*$/u.test(text.slice(lineStart, start)) && text.slice(end, sliceEnd).trim() === '';
+}
+
+const noSingleLineJSDoc = {
+  meta: {
+    type: 'layout',
+    fixable: 'whitespace',
+    messages: {
+      singleLine:
+        'Write JSDoc blocks multi-line: `/**` alone, one `*`-prefixed line per point, `*/` alone.',
+    },
+    schema: [],
+  },
+  create(context) {
+    return {
+      Program() {
+        const offenders = context.sourceCode
+          .getAllComments()
+          .filter(
+            (comment) =>
+              isSingleLineJSDoc(comment) && !inlineTagPattern.test(comment.value.slice(1).trim()),
+          );
+
+        for (const comment of offenders) {
+          const replacement = planExpansion(context.sourceCode.text, comment);
+
+          context.report({
+            loc: comment.loc,
+            messageId: 'singleLine',
+            fix:
+              replacement === null
+                ? undefined
+                : (fixer) => fixer.replaceTextRange(comment.range, replacement),
+          });
+        }
+      },
+    };
+  },
+};
+
 const plugin = {
   meta: { name: 'zgeoff' },
   rules: {
@@ -88,6 +165,7 @@ const plugin = {
       'Await into a named const instead of chaining it after a && / || / ?? operator.',
       ['LogicalExpression > AwaitExpression'],
     ),
+    'no-single-line-jsdoc': noSingleLineJSDoc,
   },
 };