refactor: refactor project by typescript (#7)

* fix: fix dynamic require error from built file

* style: beautify code style

* refactor: separate webpack plugin from package

* 🔥 chore: remove useless utils

* ♻️ refactor: refactor project by ts

* 🔧 build: update webpack config

* 🐛 fix: fix error for ts project

* 🐛 fix: fix ci

* 🐛 fix: fix webpack build error

* 🐛 fix: fix webpack build error

* 🐛 fix: fix module error

* 🔖 chore(release): publish v0.1.1

Author: yuzhanglong

.eslintrc.js

@@ -0,0 +1,33 @@
+module.exports = {
+  'parser': '@typescript-eslint/parser',
+  'plugins': [
+    '@typescript-eslint'
+  ],
+  'rules': {
+    'no-multiple-empty-lines': 1,
+    'import/no-unresolved': 'off',
+    'import/order': 'warn',
+    '@typescript-eslint/no-empty-interface': 'warn',
+    '@typescript-eslint/no-var-requires': 'off',
+    '@typescript-eslint/ban-ts-comment': 'off',
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+    '@typescript-eslint/no-empty-function': 'off'
+  },
+  'extends': [
+    'eslint:recommended',
+    'plugin:import/errors',
+    'plugin:import/warnings',
+    'plugin:import/typescript'
+  ],
+  'root': true,
+  'parserOptions': {
+    'ecmaVersion': 2018,
+    'sourceType': 'module'
+  },
+  'env': {
+    'browser': true,
+    'node': true,
+    'jest': true
+  }
+}

README.md

@@ -31,7 +31,6 @@ jobs:
 
 您的 lint-md 配置文件的路径，支持 `json` 或者 JavaScript 模块。
 
-
 如果工作目录下没有任何配置文件，我们使用[默认的规则](https://github.com/lint-md/lint-md#rules-%E9%85%8D%E7%BD%AE)
 
 ### failOnWarnings
@@ -50,4 +49,4 @@ jobs:
 
 ## LICENSE
 
-MIT
+MIT

__tests__/github-action.spec.js __tests__/github-action.spec.ts

@@ -7,9 +7,11 @@
  */
 
 
-const path = require('path')
-const LintMdAction = require('../src/lint-md-action')
-const { mockAction } = require('../src/test-utils')
+import * as path from 'path'
+
+import { LintMdAction } from '../src/lint-md-action'
+
+import { mockAction } from '../src/test-utils'
 
 
 describe('lint-md GitHub action 测试', () => {
@@ -104,4 +106,4 @@ describe('lint-md GitHub action 测试', () => {
     const totalErrors = lintMdAction.getErrors()
     expect(totalErrors.length).toStrictEqual(2)
   })
-})
+})

__tests__/extend-linter.spec.js __tests__/linter.spec.ts

@@ -6,17 +6,21 @@
  * Email: [email protected]
  */
 
-const ExtendLinter = require('../src/extend-linter')
-const path = require('path')
+
+import * as path from 'path'
+import { Lint } from '@lint-md/cli'
 
 describe('lint 继承对象测试集合', () => {
   test('有 error 出现 (see examples/)', async () => {
-    const newLinter = new ExtendLinter([path.resolve(process.cwd(), 'examples')], {})
+    const newLinter = new Lint([path.resolve(process.cwd(), 'examples')], {
+      rules: {}
+    })
+
     await newLinter.start()
     newLinter.printOverview()
-    expect(newLinter.errorCount()).toStrictEqual({
+    expect(newLinter.countError()).toStrictEqual({
       'error': 8,
       'warning': 0
     })
   })
-})
+})

dist/index.js

