lintcn 0.6.0 → 0.7.1

package/src/discover.ts

@@ -8,10 +8,17 @@ import path from 'node:path'
 export interface RuleMetadata {
   /** kebab-case rule name from // lintcn:name or derived from folder name */
   name: string
+  /** runtime rule name parsed from Go `rule.Rule{Name: "..."}`. This is
+   *  the name tsgolint uses in diagnostics and must match --warn flags.
+   *  Falls back to `name` if the Go Name field can't be parsed. */
+  goRuleName: string
   /** one-line description from // lintcn:description */
   description: string
   /** original source URL from // lintcn:source */
   source: string
+  /** severity from // lintcn:severity — 'error' (default) or 'warn'.
+   *  Warnings are displayed with yellow styling and don't cause exit code 1. */
+  severity: 'error' | 'warn'
   /** exported Go variable name like NoFloatingPromisesRule */
   varName: string
   /** Go package name (= subfolder name, e.g. no_floating_promises) */
@@ -22,6 +29,12 @@ export interface RuleMetadata {
 // and optional import alias (e.g. `r.Rule{` if imported as `r "...rule"`)
 const RULE_VAR_RE = /^\s*var\s+(\w+)\s*=\s*\w*\.?Rule\s*\{/m
 const METADATA_RE = /^\/\/\s*lintcn:(\w+)\s+(.+)$/gm
+// buildGoRuleNameRe creates a regex scoped to a specific rule variable's
+// struct literal, e.g. `var FooRule = rule.Rule{ ... Name: "foo" ... }`.
+// This avoids matching a Name field in an unrelated struct earlier in the file.
+function buildGoRuleNameRe(varName: string): RegExp {
+  return new RegExp(`var\\s+${varName}\\s*=\\s*\\w*\\.?Rule\\s*\\{[\\s\\S]*?Name:\\s*"([^"]+)"`)
+}
 
 export function parseMetadata(content: string): Record<string, string> {
   const meta: Record<string, string> = {}
@@ -36,6 +49,13 @@ export function parseRuleVar(content: string): string | undefined {
   return match?.[1]
 }
 
+/** Extract the Name field from a specific rule.Rule variable's struct literal.
+ *  Scoped to varName to avoid matching Name fields in unrelated structs. */
+export function parseGoRuleName(content: string, varName: string): string | undefined {
+  const match = content.match(buildGoRuleNameRe(varName))
+  return match?.[1]
+}
+
 export function discoverRules(lintcnDir: string): RuleMetadata[] {
   if (!fs.existsSync(lintcnDir)) {
     return []
@@ -73,10 +93,16 @@ export function discoverRules(lintcnDir: string): RuleMetadata[] {
 
       const meta = parseMetadata(content)
 
+      const severity = meta.severity === 'warn' ? 'warn' as const : 'error' as const
+      const displayName = meta.name || entry.name.replace(/_/g, '-')
+      const goRuleName = parseGoRuleName(content, varName) || displayName
+
       rules.push({
-        name: meta.name || entry.name.replace(/_/g, '-'),
-        description: meta.description || '',
-        source: meta.source || '',
+        name: displayName,
+        goRuleName,
+        description: meta.description,
+        source: meta.source,
+        severity,
         varName,
         packageName: entry.name,
       })