update README.md

Author: lc-cn

README.md

@@ -1,31 +1,50 @@
-# ts-dev-template
-ts 开发基础配置环境
-## Notice
-这是一个模板仓库，可用于初始化Ts开发时的一些推荐配置
-## Usage
-1.调用模板创建仓库
+# text-parsing
+可扩展的nodejs 文本解析库
+## 安装
 ```shell
-点击仓库首页右边绿色按钮(Use This Template)或访问https://github.com/lc-cn/ts-dev-template/generate，根据github提示创建仓库
+npm install text-parsing
+# or
+yarn add text-parsing
 ```
-2.拉取你刚刚创建的仓库(`<>`表示括号内描述的内容为必填)
-```shell
-git clone <你刚刚创建的仓库地址>
-```
-2.安装依赖
-```shell
-npm install
-# 或 npm i
+## 使用样例
+### 1. 直接使用解析器
+```javascript
+//假设今日为2022-01-01
+const {TimeParser} = require('text-parsing')
+const tp=new TimeParser()
+console.log(tp.parse('明天晚上8点半开会',{format:'YYYY-MM-DD hh:mm:ss'}))
+//打印结果：2022-01-02 08:30:00
 ```
-3.运行开发环境(ts-node-dev运行ts代码)
-```shell
-npm run dev
+### 2. 使用ParserManger同时使用多个解析器
+```javascript
+const {ParserManger}=require('text-parsing')
+const pm=new ParserManger()
+pm.use('timeParser',{format:'YYYY-MM-DD',timeBase:new Date('2022-01-01')})
+console.log(pm.parse('下周二一起聚餐'))
+//打印结果：{ timeParser:'2022-01-04' },如果有其他解析器，会将结果一同返回
 ```
