feat: 为ts项目添加lint钩子

Author: zhangyuang

README.md

@@ -208,6 +208,10 @@ $ npm run analyze // 可视化分析客户端打包的资源详情
 欢迎直接扫码加入钉钉群
 <img src="https://img.alicdn.com/tfs/TB1CONSclGE3KVjSZFhXXckaFXa-750-990.jpg" width="300">
 
+## 本地如何调试源码并贡献你的代码
+
+请查看该[wiki](https://github.com/ykfe/egg-react-ssr/wiki/%E6%9C%AC%E5%9C%B0%E5%A6%82%E4%BD%95%E8%B0%83%E8%AF%95%E6%BA%90%E7%A0%81%E5%B9%B6%E8%B4%A1%E7%8C%AE%E4%BD%A0%E7%9A%84%E4%BB%A3%E7%A0%81)
+
 ## Contributors
 
 Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

package.json

@@ -8,7 +8,7 @@
     "example": "example"
   },
   "scripts": {
-    "standard": "standard",
+    "standard": "standard --fix",
     "install": "lerna bootstrap",
     "test": "echo \"Error: no test specified\" && exit 1",
     "docs:dev": "vuepress dev docs",

packages/yk-cli/package.json

@@ -5,8 +5,8 @@
   "main": "./bin/index.js",
   "types": "types/index.d.ts",
   "scripts": {
-    "lint": "tslint --project . src/**/*.ts",
-    "lint:fix": "tslint --fix src/**/*.ts",
+    "lint": "tslint -c tslint.json -p .",
+    "lint:fix": "tslint -c tslint.json -p . --fix",
     "build": "rm -rf ./bin && tsc --project ./tsconfig.json --sourceMap false",
     "start": "node --inspect=19229 ./bin/index.js",
     "dev": "rm -rf ./bin && tsc -w"
@@ -24,6 +24,9 @@
       "@typescript-eslint/eslint-plugin"
     ]
   },
+  "pre-commit": [
+    "lint:fix"
+  ],
   "dependencies": {
     "download-git-repo": "^2.0.0",
     "inquirer": "6.3.1",
@@ -37,6 +40,7 @@
     "@types/nunjucks": "^3.1.1",
     "@types/shelljs": "^0.8.5",
     "@types/yargs": "^13.0.0",
+    "pre-commit": "^1.2.2",
     "tslint": "^5.17.0",
     "tslint-config-standard": "^8.0.1",
     "typescript": "^3.5.2"

packages/yk-cli/src/check.ts

@@ -13,20 +13,19 @@ import shell from 'shelljs'
  */
 export function checkRepeat (option: Optional): Promise<void> {
   const { appName } = option
-  return new Promise<void>((resolve, reject) => {
+  return new Promise<void>(async (resolve, reject) => {
     if (fs.existsSync(`./${appName}`)) {
-      inquirer.prompt([{
+      const answers: any = await inquirer.prompt([{
         type: 'confirm',
         message: `当前文件夹下含有您要创建 ${appName} 的应用名称文件,是否强制删除文件 继续初始化?`,
         name: 'delete',
         default: 'Yes'
-      }]).then(async (answers: any) => {
-        if (answers.delete) {
-          shell.rm('-rf', `./${appName}`)
-          console.log(`原文件已经成功删除...`)
-          resolve()
-        } else process.exit()
-      })
+      }])
+      if (answers.delete) {
+        shell.rm('-rf', `./${appName}`)
+        console.log(`原文件已经成功删除...`)
+        resolve()
+      } else process.exit()
     } else resolve()
   }).catch(err => processError(err))
 }

packages/yk-cli/src/config.ts

@@ -10,8 +10,8 @@ import inquirer from 'inquirer'
  * @returns {Promise<void>}
  */
 export function getConfig (option: Optional): Promise<void> {
-  return new Promise<void>((resolve, reject) => {
-    inquirer.prompt([{
+  return new Promise<void>(async (resolve, reject) => {
+    const answers: any = await inquirer.prompt([{
       type: 'input',
       message: '应用名称:',
       name: 'appName',
@@ -25,9 +25,9 @@ export function getConfig (option: Optional): Promise<void> {
         'javascript'
         // 'typescript(开发中)'
       ]
-    }]).then((answers: any) => {
-      Object.assign(option, answers)
-      resolve()
-    })
+    }])
+
+    Object.assign(option, answers)
+    resolve()
   }).catch(err => processError(err))
 }

packages/yk-cli/src/update.ts

@@ -2,6 +2,7 @@ import { getWithPromise, execWithPromise, processError, resolveApp } from './uti
 import ora from 'ora'
 const spinner = ora('发现本地版本较旧,尝试更新yk-cli脚手架')
 const url = 'https://raw.githubusercontent.com/ykfe/egg-react-ssr/master/packages/yk-cli/package.json'
+
 /**
  * 判断NPM包自动更新
  *

packages/yk-cli/types/package.d.ts

@@ -6,4 +6,4 @@ import { Optional } from './interface/option';
  * @param {Optional} option 应用全局配置
  * @returns {Promise<void>}
  */
-export declare function processPackage(option: Optional): Promise<void>;
+export declare function processPackage(option: Optional): void;

packages/yk-cli/types/update.d.ts

@@ -5,4 +5,4 @@
  * @param {Optional} option 全局应用配置
  * @returns {Promise<void>}
  */
-export declare function update(): Promise<void>;
+export declare function updateCli(): Promise<void>;

packages/yk-cli/types/util/index.d.ts

@@ -2,11 +2,10 @@
 import { exec } from 'child_process';
 import { Optional } from '../interface/option';
 export declare const processError: (err: string) => void;
-export declare const execPromise: typeof exec.__promisify__;
-export declare const downloadPromise: Function;
+export declare const execWithPromise: typeof exec.__promisify__;
+export declare const downloadWithPromise: Function;
 export declare const resolveApp: (source: string) => string;
-export declare const getPromise: object;
-
+export declare const getWithPromise: object;
 /**
  * http
  * 缓存判断是否有效处理
@@ -15,7 +14,6 @@ export declare const getPromise: object;
  * @returns {Promise<boolean>}
  */
 export declare function getVersionEffective(option: Optional): Promise<boolean>;
-
 /**
  * 渲染 Nunjuncks
  *

packages/yk-cli/types/webpackconfig.d.ts

@@ -6,4 +6,4 @@ import { Optional } from './interface/option';
  * @param {Optional} option
  * @returns {Promise<void>}
  */
-export declare function processWebpack(option: Optional): Promise<void>;
+export declare function processWebpack(option: Optional): void;