feat: add typings (#2)

Author: fyangstudio

.eslintignore

@@ -1 +1,2 @@
 node_modules/
+index.d.ts

CHANGELOG.md

@@ -1,5 +1,9 @@
 # changelog
 
+## 0.1.1
+
+- Feat: add typings.
+
 ## 0.1.0
 
 - Feat: add transform - `plugin-rax-component-to-component`

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@appworks/codemod",
   "description": "AppWorks codemod scripts",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "keywords": [
     "appworks",
     "codemod",
@@ -17,6 +17,7 @@
     "transforms/"
   ],
   "main": "src/index.js",
+  "typings": "src/index.d.ts",
   "publishConfig": {
     "access": "public"
   },

src/index.d.ts

@@ -0,0 +1,15 @@
+export interface IResult {
+  transform: string; // transform key, see `Included Transforms`
+  title: string; // transform description title
+  title_en: string;
+  message: string; // transform description message
+  message_en: string;
+  severity: 0 | 1 | 2; // 0: advice 1: warning 2: error
+  mode: "run" | "check"; // mode, see API
+  docs: string; // docs url
+  output: string; // jscodeshift CLI output
+  npm_deprecate?: string; // same as https://docs.npmjs.com/cli/v7/commands/npm-deprecate/
+}
+
+export function check(cwd: string, files: string[]): Promise<IResult[]>;
+export function run(cwd: string, files: string[], transform: string): Promise<IResult>;