amis-formula 1.3.13 → 2.0.0-beta.0

package/dist/lexer.d.ts

@@ -1,19 +1,4 @@
-export interface LexerOptions {
-    /**
-     * 直接是运算表达式？还是从模板开始 ${} 里面才算运算表达式
-     */
-    evalMode?: boolean;
-    /**
-     * 只支持取变量。
-     */
-    variableMode?: boolean;
-    /**
-     * 是否允许 filter 语法，比如：
-     *
-     * ${abc | html}
-     */
-    allowFilter?: boolean;
-}
+import { LexerOptions, Token, TokenTypeName } from './types';
 export declare const enum TokenEnum {
     BooleanLiteral = 1,
     RAW = 2,
@@ -33,22 +18,9 @@ export declare const enum TokenEnum {
     OpenFilter = 16,
     Char = 17
 }
-export declare type TokenTypeName = 'Boolean' | 'Raw' | 'Variable' | 'OpenScript' | 'CloseScript' | 'EOF' | 'Identifier' | 'Literal' | 'Numeric' | 'Punctuator' | 'String' | 'RegularExpression' | 'TemplateRaw' | 'TemplateLeftBrace' | 'TemplateRightBrace' | 'OpenFilter' | 'Char';
 export declare const TokenName: {
     [propName: string]: TokenTypeName;
 };
-export interface Position {
-    index: number;
-    line: number;
-    column: number;
-}
-export interface Token {
-    type: TokenTypeName;
-    value: any;
-    raw?: string;
-    start: Position;
-    end: Position;
-}
 export declare function lexer(input: string, options?: LexerOptions): {
     next: () => Token;
 };

package/dist/parser.d.ts

@@ -1,27 +1,2 @@
-import { Position } from './lexer';
-export declare type NodeType = 'content' | 'raw' | 'conditional';
-export interface ParserOptions {
-    /**
-     * 直接是运算表达式？还是从模板开始 ${} 里面才算运算表达式
-     */
-    evalMode?: boolean;
-    /**
-     * 只支持取变量。
-     */
-    variableMode?: boolean;
-    /**
-     * 是否允许 filter 语法，比如：
-     *
-     * ${abc | html}
-     */
-    allowFilter?: boolean;
-    variableNamespaces?: Array<string>;
-}
-export interface ASTNode {
-    type: string;
-    start: Position;
-    end: Position;
-    [propname: string]: any;
-}
-export declare type ASTNodeOrNull = ASTNode | null;
+import { ParserOptions, ASTNode } from './types';
 export declare function parse(input: string, options?: ParserOptions): ASTNode;

package/dist/types.d.ts

@@ -0,0 +1,83 @@
+import { Evaluator } from './evalutor';
+export interface FilterMap {
+    [propName: string]: (this: FilterContext, input: any, ...args: any[]) => any;
+}
+export interface FunctionMap {
+    [propName: string]: (this: Evaluator, ast: Object, data: any) => any;
+}
+export interface FilterContext {
+    data: Object;
+    filter?: {
+        name: string;
+        args: Array<any>;
+    };
+    restFilters: Array<{
+        name: string;
+        args: Array<any>;
+    }>;
+}
+export interface EvaluatorOptions {
+    /**
+     * 可以外部传入 ast 节点处理器，定制或者扩充自定义函数
+     */
+    functions?: FunctionMap;
+    /**
+     * 可以外部扩充 filter
+     */
+    filters?: FilterMap;
+    defaultFilter?: string;
+}
+export interface LexerOptions {
+    /**
+     * 直接是运算表达式？还是从模板开始 ${} 里面才算运算表达式
+     */
+    evalMode?: boolean;
+    /**
+     * 只支持取变量。
+     */
+    variableMode?: boolean;
+    /**
+     * 是否允许 filter 语法，比如：
+     *
+     * ${abc | html}
+     */
+    allowFilter?: boolean;
+}
+export declare type TokenTypeName = 'Boolean' | 'Raw' | 'Variable' | 'OpenScript' | 'CloseScript' | 'EOF' | 'Identifier' | 'Literal' | 'Numeric' | 'Punctuator' | 'String' | 'RegularExpression' | 'TemplateRaw' | 'TemplateLeftBrace' | 'TemplateRightBrace' | 'OpenFilter' | 'Char';
+export interface Position {
+    index: number;
+    line: number;
+    column: number;
+}
+export interface Token {
+    type: TokenTypeName;
+    value: any;
+    raw?: string;
+    start: Position;
+    end: Position;
+}
+export declare type NodeType = 'content' | 'raw' | 'conditional';
+export interface ParserOptions {
+    /**
+     * 直接是运算表达式？还是从模板开始 ${} 里面才算运算表达式
+     */
+    evalMode?: boolean;
+    /**
+     * 只支持取变量。
+     */
+    variableMode?: boolean;
+    /**
+     * 是否允许 filter 语法，比如：
+     *
+     * ${abc | html}
+     */
+    allowFilter?: boolean;
+    variableNamespaces?: Array<string>;
+}
+export interface ASTNode {
+    type: string;
+    start: Position;
+    end: Position;
+    [propname: string]: any;
+}
+export declare type ASTNodeOrNull = ASTNode | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "amis-formula",
-  "version": "1.3.13",
+  "version": "2.0.0-beta.0",
   "description": "负责 amis 里面的表达式实现，内置公式，编辑器等",
   "main": "dist/index.js",
   "scripts": {

package/rollup.config.js

@@ -30,6 +30,7 @@ export default {
       plugins: [
         isForLib && terser()
       ],
+      strict: !isForLib,
       footer: isForLib ? `var evaluate = formula.evaluate;
       var momentFormat = formula.momentFormat;
       var parse = formula.parse;` : '',
@@ -67,7 +68,8 @@ export default {
     json(),
     resolve({
       jsnext: true,
-      main: true
+      main: true,
+      browser: true
     }),
     typescript({
       typescript: require('typescript')

package/scripts/genDoc.ts

@@ -0,0 +1,162 @@
+import path = require('path');
+import fs = require('fs');
+import doctrine = require('doctrine');
+
+const workDir = path.resolve(path.dirname(__dirname));
+const jsFile = path.join(workDir, 'src/evalutor.ts');
+const outputFile = path.join(workDir, 'dist/doc.js');
+const outputMD = path.join(workDir, 'dist/doc.md');
+
+function getFormulaComments(contents: string) {
+  const comments: Array<{
+    fnName: string;
+    comments: string;
+  }> = [];
+
+  contents.replace(/\/\*[\s\S]+?\*\//g, (_, index, input) => {
+    const pos = index + _.length;
+    const following = input.substring(pos, pos + 200);
+
+    if (/^\s*fn(\w+)\(/.test(following)) {
+      comments.push({
+        fnName: RegExp.$1,
+        comments: _
+      });
+    }
+
+    return _;
+  });
+
+  return comments;
+}
+
+function formatType(tag: any): string {
+  // console.log(tag);
+  if (tag.type === 'RestType') {
+    return `...${formatType(tag.expression)}`;
+  } else if (tag.type === 'TypeApplication') {
+    return `Array<${tag.applications
+      .map((item: any) => formatType(item))
+      .join(',')}>`;
+  }
+
+  return tag.name;
+}
+
+async function main(...params: Array<any>) {
+  const contents = fs.readFileSync(jsFile, 'utf8');
+
+  const comments = getFormulaComments(contents);
+  const result = comments.map(item => {
+    const ast = doctrine.parse(item.comments, {
+      unwrap: true
+    });
+    const result: any = {
+      name: item.fnName,
+      description: ast.description
+    };
+
+    let example = '';
+    let params: Array<any> = [];
+    let returns: any = undefined;
+    let namespace = '';
+    ast.tags.forEach(tag => {
+      if (tag.title === 'example') {
+        example = tag.description!;
+      } else if (tag.title === 'namespace') {
+        namespace = tag.name!;
+      } else if (tag.title === 'param') {
+        params.push({
+          type: formatType(tag.type),
+          name: tag.name,
+          description: tag.description
+        });
+      } else if (tag.title === 'returns') {
+        returns = {
+          type: formatType(tag.type),
+          description: tag.description
+        };
+      }
+    });
+
+    result.example = example;
+    result.params = params;
+    result.returns = returns;
+    result.namespace = namespace;
+
+    return result;
+  });
+
+  fs.writeFileSync(
+    outputFile,
+    `/**\n * 公式文档\n */\nexports.doc = ${JSON.stringify(
+      result,
+      null,
+      2
+    )}`.replace(/\"(\w+)\"\:/g, (_, key) => `${key}:`),
+    'utf8'
+  );
+  console.log(`公式文档生成 > ${outputFile}`);
+  fs.writeFileSync(
+    outputFile.replace(/\.js$/, '.d.ts'),
+    //  可以通过以下命令生成
+    // tsc --declaration --emitDeclarationOnly --allowJs doc.js
+    [
+      `export var doc: {`,
+      `  name: string;`,
+      `  description: string;`,
+      `  example: string;`,
+      `  params: {`,
+      `      type: string;`,
+      `      name: string;`,
+      `      description: string;`,
+      `  }[];`,
+      `  returns: {`,
+      `      type: string;`,
+      `      description: string;`,
+      `  };`,
+      `  namespace: string;`,
+      `}[];`
+    ].join('\n'),
+    'utf8'
+  );
+
+  const grouped: any = {};
+  result.forEach((item: any) => {
+    const scope = item.namespace || '其他';
+    const arr = grouped[scope] || (grouped[scope] = []);
+
+    arr.push(item);
+  });
+
+  let md = '';
+  Object.keys(grouped).forEach(key => {
+    md += `## ${key}\n\n`;
+
+    grouped[key].forEach((item: any) => {
+      md += `### ${item.name}\n\n`;
+
+      md += `用法：\`${item.example}\`\n\n`;
+
+      if (item.params.length) {
+        // md += `参数：\n`;
+
+        item.params.forEach((param: any) => {
+          md += ` * \`${param.name}:${param.type}\` ${param.description}\n`;
+        });
+
+        if (item.returns) {
+          md += `\n返回：\`${item.returns.type}\` ${
+            item.returns.description || ''
+          }\n\n`;
+        }
+      }
+
+      md += `${item.description}\n\n`;
+    });
+  });
+  fs.writeFileSync(outputMD, md, 'utf8');
+  console.log(`公式md生成 > ${outputMD}`);
+}
+
+main().catch(e => console.error(e));

package/scripts/lib.ts

@@ -0,0 +1,55 @@
+import {parse, evaluate} from '../src';
+import moment from 'moment';
+
+// 来自 https://vanillajstoolkit.com/polyfills/arrayfind/
+if (!Array.prototype.find) {
+  Array.prototype.find = function (callback) {
+    // 1. Let O be ? ToObject(this value).
+    if (this == null) {
+      throw new TypeError('"this" is null or not defined');
+    }
+
+    var o = Object(this);
+
+    // 2. Let len be ? ToLength(? Get(O, "length")).
+    var len = o.length >>> 0;
+
+    // 3. If IsCallable(callback) is false, throw a TypeError exception.
+    if (typeof callback !== 'function') {
+      throw new TypeError('callback must be a function');
+    }
+
+    // 4. If thisArg was supplied, let T be thisArg; else let T be undefined.
+    var thisArg = arguments[1];
+
+    // 5. Let k be 0.
+    var k = 0;
+
+    // 6. Repeat, while k < len
+    while (k < len) {
+      // a. Let Pk be ! ToString(k).
+      // b. Let kValue be ? Get(O, Pk).
+      // c. Let testResult be ToBoolean(? Call(callback, T, « kValue, k, O »)).
+      // d. If testResult is true, return kValue.
+      var kValue = o[k];
+      if (callback.call(thisArg, kValue, k, o)) {
+        return kValue;
+      }
+      // e. Increase k by 1.
+      k++;
+    }
+
+    // 7. Return undefined.
+    return undefined;
+  };
+}
+
+export function momentFormat(
+  input: any,
+  inputFormat: string,
+  outputFormat: string
+) {
+  return moment(input, inputFormat).format(outputFormat);
+}
+
+export {parse, evaluate, moment};