feat: add report log file

package.json

@@ -57,6 +57,7 @@
     "yorkie": "^2.0.0"
   },
   "dependencies": {
+    "table": "^6.7.1",
     "chalk": "^4.1.1",
     "@originjs/vue-sfc-ast-parser": "^1.0.1",
     "commander": "^7.2.0",

src/ast-parse/transformations/removeHtmlLangInTemplateTransformation.ts

@@ -3,6 +3,7 @@ import { TransformationType } from './index'
 import { stringifyDescriptor } from '@originjs/vue-sfc-ast-parser'
 import { FileInfo, TransformationResult, VueSFCContext } from '../astParse';
 import { parseVueSfc } from '../../utils/astUtils'
+import { recordConver } from '../../utils/report'
 
 export const astTransform:ASTTransformation = async (fileInfo: FileInfo) => {
   const context: VueSFCContext = parseVueSfc(fileInfo)
@@ -19,6 +20,7 @@ export const astTransform:ASTTransformation = async (fileInfo: FileInfo) => {
     content: stringifyDescriptor(context.descriptor),
     type: TransformationType.removeHtmlLangInTemplateTransformation
   }
+  recordConver({ num: 'O07', feat: 'remove lang="html"' })
   return result
 }
 

src/cli/cli.ts

@@ -8,7 +8,7 @@ import { genePatches } from '../generate/genePatches'
 import { Command } from 'commander'
 import { Config } from '../config/config'
 import { astParseRoot, AstParsingResult } from '../ast-parse/astParse'
-import { reportOpt, printReport } from '../utils/report'
+import { printReport, recordConver } from '../utils/report'
 
 export function run (): void {
   const program = new Command()
@@ -20,10 +20,10 @@ export function run (): void {
     .option('-e --entry <type>', 'entrance of the entire build process, webpack or vite will start from ' +
             'those entry files to build, if no entry file is specified, src/main.ts or src/main.js will be' +
             'used as default')
-    .option('-r --report <boolean>', 'when n, the output conversion report is not output')
+    .option('-r --reportType <type>', "'log' will output a file of log")
     .parse(process.argv)
 
-  const keys = ['rootDir', 'projectType', 'entry', 'report']
+  const keys = ['rootDir', 'projectType', 'entry', 'reportType']
   const config: Config = {}
   keys.forEach(function (k) {
     if (Object.prototype.hasOwnProperty.call(program.opts(), k)) {
@@ -41,10 +41,6 @@ export async function start (config : Config): Promise<void> {
     console.log(chalk.red(`Project path is not correct : ${config.rootDir}`))
     return
   }
-  if (config?.report === 'n') {
-    console.log(chalk.yellow('no report'));
-    reportOpt.noRepot = true
-  }
   const cwd = process.cwd()
   const rootDir = path.resolve(config.rootDir)
 
@@ -55,12 +51,12 @@ export async function start (config : Config): Promise<void> {
 
   // generate index.html must be after generate vite.config.js
   geneIndexHtml(rootDir, config, astParsingResult)
-  printReport() // output conversion
+  printReport(config.reportType, config.rootDir) // output conversion
 
   // generate patches
   const patchesDir = path.resolve(rootDir, 'patches')
   genePatches(patchesDir)
-
+  recordConver({ num: 'B05', feat: 'required plugins' })
   console.log(chalk.green('************************ Done ! ************************'))
   const pkgManager = fs.existsSync(path.resolve(rootDir, 'yarn.lock'))
     ? 'yarn'

src/config/config.ts

@@ -2,7 +2,7 @@ export interface Config {
     rootDir?: string;
     projectType?: string;
     entry?: any;
-    report?: string;
+    reportType?: string;
 }
 
 export interface DevServer {

src/generate/geneIndexHtml.ts

@@ -5,6 +5,7 @@ import { isObject, stringFormat } from '../utils/common'
 import { Config } from '../config/config'
 import { AstParsingResult } from '../ast-parse/astParse'
 import { TransformationType } from '../ast-parse/transformations'
+import { recordConver } from '../utils/report'
 
 export function geneIndexHtml (rootDir: string, config: Config, astParsingResult?: AstParsingResult): void {
   const outputIndexPath: string = path.resolve(rootDir, 'index.html')
@@ -19,6 +20,7 @@ export function geneIndexHtml (rootDir: string, config: Config, astParsingResult
 
   const injectedContent = generateWithVueCliPublicIndex(astParsingResult, entries, projectType)
   writeSync(outputIndexPath, injectedContent)
+  recordConver({ num: 'B02', feat: 'add index.html' })
 }
 
 function generateEntriesHtml (entries: string[]): string {

src/generate/genePackageJson.ts

@@ -4,6 +4,7 @@ import fs from 'fs'
 import path from 'path'
 import chalk from 'chalk'
 import * as constants from '../constants/constants'
+import { recordConver } from '../utils/report'
 
 // TODO: compatible with vue2 and vue3
 export function genePackageJson (packageJsonPath: string): void {
@@ -54,4 +55,5 @@ export function genePackageJson (packageJsonPath: string): void {
   packageJson.scripts.postinstall = 'patch-package'
 
   writeSync(packageJsonPath, JSON.stringify(packageJson, null, 2))
+  recordConver({ num: 'B01', feat: 'add package.json' })
 }