refactor: refactor project by typescript (#2)

* chore: init typescript develop environment

* refactor: add types for ast-plugin

* test: add test case for throwErrFn

* chore: remove .npmignore, use 'files' instead

* ci: add test github workflows

* chore: update some configurations

* feat: expose type definitions

* chore(release): publish v1.0.0

* chore: add useful command for npm scripts

Author: yuzhanglong

.babelrc

@@ -0,0 +1,15 @@
+name: build
+
+on: [ pull_request ]
+
+jobs:
+  unit-test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install modules
+        run: yarn install
+
+      - name: Run tests
+        run: yarn test

.github/workflows/build.yml

@@ -1,3 +1,17 @@
-lib
-coverage
+# IDE configurations
+.idea
+.vscode
+
+# Dependency directories
 node_modules
+
+# coverage files
+coverage
+
+# lock files
+package-lock.json
+yarn.lock
+
+# build files
+esm
+lib

.gitignore

@@ -0,0 +1,6 @@
+{
+  "tabWidth": 2,
+  "semi": true,
+  "singleQuote": true,
+  "jsxBracketSameLine": true
+}

.npmignore

@@ -1,17 +1,16 @@
-# ast-plugin
+# @lint-md/ast-plugin
 
 > The simplest abstract syntax tree walker.
 
+[![Build Status](https://github.com/lint-md/ast-plugin/actions/workflows/build.yml/badge.svg)](https://github.com/lint-md/ast-plugin/actions/workflows/build.yml)
 
 ## Install
 
 > npm i --save ast-plugin
 
-
-
 ## Usage
 
- - Traverse Ast plugins
+- Traverse Ast plugins
 
 ```js
 import { Ast, Plugin } from 'ast-plugin';
@@ -22,14 +21,15 @@ new Ast(ast).traverse([
 ]);
 ```
 
- - Write an ast plugin
+- Write an ast plugin
 
 ```js
 import { Ast, Plugin } from 'ast-plugin';
 
 class TestPlugin extends Plugin {
 
-  pre = () => {};
+  pre = () => {
+  };
 
   visitor = () => {
     return {
@@ -41,18 +41,14 @@ class TestPlugin extends Plugin {
     };
   };
 
-  post = () => {};
+  post = () => {
+  };
 }
 ```
 
-
-
 ## Used by
 
- - [lint-md](https://github.com/hustcc/lint-md): Cli tool to lint your markdown file for Chinese.
-
-
-
+- [lint-md](https://github.com/lint-md/lint-md) Cli tool to lint your markdown file for Chinese.
 
 ## License
 

.prettierrc.json

@@ -13,6 +13,9 @@ export class TestPlugin extends Plugin {
     return {
       text: ast => {
         this.do(ast);
+        this.cfg.throwError({
+          name: 'Hello, I threw an exception!'
+        });
       },
       heading: ast => {
         this.doHeading(ast);

.travis.yml

@@ -1,30 +1,51 @@
-import unified from 'unified';
-import markdown from 'remark-parse';
-
+import * as unified from 'unified';
+import * as markdown from 'remark-parse';
 import { Ast, Plugin } from '../src/';
 import { setGlobalConfig, getGlobalConfig } from '../src/global';
 import { TestPlugin } from './TestPlugin';
 
-const plugin1 = new TestPlugin('p1');
-const plugin2 = new TestPlugin('p2');
-
 describe('index', () => {
+
   test('exports', () => {
     expect(Ast).not.toBe(undefined);
     expect(Plugin).not.toBe(undefined);
   });
 
   test('Ast', () => {
-    expect(plugin1.cfg).toBe('p1');
-    expect(plugin2.cfg).toBe('p2');
+    let throwErrFn = jest.fn();
+    const plugin1 = new TestPlugin({
+      throwError: throwErrFn,
+      config: {
+        name: 'p1'
+      }
+    });
+
+    const plugin2 = new TestPlugin({
+      throwError: throwErrFn,
+      config: {
+        name: 'p2'
+      }
+    });
+    expect(plugin1.cfg).toStrictEqual({
+      'config': {
+        'name': 'p1'
+      },
+      'throwError': throwErrFn
+    });
+    expect(plugin2.cfg).toStrictEqual({
+      'config': {
+        'name': 'p2'
+      },
+      'throwError': throwErrFn
+    });
 
     const ast = unified()
       .use(markdown)
       .parse('> Hello **world**!\n\n# ~~hustcc~~');
 
     const plugins = [
       plugin1,
-      plugin2,
+      plugin2
     ];
 
     new Ast(ast).traverse(plugins);
@@ -62,26 +83,44 @@ cont a = 1;
 const b = 2;
 \`\`\``;
 
-    let ast = unified()
+    let mdAst = unified()
       .use(markdown)
       .parse(md);
 
-    ast = new Ast(ast, undefined, md);
+    let ast = new Ast(mdAst, undefined, md);
 
     const code = ast.get('children.0');
 
     expect(code.segment()).toBe(md);
 
     md = '> Hello **world**!';
-    ast = unified()
+    mdAst = unified()
       .use(markdown)
       .parse(md);
 
-    ast = new Ast(ast, undefined, md);
+    ast = new Ast(mdAst, undefined, md);
 
     expect(ast.get('children.0.children.0').segment()).toBe('Hello **world**!');
   });
 
+  test('throwError call', () => {
+    const throwErrFn = jest.fn();
+    const testErrorPlugin = new TestPlugin({
+      throwError: throwErrFn
+    });
+    const md = 'bad content that break some rules...';
+    let mdAst = unified()
+      .use(markdown)
+      .parse(md);
+
+    const ast = new Ast(mdAst, undefined, md);
+    ast.traverse([testErrorPlugin, testErrorPlugin]);
+    expect(throwErrFn).toBeCalledTimes(2);
+    expect(throwErrFn).toBeCalledWith({
+      'name': 'Hello, I threw an exception!'
+    });
+  });
+
   test('global configure', () => {
     expect(getGlobalConfig()).toEqual({ typeKey: 'type', childrenKey: 'children' });
 

README.md

@@ -1,16 +1,19 @@
 {
-  "name": "ast-plugin",
-  "version": "0.0.7",
+  "name": "@lint-md/ast-plugin",
+  "version": "1.0.0",
   "description": "The simplest abstract syntax tree walker.",
   "main": "lib/index.js",
+  "module": "esm/index.js",
   "scripts": {
     "test": "jest --no-cache",
-    "coveralls": "cat ./coverage/lcov.info | coveralls",
-    "build": "rimraf ./lib && babel src -d lib"
+    "lib:cjs": "tsc -p tsconfig.json --target ES5 --module commonjs --outDir lib",
+    "lib:esm": "tsc -p tsconfig.json --target ES5 --module ESNext --outDir esm",
+    "clean": "rimraf lib esm",
+    "build": "run-p lib:*"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/hustcc/ast-plugin.git"
+    "url": "git+https://github.com/lint-md/ast-plugin.git"
   },
   "keywords": [
     "ast",
@@ -19,31 +22,32 @@
   ],
   "author": "hustcc",
   "license": "MIT",
+  "files": [
+    "lib",
+    "esm",
+    "src"
+  ],
   "bugs": {
-    "url": "https://github.com/hustcc/ast-plugin/issues"
+    "url": "https://github.com/lint-md/ast-plugin/issues"
   },
-  "homepage": "https://github.com/hustcc/ast-plugin#readme",
+  "homepage": "https://github.com/lint-md/ast-plugin#readme",
   "devDependencies": {
-    "@babel/cli": "^7.1.5",
-    "@babel/core": "^7.1.5",
-    "@babel/plugin-proposal-class-properties": "^7.1.0",
-    "@babel/plugin-transform-spread": "^7.0.0",
-    "@babel/preset-env": "^7.1.5",
-    "babel-core": "^7.0.0-bridge.0",
-    "babel-jest": "^23.6.0",
-    "babel-plugin-version": "^0.2.3",
-    "coveralls": "^3.0.2",
-    "jest": "^23.6.0",
+    "@types/jest": "^26.0.20",
+    "jest": "^26.6.3",
+    "npm-run-all": "^4.1.5",
     "remark-parse": "^6.0.2",
-    "rimraf": "^2.6.2",
+    "rimraf": "^3.0.2",
+    "ts-jest": "^26.5.3",
+    "typescript": "^4.2.3",
     "unified": "^7.0.1"
   },
   "jest": {
+    "preset": "ts-jest",
     "collectCoverage": true,
     "testEnvironment": "node",
-    "testRegex": "(/__tests__/.*\\.(test|spec))\\.jsx?$",
+    "testRegex": "(/__tests__/.*\\.(test|spec))\\.tsx?$",
     "collectCoverageFrom": [
-      "src/**/*.{js,jsx}"
+      "src/**/*.{ts,tsx}"
     ]
   }
 }