-4.将ts编译成js(编译代码成普通node可执行的js代码)
-```shell
-npm run build
-```
-5.执行编译后的js(通常生产环境调用)
-```shell
-npm start
-# 或 npm run start
+### 3.定义自己的解析器
+你可以通过继承BaseParser实现任意你想实现的解析器
+
+```typescript
+// cardParser.ts
+import {BaseParser} from 'text-parsing'
+
+class CardParser extends BaseParser<string> {
+    constructor() {
+        super('cardParser')
+    }
+    // 定义文本接收函数
+    parse(expression: string,options?:{location:string}) {
+        // do sth
+        return expression.replace(expression,/!([\d]{17}[0-9|x|X]{1})/)//此处的返回值类型需在BaseParser的泛型中声明，否则在ts中将无法获得正确代码提示
+    }
+}
+
+// index.ts
+import {ParserManager} from "text-parsing";
+import {CardParser} from './cardParser'
+const pm=new ParserManager()
+pm.use(new ParserManager(),{location:'china'})//use的第二个参数将传递给parser的parse函数的option
+console.log(pm.parse('515323194803141144'))
 ```

package.json

@@ -1,30 +1,30 @@
 {
-  "name": "@lc-cn/ts-dev-template",
+  "name": "text-parsing",
   "version": "1.0.0",
-  "description": "ts开发环境配置",
+  "description": "可扩展的nodejs 文本解析库",
   "main": "lib/index.js",
   "scripts": {
-    "start": "node .",
+    "start": "node ./lib/test.js",
     "build": "tsc --project tsconfig.json && tsc-alias -p tsconfig.json",
-    "dev": "ts-node-dev -r tsconfig-paths/register ./src/index.ts",
+    "dev": "ts-node-dev -r tsconfig-paths/register ./src/test.ts",
     "pub": "npm publish --access public",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/lc-cn/ts-dev-template.git"
+    "url": "git+https://github.com/liucl-cn/text-parsing.git"
   },
   "keywords": [
     "ts",
-    "dev",
-    "template"
+    "text",
+    "parsing"
   ],
   "author": "凉菜",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/lc-cn/ts-dev-template/issues"
+    "url": "https://github.com/liucl-cn/text-parsing/issues"
   },
-  "homepage": "https://github.com/lc-cn/ts-dev-template#readme",
+  "homepage": "https://github.com/liucl-cn/text-parsing#readme",
   "devDependencies": {
     "@types/node": "latest",
     "ts-node-dev": "latest",

src/hello.ts

@@ -1,2 +1,4 @@
-import {sayHello} from "@/hello";
-console.log(sayHello('world'))
+import {ParserManager} from "./parser";
+export * from './parser'
+export * from './module'
+export default ParserManager

src/index.ts

@@ -0,0 +1 @@
+export {default as TimeParser} from './timeParser'

src/module/index.ts

@@ -0,0 +1,54 @@
+import {preHander} from './strPreHanding';
+import {TimeUnit} from './timeUnit';
+import {BaseParser} from "@/parser";
+export interface TimeOptions{
+    timeBase?:Date;
+    format?:string;
+}
+export default class TimeParser extends BaseParser<string|Date>{
+    public timeBase:Date
+    public expression:string
+    public isPreferFuture:boolean
+    constructor() {
+        super('timeParser');
+        this.timeBase = null;
+        this.expression = '';
+        this.isPreferFuture = true;
+    }
+    turnOffPreferFuture(){
+        this.isPreferFuture=false
+    }
+    getTimeBase(){
+        return this.timeBase
+    }
+    setTimeBase(s:Date){
+        this.timeBase=s
+    }
+    parse(expression:string,options?:TimeOptions):Date|string{
+        let format:string,timeBase:Date;
+        if(options){
+            timeBase = options.timeBase;
+            format = options.format;
+        }
+        this.expression = expression;
+        const exp = this._preHandling(expression);
+        if (timeBase) {
+            if (typeof timeBase === 'string') {
+                this.timeBase = new Date(timeBase);
+            } else {
+                this.timeBase = timeBase;
+            }
+        } else {
+            this.timeBase = new Date();
+        }
+        let tu = new TimeUnit(exp, this.isPreferFuture, this.timeBase);
+        return tu.timeNormalization(format);
+    }
+    private _preHandling(expression:string){
+        expression = preHander.delKeyword(expression, '\\s+'); // 清理空白符
+        expression = preHander.delKeyword(expression, '[的]+'); // 清理语气助词
+        expression = preHander.DBC2CDB(expression); // 全角转半角
+        expression = preHander.numberTranslator(expression); // 大写数字转化
+        return expression;
+    }
+}

src/module/timeParser/index.ts

@@ -0,0 +1,87 @@
+import * as util from '@/utils'
+const zhNumChar={
+    零: 0,
+    一: 1,
+    两: 2,
+    二: 2,
+    三: 3,
+    四: 4,
+    五: 5,
+    六: 6,
+    七: 7,
+    八: 8,
+    九: 9
+}
+const zhNumValue={
+    十: { value: 10, secUnit: false },
+    百: { value: 100, secUnit: false },
+    千: { value: 1000, secUnit: false },
+    万: { value: 10000, secUnit: true },
+    亿: { value: 100000000, secUnit: true }
+}
+export const preHander={
+    delKeyword(target, rules) {
+        var r = new RegExp(rules, 'g');
+        return target.replace(r, '');
+    },
+
+    numberTranslator(target) {
+        var tmp = util.reverseStr(target);
+        var rule = new RegExp('[末天日](?=(周|期星))', 'g');
+        tmp = tmp.replace(rule, '7');
+        target = util.reverseStr(tmp);
+
+        var section = 0;
+        var number = 0;
+        var rtn = 0;
+        var secUnit = false;
+        var str = target.split('');
+        var result = '';
+        var flag = false;
+        for (var i = 0; i < str.length; i++) {
+            if (zhNumChar.hasOwnProperty(str[i]) || zhNumValue.hasOwnProperty(str[i])) {
+                flag = true;
+                if (zhNumChar.hasOwnProperty(str[i])) {
+                    number = zhNumChar[str[i]];
+                } else {
+                    var unit = zhNumValue[str[i]].value;
+                    secUnit = zhNumValue[str[i]].secUnit;
+                    if (secUnit) {
+                        section = (section + number) * unit;
+                        rtn += section;
+                        section = 0;
+                    } else {
+                        section += number * unit;
+                    }
+                    number = 0;
+                }
+            } else {
+                if (flag) {
+                    result += (rtn + section + number).toString();
+                    flag = false;
+                    number = 0;
+                    section = 0;
+                    rtn = 0;
+                    secUnit = false;
+                }
+                result += str[i];
+            }
+        }
+        if (flag) {
+            result += (rtn + section + number).toString();
+        }
+        return result;
+    },
+
+    DBC2CDB(target) {
+        var tmp = '';
+        for (var i = 0; i < target.length; i++) {
+            if (target.charCodeAt(i) > 65248 && target.charCodeAt(i) < 65375) {
+                tmp += String.fromCharCode(target.charCodeAt(i) - 65248);
+            } else {
+                tmp += String.fromCharCode(target.charCodeAt(i));
+            }
+        }
+        return tmp;
+    }
+}

src/module/timeParser/strPreHanding.ts

@@ -0,0 +1,11 @@
+export class TimePoint{
+    public tunit:number[]
+    constructor(date?:string|number|Date) {
+        if (date) {
+            var d = new Date(date);
+            this.tunit = [d.getFullYear(), d.getMonth() + 1, d.getDate(), d.getHours(), d.getMinutes(), d.getSeconds()];
+        } else {
+            this.tunit = [-1, -1, -1, -1, -1, -1];
+        }
+    }
+}