feat: 区分 print 和非 print 方法

Author: luckyadam

index.ts

@@ -3,7 +3,14 @@ import * as path from 'path'
 import { ESLint } from 'eslint'
 import * as glob from 'glob'
 
-import { validateEnv, validateConfig, validatePackage, validateRecommend } from './js-binding'
+import {
+  validateEnvPrint,
+  validateConfigPrint,
+  validatePackagePrint,
+  validateRecommendPrint,
+  MessageKind,
+  ValidateResult,
+} from './js-binding'
 
 export default (ctx) => {
   ctx.registerCommand({
@@ -22,16 +29,38 @@ export default (ctx) => {
         }
         return v
       })
-      validateEnv()
-      validateConfig(configStr)
-      validatePackage(appPath, nodeModulesPath)
-      validateRecommend(appPath)
-      await validateEslint(ctx.initialConfig, chalk)
+      validateEnvPrint()
+      validateConfigPrint(configStr)
+      validatePackagePrint(appPath, nodeModulesPath)
+      validateRecommendPrint(appPath)
+      await validateEslintPrint(ctx.initialConfig, chalk)
     },
   })
 }
 
-export async function validateEslint(projectConfig, chalk) {
+export async function validateEslint(projectConfig, chalk): Promise<ValidateResult> {
+  const result = await validateEslintCore(projectConfig, chalk)
+  result.messages.unshift({
+    kind: MessageKind.Info,
+    content: `\u{1F3AF} 检查 ESLint (以下为 ESLint 的输出)！`,
+  })
+  return result
+}
+
+export async function validateEslintPrint(projectConfig, chalk): Promise<boolean> {
+  const result = await validateEslintCore(projectConfig, chalk)
+  let is_valid = result.isValid
+  let rawReport = result.messages[0].content
+  console.log(`\u{1F3AF} 检查 ESLint (以下为 ESLint 的输出)！`)
+  if (is_valid) {
+    console.log(`${chalk.green('[\u{2713}]')} Eslint 检查通过！`)
+  } else {
+    console.log(rawReport)
+  }
+  return is_valid
+}
+
+async function validateEslintCore(projectConfig, chalk): Promise<ValidateResult> {
   const appPath = process.cwd()
   const globPattern = glob.sync(path.join(appPath, '.eslintrc*'))
 
@@ -46,14 +75,21 @@ export async function validateEslint(projectConfig, chalk) {
   const sourceFiles = path.join(process.cwd(), projectConfig.sourceRoot, '**/*.{js,ts,jsx,tsx}')
   const report = await eslintCli.lintFiles([sourceFiles])
   const formatter = await eslintCli.loadFormatter()
-  const rawReport = formatter.format(report)
+  let rawReport = formatter.format(report)
   let is_valid = true
-  console.log(`\u{1F3AF} 检查 ESLint (以下为 ESLint 的输出)！`)
   if (rawReport) {
     is_valid = false
-    console.log(rawReport)
-  } else {
-    console.log(`${chalk.green('[\u{2713}]')} Eslint 检查通过！`)
   }
-  return is_valid
+  if (is_valid) {
+    rawReport = `${chalk.green('[\u{2713}]')} Eslint 检查通过！`
+  }
+  return {
+    isValid: is_valid,
+    messages: [
+      {
+        kind: is_valid ? MessageKind.Success : MessageKind.Error,
+        content: rawReport,
+      },
+    ],
+  }
 }

js-binding.d.ts

@@ -3,7 +3,27 @@
 
 /* auto-generated by NAPI-RS */
 
-export function validateConfig(configStr: string): boolean
-export function validatePackage(appPath: string, nodeModulesPath: string): boolean
-export function validateEnv(): boolean
-export function validateRecommend(appPath: string): boolean
+export const enum MessageKind {
+  Info = 0,
+  Error = 1,
+  Success = 2,
+  Warning = 3,
+  Manual = 4
+}
+export interface Message {
+  kind: MessageKind
+  content: string
+  solution?: string
+}
+export interface ValidateResult {
+  isValid: boolean
+  messages: Array<Message>
+}
+export function validateConfig(configStr: string): ValidateResult
+export function validateConfigPrint(configStr: string): boolean
+export function validatePackage(appPath: string, nodeModulesPath: string): ValidateResult
+export function validatePackagePrint(appPath: string, nodeModulesPath: string): boolean
+export function validateEnv(): ValidateResult
+export function validateEnvPrint(): boolean
+export function validateRecommend(appPath: string): ValidateResult
+export function validateRecommendPrint(appPath: string): boolean

js-binding.js

@@ -252,9 +252,14 @@ if (!nativeBinding) {
   throw new Error(`Failed to load native binding`)
 }
 
-const { validateConfig, validatePackage, validateEnv, validateRecommend } = nativeBinding
+const { MessageKind, validateConfig, validateConfigPrint, validatePackage, validatePackagePrint, validateEnv, validateEnvPrint, validateRecommend, validateRecommendPrint } = nativeBinding
 
+module.exports.MessageKind = MessageKind
 module.exports.validateConfig = validateConfig
+module.exports.validateConfigPrint = validateConfigPrint
 module.exports.validatePackage = validatePackage
+module.exports.validatePackagePrint = validatePackagePrint
 module.exports.validateEnv = validateEnv
+module.exports.validateEnvPrint = validateEnvPrint
 module.exports.validateRecommend = validateRecommend
+module.exports.validateRecommendPrint = validateRecommendPrint