feat: report to Sonar

Author: Ni55aN

.gitignore

@@ -1,4 +1,6 @@
 .vscode
 node_modules
 bin
-coverage
+coverage
+.rete-cli
+.sonar

.npmignore

@@ -4,3 +4,5 @@ node_modules
 .github
 CODE_OF_CONDUCT.md
 CONTRIBUTING.md
+.rete-cli
+.sonar

eslint.config.mjs

@@ -6,6 +6,7 @@ export default tseslint.config(
   {
     rules: {
       'no-console': 'off',
+      'no-undefined': 'off',
       '@typescript-eslint/no-require-imports': 'off',
     }
   }

src/build/dev.ts

@@ -28,7 +28,7 @@ export async function buildDev(name: string, config: RollupOptions | RollupOptio
     // eslint-disable-next-line max-statements
     watcher.on('event', e => {
       if (e.code === 'START') {
-        void safeExec(() => lint(false, true), messages.lintingFail)
+        void safeExec(() => lint({ fix: false, quiet: true, output: ['stdout'] }), messages.lintingFail)
         void safeExec(() => generateTypes(outputDirectories), messages.typesFail)
       } else if (e.code === 'BUNDLE_START') {
         const index = getIndex(config, e.output)

src/build/index.ts

@@ -34,7 +34,7 @@ async function build(config: ReteConfig, pkg: Pkg, outputDirectories: string[])
 
   await safeExec(() => generateTypes(outputDirectories), messages.typesFail, 1)
   console.log(messages.typesSuccess)
-  await safeExec(lint, messages.lintingFail, 1)
+  await safeExec(() => lint({ output: ['stdout'] }), messages.lintingFail, 1)
   console.log(messages.lintingSuccess)
 
   const targets = getRollupConfig(config, outputs, pkg, outputDirectories)

src/consts.ts

@@ -1,3 +1,4 @@
 
 export const SOURCE_FOLDER = 'src'
 export const TEST_FOLDER = 'test'
+export const RESULTS_FOLDER = '.rete-cli'

src/index.ts

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 
-import { createCommand } from 'commander'
+import { createCommand, Option } from 'commander'
 
 import build from './build'
 import { setVerbose } from './build/utils'
@@ -28,8 +28,16 @@ program
   .command('lint')
   .description('Lint using ESLint and TS parser')
   .option('--fix')
-  .action(async (options: { fix?: boolean }) => {
-    await lint(options.fix)
+  .addOption(new Option('--output <output...>', 'Output target')
+    .choices(['sonar', 'stdout'])
+    .default('stdout'))
+  .option('--quiet')
+  .action(async (options: { fix?: boolean, quiet?: boolean, output: ('sonar' | 'stdout')[] }) => {
+    await lint({
+      fix: options.fix,
+      quiet: options.quiet,
+      output: options.output
+    })
   })
 
 program

src/lint/base.ts

@@ -1,5 +1,10 @@
-import { LintResult } from './results'
+import { LintResult, RuleMeta } from './results'
+
+export interface LinterResponse {
+  rules: RuleMeta[]
+  results: LintResult[]
+}
 
 export interface BaseLinter {
-  run(): LintResult[] | Promise<LintResult[]>
+  run(): LinterResponse | Promise<LinterResponse>
 }

src/lint/eslint/index.ts

@@ -1,12 +1,12 @@
 import { loadESLint } from 'eslint'
 
 import { BaseLinter } from '../base'
-import { LintMessage, LintResult } from '../results'
+import { LintMessage, RuleMeta } from '../results'
 
 export class ESLint implements BaseLinter {
   constructor(private options: { targets: string[], fix?: boolean }) {}
 
-  async run(): Promise<LintResult[]> {
+  async run() {
     const originESLint = await loadESLint({
       useFlatConfig: true
     })
@@ -16,29 +16,43 @@ export class ESLint implements BaseLinter {
       errorOnUnmatchedPattern: false
     })
 
-    const results = await instance.lintFiles(this.options.targets)
+    const eslintResults = await instance.lintFiles(this.options.targets)
 
     if (this.options.fix) {
-      await originESLint.outputFixes(results)
+      await originESLint.outputFixes(eslintResults)
     }
 
-    return results.map(({ filePath, messages }) => {
+    const results = eslintResults.map(({ filePath, messages }) => {
       return {
         filePath,
         messages: messages.map(message => {
-          const result: LintMessage = {
+          return {
             column: message.column,
             line: message.line,
-            endColumn: message.endColumn ?? message.column,
-            endLine: message.endLine ?? message.line,
+            endColumn: message.endColumn,
+            endLine: message.endLine,
             ruleId: message.ruleId ?? null,
             message: message.message,
             severity: message.severity
-          }
-
-          return result
+          } satisfies LintMessage
         })
       }
     })
+    const allMessages = eslintResults.flatMap(({ messages }) => messages)
+    const rules = Object.entries(instance.getRulesMetaForResults(eslintResults))
+      .map(([id, { docs }]) => {
+        const firstMessage = allMessages.find(({ ruleId }) => ruleId === id)
+
+        return {
+          id,
+          description: docs?.description,
+          severity: firstMessage?.severity ?? 1
+        } satisfies RuleMeta
+      })
+
+    return {
+      results,
+      rules
+    }
   }
 }

src/lint/index.ts

@@ -1,8 +1,8 @@
-import { lint } from './linter'
+import { lint, LintOptions } from './linter'
 
-export default async function (fix?: boolean, quiet?: boolean) {
+export default async function (options: LintOptions) {
   try {
-    await lint(fix, quiet)
+    await lint(options)
   } catch (e) {
     console.error(e)
     process.exit(1)