feat: print logs in different modules (vuejs#26)

Author: ygj6

bin/vue-codemod.ts

@@ -20,7 +20,7 @@ import { transform as packageTransform } from '../src/packageTransformation'
 
 import type { TransformationModule } from '../src/runTransformation'
 
-const debug = createDebug('vue-codemod')
+const debug = createDebug('vue-codemod:cli')
 const log = console.log.bind(console)
 let processFilePath: string[] = []
 
@@ -74,25 +74,36 @@ async function main() {
 
   const resolvedPaths = globby.sync(files as string[])
   if (transformationName != undefined) {
+    debug(`run ${transformationName} transformation`)
     const transformationModule = loadTransformationModule(transformationName)
     processTransformation(
       resolvedPaths,
       transformationName,
       transformationModule
     )
     packageTransform()
+    processFilePath.push('package.json')
   }
 
   if (runAllTransformation) {
+    debug(`run all transformation`)
     for (let key in builtInTransformations) {
       if (!excludedTransformations.includes(key)) {
         processTransformation(resolvedPaths, key, builtInTransformations[key])
+      } else {
+        debug(
+          `skip ${key} transformation, Because it will run in other transformation`
+        )
       }
     }
 
     for (let key in vueTransformations) {
       if (!excludedVueTransformations.includes(key)) {
         processTransformation(resolvedPaths, key, vueTransformations[key])
+      } else {
+        debug(
+          `skip ${key} transformation, Because it will run in other transformation`
+        )
       }
     }
     packageTransform()
@@ -125,6 +136,7 @@ function processTransformation(
     }
     const extension = (/\.([^.]*)$/.exec(fileInfo.path) || [])[0]
     if (!extensions.includes(extension)) {
+      debug(`skip ${fileInfo.path} file because not end with ${extensions}.`)
       continue
     }
     try {

src/packageTransformation.ts

@@ -1,6 +1,9 @@
 import * as fs from 'fs'
 import * as globby from 'globby'
 import * as prettier from 'prettier'
+import createDebug from 'debug'
+
+const debug = createDebug('vue-codemod:rule')
 
 /**
  * Creates a fix command that inserts text at the specified index in the source text.
@@ -12,6 +15,7 @@ import * as prettier from 'prettier'
 export function transform(): void {
   const resolvedPaths = globby.sync('package.json' as string)
   if (resolvedPaths.length <= 0) {
+    debug('package.json is not exists.')
     return
   }
 

src/runTransformation.ts

@@ -8,7 +8,7 @@ import type { SFCDescriptor } from './sfcUtils'
 
 import VueTransformation from './VueTransformation'
 
-const debug = createDebug('vue-codemod')
+const debug = createDebug('vue-codemod:run')
 
 type FileInfo = {
   path: string
@@ -58,8 +58,6 @@ export default function runTransformation(
   let descriptor: SFCDescriptor
 
   if (transformation.type === 'vueTransformation') {
-    debug('Running VueTransformation')
-
     if (extension === '.vue') {
       descriptor = parseSFC(source, { filename: path }).descriptor
     } else {
@@ -69,6 +67,7 @@ export default function runTransformation(
 
     // skip .vue files without template block
     if (!descriptor.template) {
+      debug('skip .vue files without template block.')
       return source
     }
     let contentStart: number =
@@ -110,6 +109,7 @@ export default function runTransformation(
 
       // skip .vue files without script block
       if (!descriptor.script) {
+        debug('skip .vue files without script block.')
         return source
       }
 

vue-transformations/transition-group-root.ts

@@ -4,6 +4,9 @@ import type { Node } from 'vue-eslint-parser/ast/nodes'
 import type { Operation } from '../src/operationUtils'
 import type { VueASTTransformation } from '../src/wrapVueTransformation'
 import wrap from '../src/wrapVueTransformation'
+import createDebug from 'debug'
+
+const debug = createDebug('vue-codemod:rule')
 
 /**
  * 每一个实际的规则，需要做以下几件事：
@@ -68,6 +71,7 @@ function fix(node: any): Operation[] {
       hasTagAttr = true
     })
   if (hasTagAttr) {
+    debug('No operator, transition-group element has tag attribute.')
     return fixOperations
   }
 

vue-transformations/v-else-if-key.ts

@@ -4,6 +4,9 @@ import type { Node } from 'vue-eslint-parser/ast/nodes'
 import type { Operation } from '../src/operationUtils'
 import type { VueASTTransformation } from '../src/wrapVueTransformation'
 import wrap from '../src/wrapVueTransformation'
+import createDebug from 'debug'
+
+const debug = createDebug('vue-codemod:rule')
 
 /**
  * 每一个实际的规则，需要做以下几件事：
@@ -71,10 +74,11 @@ function fix(node: any): Operation[] {
           attr.key.name.name === 'else-if' ||
           attr.key.name.name === 'else')
     )
-    .forEach((element: any) => {
+    .forEach(() => {
       hasTargetAttr = true
     })
   if (!hasTargetAttr) {
+    debug('No operator, target element is not if/else-if/else.')
     return fixOperations
   }
 

vue-transformations/v-for-template-key.ts

@@ -5,6 +5,9 @@ import type { Node } from 'vue-eslint-parser/ast/nodes'
 import type { Operation } from '../src/operationUtils'
 import type { VueASTTransformation } from '../src/wrapVueTransformation'
 import wrap from '../src/wrapVueTransformation'
+import createDebug from 'debug'
+
+const debug = createDebug('vue-codemod:rule')
 
 let operatingParentElements: any = []
 
@@ -78,6 +81,7 @@ function fix(node: any): Operation[] {
       hasForAttr = true
     })
   if (hasForAttr) {
+    debug('No operator, target element has for attribute.')
     return fixOperations
   }
 
@@ -125,6 +129,7 @@ function fix(node: any): Operation[] {
   }
 
   if (!elderHasFor) {
+    debug('No operator, elder element no for attribute.')
     return fixOperations
   }