Feat add codemod check to doctor package

packages/doctor/CHANGELOG.md

@@ -1,10 +1,10 @@
 # changelog
 
-## 0.4.8
-- update eslint to version 7.0
+## 0.2.0
 
-## 0.4.7
-- support scan `unknown` framework project
+- Remove codemod CLI usage.
+- Add codemod check and fix reports to `scan`.
 
-## 0.4.6
-- fix can't catch timeout error
+## 0.1.0
+
+- Init

packages/doctor/README.md

@@ -51,12 +51,13 @@ $ appworks-doctor -s ./ --ignore types mock
 
 * fix?: boolean, whether fix ESLint fixable problems.
 * framework?: string, target project framework, default is `react`.
+* transforms?: string[], you want to run code transform keys, from [@appworks/codemod](https://github.com/appworks-lab/codemod/)
 * languageType?: 'js'|'ts', target project languageType, default is `js`.
 * tempFileDir?: string, set temp reporters file directory, default is `node_modules/@appworks/doctor/tmp/`.
 * disableESLint?: boolean, whether disable ESLint part reports.
 * disableMaintainability?: boolean, whether disable maintainability part reports.
 * disableRepeatability?: boolean, whether disable repeatability part reports.
-
+* disableCodemod?: boolean, whether disable codemod part reports.
 ### Result
 
 #### ESLint
@@ -84,39 +85,8 @@ Use [typhonjs-escomplex](https://www.npmjs.com/package/typhonjs-escomplex) calcu
 
 Use [jscpd](https://www.npmjs.com/package/jscpd) calculate repeatability reports.
 
-## 2. Codemod
-
-This repository also contains a collection of codemod scripts that help update React([ICE](https://ice.work/)) and [Rax](https://rax.js.org/) APIs.
-
-### Installation
-
-Install [jscodeshift](https://www.npmjs.com/package/jscodeshift) and @appworks/doctor.
-
-```shell
-$ npm i -g jscodeshift @appworks/doctor 
-```
-
-### Usage (CLI)
+#### Codemod
 
-`appworks-doctor -c <transform> <path?> [...options?]`
-
-   * `transform` - name of transform, see available transforms below.
-   * `path?` - files or directory to transform. 
-   * `options?` - some rule's options.
-
-This will start an interactive wizard, and then run the specified transform.
-
-PS: You can also clone this repository then use [jscodeshift](https://www.npmjs.com/package/jscodeshift)'s CLI API.
-
-### Included Transforms
-
-#### `plugin-rax-component-to-component`
-
-Update `plugin-rax-component` to `plugin-component`.
-See: https://rax.js.org/docs/guide/com-migration
-
-```shell
-appworks-doctor -c plugin-rax-component-to-component ./
-```
+Use [@appworks/codemod](https://www.npmjs.com/package/@appworks/codemod) check and update Rax and React deprecated usages.
 
 Enjoy!

packages/doctor/bin/appworks-doctor

@@ -3,17 +3,12 @@
 'use strict';
 
 const argv = require('argv-parse');
-const fs = require('fs');
-const path = require('path');
-const { spawnSync } = require('child_process');
 const options = require('./options.json');
 const pkg = require('../package.json');
 const { Doctor } = require('../lib/index');
 
 const args = argv(options);
 
-const transformerDirectory = path.join(__dirname, '../lib/', 'transforms');
-
 // Show version
 if (args.version) {
   console.log(pkg.version);
@@ -50,7 +45,7 @@ if (args.scan) {
       },
       score: result.score || 0,
     };
-    ['ESLint', 'maintainability', 'repeatability'].forEach(key => {
+    ['ESLint', 'maintainability', 'repeatability'].forEach((key) => {
       if (result[key]) {
         report[key] = result[key].score;
       }
@@ -62,33 +57,3 @@ if (args.scan) {
     console.error(err);
   });
 }
-
-// codemod
-if (args.codemod) {
-  args.supportExts = (args.supportExts || []).concat(['json']);
-  const [transformer, targetPath = process.cwd()] = args.codemod;
-
-  const doctor = new Doctor(args);
-  doctor.ignore = doctor.ignore.filter(i => i !== 'demo');
-  const files = doctor.getFiles(targetPath).map(file => file.path);
-
-  let transformerArgs = ['-p'];
-  const transformerPath = path.join(transformerDirectory, `${transformer}.js`);
-
-  if (!files.length) {
-    console.log(`No files found matching ${targetPath}`);
-  } else if (!fs.existsSync(transformerPath)) {
-    console.log(`No transformer found matching ${transformer}`);
-  } else {
-    transformerArgs = transformerArgs.concat(['--transform', transformerPath]);
-    transformerArgs = transformerArgs.concat(files);
-
-    // jscodeshift has too large size as node dependencies and better use in CLI env.
-    // Suggest user to install jscodeshift in codemod case.
-    spawnSync('jscodeshift', transformerArgs,
-      {
-        stdio: 'inherit',
-        stripEof: false,
-      });
-  }
-}

packages/doctor/bin/options.json

@@ -14,11 +14,6 @@
     "desc": "Scan target project directory.",
     "type": "string"
   },
-  "codemod":{
-    "alias": "c",
-    "desc": "codemod scripts that help update React(ICE) and Rax APIs.",
-    "type": "array"
-  },
   "ignore": {
     "desc": "Ignore directories when scan.",
     "type": "array"

packages/doctor/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@appworks/doctor",
   "description": "Analyse and running codemods over react/rax projects, troubleshooting and automatically fixing errors",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "keywords": [
     "doctor",
     "analysis",
@@ -25,6 +25,7 @@
     "prepublishOnly": "npm run compile"
   },
   "dependencies": {
+    "@appworks/codemod": "^0.1.0",
     "@babel/parser": "^7.12.5",
     "@babel/traverse": "^7.12.5",
     "@iceworks/spec": "^1.0.2",

packages/doctor/src/Analyzer.ts

@@ -20,13 +20,13 @@ const LANGUAGE_MAP = {
 const UNKNOWN_LANGUAGE = 'Other';
 
 export default class Analyzer {
-  public options: IAnalyzerOptions;
+  options: IAnalyzerOptions;
 
   constructor(options: IAnalyzerOptions) {
     this.options = options;
   }
 
-  public analyse(directory: string): IAnalyzerReport {
+  analyse(directory: string): IAnalyzerReport {
     const report = { languages: [] } as IAnalyzerReport;
     const languageCache = {};
     const files: IFileInfo[] = getFiles(directory, this.options.ignore);

packages/doctor/src/Scanner.ts

@@ -13,14 +13,14 @@ import getFinalScore from './getFinalScore';
 const tempDir = path.join(__dirname, 'tmp/');
 
 export default class Scanner {
-  public options: IScannerOptions;
+  options: IScannerOptions;
 
   constructor(options: IScannerOptions) {
     this.options = options;
   }
 
   // Entry
-  public async scan(directory: string, options?: IScanOptions): Promise<IScannerReports> {
+  async scan(directory: string, options?: IScanOptions): Promise<IScannerReports> {
     const timer = new Timer();
     const reports = {} as IScannerReports;
     const tempFileDir = options?.tempFileDir || tempDir;
@@ -67,6 +67,14 @@ export default class Scanner {
       });
     }
 
+    // Run Codemod
+    if (!options || options.disableCodemod !== true) {
+      subprocessList.push(execa.node(path.join(__dirname, './workers/codemod/index.js'), [`${directory} ${tempFileDir} ${options?.transforms}`]));
+      processReportList.push(async () => {
+        reports.codemod = await fs.readJSON(path.join(tempFileDir, config.tmpFiles.report.codemod));
+      });
+    }
+
     async function process() {
       // Check
       await Promise.all(subprocessList);
@@ -79,6 +87,7 @@ export default class Scanner {
           (reports.ESLint || {}).score,
           (reports.maintainability || {}).score,
           (reports.repeatability || {}).score,
+          (reports.codemod || {}).score,
         ].filter((score) => !isNaN(score)),
       );
 

packages/doctor/src/Scorer.ts

@@ -17,17 +17,17 @@ export default class Scanner {
     this.currentScore = options.start || this.highestScore;
   }
 
-  public plus(score: number): number {
+  plus(score: number): number {
     this.currentScore += score;
     return this.getScore();
   }
 
-  public minus(score: number): number {
+  minus(score: number): number {
     this.currentScore -= score;
     return this.getScore();
   }
 
-  public getAverage(list: number[]): number {
+  getAverage(list: number[]): number {
     if (list.length) {
       let sum = 0;
 
@@ -46,7 +46,7 @@ export default class Scanner {
     return this.getScore();
   }
 
-  public getScore(): number {
+  getScore(): number {
     if (this.currentScore > this.highestScore) {
       return this.highestScore;
     } else if (this.currentScore < this.lowestScore) {

packages/doctor/src/Timer.ts

@@ -11,14 +11,14 @@ export default class Timer {
     this.startTime = Date.now();
   }
 
-  public async raceTimeout(ms: number) {
-    await new Promise(resolve => {
+  async raceTimeout(ms: number) {
+    await new Promise((resolve) => {
       this.timer = setTimeout(resolve, ms);
     });
     throw new Error('@appworks/doctor time out!');
   }
 
-  public duration(): number {
+  duration(): number {
     if (this.timer) {
       clearTimeout(this.timer);
     }

packages/doctor/src/config.ts

@@ -5,6 +5,7 @@ export default {
       eslint: 'eslint-result.json',
       escomplex: 'escomplex-result.json',
       jscpd: 'jscpd-result.json',
+      codemod: 'codemod-result.json',
     },
   },
 };

packages/doctor/src/index.ts

@@ -8,9 +8,9 @@ import { IFileInfo } from './types/File';
 // Ignore directories
 const defaultignore = ['.faas_debug_tmp', '.ice', '.rax', 'build', 'es', 'dist', 'lib', 'mocks', 'logs', 'coverage', 'node_modules', 'demo', 'examples', 'public', 'test', '__tests__'];
 class Doctor {
-  public options: any;
+  options: any;
 
-  public ignore: string[];
+  ignore: string[];
 
   private scanner: any;