Iceworks Doctor

Analyse and running codemods over react/rax projects, troubleshooting and automatically fixing errors.

1. Code Scanner

$3

``shell
$ npm i @iceworks/doctor --save-dev
`

or

`shell
$ npm install -g @iceworks/doctor
`

$3

`js
const { Doctor } = require('@iceworks/doctor');

const doctor = new Doctor(options);
doctor.scan('/yourProjectPath').then((result) => {
console.log(result);
});

`

$3

Use $ iceworks-doctor -h for help.

Scan
`shell
$ iceworks-doctor -s ./
`

Options
`shell
$ iceworks-doctor -s ./ --ignore types mock
`

$3

#### new Doctor(options?);

* ignore?: string[], Ignore directories, example ['mock'] . .gitignore will work too.

#### scan('/yourProjectPath', options?);

* fix?: boolean, whether fix ESLint fixable problems.
* framework?: string, target project framework, default is react.
* languageType?: 'js'|'ts', target project languageType, default is js.
* tempFileDir?: string, set temp reporters file directory, default is node_modules/@iceworks/doctor/tmp/.
* disableESLint?: boolean, whether disable ESLint part reports.
* disableMaintainability?: boolean, whether disable maintainability part reports.
* disableRepeatability?: boolean, whether disable repeatability part reports.

$3

#### ESLint

Use @iceworks/spec check your project.

.eslintrc.js customConfig will merge into ESLint config.

`js
// .eslintrc.js
const { getESLintConfig } = require('@iceworks/spec');

// getESLintConfig(rule: 'rax'|'react', customConfig?);
module.exports = getESLintConfig('react', {
'no-unused-vars': 'off'
});
`
.eslintignore ignore config will merge into ESLint ignore.

#### Maintainability

Use typhonjs-escomplex calculate complexity reports.

#### Repeatability

Use jscpd calculate repeatability reports.

2. Codemod

This repository also contains a collection of codemod scripts that help update React(ICE) and Rax APIs.

$3

Install jscodeshift and @iceworks/doctor.

`shell
$ npm i -g jscodeshift @iceworks/doctor
`

$3

iceworks-doctor -c [...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's CLI API.

$3

#### plugin-rax-component-to-component

Update plugin-rax-component to plugin-component.
See: https://rax.js.org/docs/guide/com-migration

`shell
iceworks-doctor -c plugin-rax-component-to-component ./
``

Enjoy!