@@ -1,11 +1,14 @@
 {
   "name": "@lint-md/github-action",
-  "version": "0.1.0",
-  "description": "",
-  "main": "src/index.js",
+  "version": "0.1.1",
+  "description": "github action for lint-md",
+  "main": "dist/index.js",
   "scripts": {
-    "build": "webpack",
-    "test": "jest --no-cache"
+    "test": "jest --no-cache",
+    "lint": "eslint --ext .ts --ext .tsx --max-warnings 0 ./src",
+    "clean": "rimraf dist",
+    "build:dev": "yarn clean && webpack --mode development",
+    "build:prod": "yarn clean && webpack --mode production"
   },
   "repository": {
     "type": "git",
@@ -17,16 +20,40 @@
   "bugs": {
     "url": "https://github.com/yuzhanglong/hello-world-javascript-action/issues"
   },
+  "jest": {
+    "preset": "ts-jest",
+    "testEnvironment": "node",
+    "collectCoverage": true,
+    "collectCoverageFrom": [
+      "src/**/*.{js,jsx,ts,tsx}",
+      "!**/node_modules/**",
+      "!**/vendor/**"
+    ]
+  },
   "homepage": "https://github.com/yuzhanglong/hello-world-javascript-action#readme",
   "devDependencies": {
     "@actions/core": "^1.2.6",
     "@actions/github": "^4.0.0",
-    "@lint-md/cli": "^0.1.3",
-    "babel-polyfill": "^6.26.0",
+    "@lint-md/cli": "^0.1.5",
+    "@types/jest": "^26.0.22",
+    "@typescript-eslint/eslint-plugin": "^4.15.0",
+    "@typescript-eslint/parser": "^4.15.0",
+    "eslint": "^7.19.0",
+    "eslint-plugin-import": "^2.22.1",
     "jest": "^26.6.3",
+    "node-require-webpack-plugin": "^0.1.1",
+    "rimraf": "^3.0.2",
     "terser-webpack-plugin": "^5.1.1",
-    "webpack": "^5.25.1",
-    "webpack-cli": "^4.5.0",
-    "node-require-webpack-plugin": "^0.1.0"
-  }
+    "ts-jest": "^26.5.4",
+    "ts-loader": "^8.1.0",
+    "typescript": "^4.2.3",
+    "webpack": "^5.28.0",
+    "webpack-cli": "^4.5.0"
+  },
+  "type": "commonjs",
+  "files": [
+    "esm",
+    "lib",
+    "src"
+  ]
 }

package.json

@@ -1,12 +1,12 @@
 /*
- * File: index.js
+ * File: index.ts
  * Description: action 入口
  * Created: 2021-3-15 20:39:28
  * Author: yuzhanglong
  * Email: [email protected]
  */
 
-const LintMdAction = require('./lint-md-action')
+import { LintMdAction } from './lint-md-action'
 
 const runAction = async () => {
   // init LintMdAction
@@ -24,4 +24,4 @@ const runAction = async () => {
 runAction().catch(res => {
   console.log(res)
   throw new Error('unknown error!')
-})
+})

src/extend-linter.js

@@ -1,19 +1,23 @@
 /*
- * File: lint-md-action.js
+ * File: lint-md-action.ts
  * Description: lint-md github action 核心逻辑
  * Created: 2021-3-15 22:23:51
  * Author: yuzhanglong
  * Email: [email protected]
  */
 
-require('babel-polyfill')
-const core = require('@actions/core')
-const path = require('path')
-const fs = require('fs')
-const ExtendLinter = require('./extend-linter')
+import * as fs from 'fs'
+import * as path from 'path'
+import * as core from '@actions/core'
+import { Lint, CliConfig } from '@lint-md/cli/lib/index'
 
-class LintMdAction {
-  constructor(basePath) {
+export class LintMdAction {
+  private readonly basePath: string
+  private readonly config: CliConfig
+  private readonly lintFiles: string[]
+  private linter: Lint
+
+  constructor(basePath?: string) {
     if (!basePath) {
       this.basePath = process.env.GITHUB_WORKSPACE
     }
@@ -42,15 +46,19 @@ class LintMdAction {
   }
 
   isPass() {
-    const result = this.linter ? this.linter.errorCount() : {}
+    // 没有初始化直接调用 isPass, 返回 true
+    if (!this.linter) {
+      return true
+    }
+    const result = this.linter.countError()
     const noErrorAndWarn = result.error === 0 && result.warning === 0
     // 注意这里的 getInput 返回值为 string
     return core.getInput('failOnWarnings') === 'true' ? noErrorAndWarn : result.error === 0
   }
 
   async lint() {
     // 开始 lint
-    this.linter = new ExtendLinter(this.lintFiles, this.config)
+    this.linter = new Lint(this.lintFiles, this.config)
     await this.linter.start()
     return this
   }
@@ -71,8 +79,7 @@ class LintMdAction {
   }
 
   getErrors() {
-    return this.linter.getErrorFiles()
+    // @ts-ignore
+    return this.linter.errorFiles
   }
 }
-
-module.exports = LintMdAction

src/index.js src/index.ts

@@ -0,0 +1,28 @@
+/*
+ * File: test-utils.ts
+ * Description: 测试工具函数集
+ * Created: 2021-3-30 14:18:15
+ * Author: yuzhanglong
+ * Email: [email protected]
+ */
+
+import * as core from '@actions/core'
+
+// mock GitHub action 的用户参数
+export const mockAction = (files?: string, configFile?: string, failOnWarnings?: string) => {
+  jest.mock('@actions/core')
+
+  // mock getInput method
+  // @ts-ignore
+  // eslint-disable-next-line no-import-assign
+  core.getInput = (arg) => {
+    switch (arg) {
+      case 'files':
+        return files || './'
+      case 'configFile':
+        return configFile || '.lintmdrc'
+      case 'failOnWarnings':
+        return failOnWarnings || 'false'
+    }
+  }
+}