fix(types): fix type check & security issues (#538)

* fix(types): fix type check issues * chore(*): fix yarnrc registry configuration * chore(*): fix type check errors * chore(glob-watcher): force glob-watcher@6.0.0 in resolution
Tencent · Aug 21, 2023 · 0f036e9 · 0f036e9
1 parent 231281a
commit 0f036e9
Show file tree

Hide file tree

Showing 13 changed files with 87 additions and 102 deletions.
diff --git a/.npmrc b/.npmrc
@@ -0,0 +1 @@
+registry="https://registry.npmjs.org"
diff --git a/.yarnrc b/.yarnrc
@@ -1 +1 @@
-registry "https://registry.npmjs.org"
+registry: https://registry.npmjs.org
diff --git a/package.json b/package.json
@@ -138,7 +138,7 @@
     "standard-version": "^9.3.2",
     "ts-jest": "^27.1.1",
     "ts-node": "^10.7.0",
-    "typescript": "4.3.5",
+    "typescript": "4.5.5",
     "virtual-dom": "^2.1.1"
   },
   "dependencies": {
@@ -152,7 +152,8 @@
     "lodash.template": "4.5.0",
     "yargs-parser": "20.2.9",
     "xmldom": "0.5.0",
-    "ansi-regex": "5.0.1"
+    "ansi-regex": "5.0.1",
+    "glob-watcher": "6.0.0"
   },
   "config": {
     "commitizen": {
@@ -168,4 +169,4 @@
   "engines": {
     "node": ">=14"
   }
-}
+}
diff --git a/src/CherryStatic.js b/src/CherryStatic.js
@@ -62,4 +62,9 @@ export class CherryStatic {
     // @ts-ignore
     PluginClass.$cherry$mounted = true;
   }
+
+  // for type check only
+  // TODO: fix this error
+  // eslint-disable-next-line no-useless-constructor
+  constructor(...args) {}
 }
diff --git a/src/core/hooks/Emphasis.js b/src/core/hooks/Emphasis.js
@@ -52,9 +52,13 @@ export default class Emphasis extends SyntaxBase {
       $str = $str.replace(/(^|\n[\s]*)(\*{2,})((?:.*?)(?:(?:\n.*?)*?))\2/g, converAsterisk);
       $str = $str.replace(/([^\n*\\\s][ ]*)(\*+)((?:.*?)(?:(?:\n.*?)*?))\2/g, converAsterisk);
     } else {
+      // TODO: fix this error
+      // @ts-expect-error
       $str = $str.replace(this.RULE.asterisk.reg, converAsterisk);
     }
 
+    // TODO: fix this error
+    // @ts-expect-error
     $str = $str.replace(this.RULE.underscore.reg, (match, leading, symbol, text, index, string) => {
       if (text.trim() === '') {
         return match;
@@ -84,6 +88,10 @@ export default class Emphasis extends SyntaxBase {
     return this.RULE[flavor].reg && this.RULE[flavor].reg.test(str);
   }
 
+  /**
+   * TODO: fix type errors, prefer use `rules` for multiple spec instead
+   * @returns
+   */
   rule({ config } = { config: undefined }) {
     const allowWhitespace = config ? !!config.allowWhitespace : false;
     const REGEX = allowWhitespace
@@ -104,6 +112,6 @@ export default class Emphasis extends SyntaxBase {
 
     asterisk.reg = compileRegExp(asterisk, 'g');
     underscore.reg = compileRegExp(underscore, 'g');
-    return { asterisk, underscore };
+    return /** @type {any} */ ({ asterisk, underscore });
   }
 }
diff --git a/src/core/hooks/Header.js b/src/core/hooks/Header.js
@@ -195,6 +195,10 @@ export default class Header extends ParagraphBase {
     return this.RULE[flavor].reg && this.RULE[flavor].reg.test(str);
   }
 
+  /**
+   * TODO: fix type errors, prefer use `rules` for multiple spec instead
+   * @returns
+   */
   rule() {
     // setext Header
     // TODO: 支持多行标题
@@ -221,6 +225,6 @@ export default class Header extends ParagraphBase {
     this.strict && (atx.begin += '(?=\\h+)'); // (?=\\s+) for strict mode
     atx.reg = compileRegExp(atx, 'g', true);
 
-    return { setext, atx };
+    return /** @type {any} */ ({ setext, atx });
   }
 }
diff --git a/src/core/hooks/Strikethrough.js b/src/core/hooks/Strikethrough.js
@@ -41,12 +41,12 @@ export default class Strikethrough extends SyntaxBase {
   }
 
   rule({ config } = { config: undefined }) {
-    /** @type {Partial<import('~types/syntax').BasicHookRegexpRule>} */
-    let ret = {};
+    /** @type {import('~types/syntax').BasicHookRegexpRule} */
+    let ret = /** @type {any} */ ({});
     if (!!config.needWhitespace) {
-      ret = { begin: '(^|[\\s])\\~T\\~T', end: '\\~T\\~T(?=\\s|$)', content: '([\\w\\W]+?)' };
+      ret = { ...ret, begin: '(^|[\\s])\\~T\\~T', end: '\\~T\\~T(?=\\s|$)', content: '([\\w\\W]+?)' };
     } else {
-      ret = { begin: '(^|[^\\\\])\\~T\\~T', end: '\\~T\\~T', content: '([\\w\\W]+?)' };
+      ret = { ...ret, begin: '(^|[^\\\\])\\~T\\~T', end: '\\~T\\~T', content: '([\\w\\W]+?)' };
     }
     ret.reg = new RegExp(ret.begin + ret.content + ret.end, 'g');
     return ret;

diff --git a/src/core/hooks/Suggester.js b/src/core/hooks/Suggester.js
@@ -264,9 +264,9 @@ export default class Suggester extends SyntaxBase {
       `${isLookbehindSupported() ? '((?<!\\\\))[ ]' : '(^|[^\\\\])[ ]'}(${keys})(([^${keys}\\s])+)`,
       'g',
     );
-    return {
+    return /** @type {any} */ ({
       reg,
-    };
+    });
   }
 
   mounted() {

diff --git a/src/core/hooks/Table.js b/src/core/hooks/Table.js
@@ -256,7 +256,11 @@ export default class Table extends ParagraphBase {
     return this.RULE[flavor].reg && this.RULE[flavor].reg.test(str);
   }
 
+  /**
+   * TODO: fix type errors
+   * @returns
+   */
   rule() {
-    return getTableRule();
+    return /** @type {any} */ (getTableRule());
   }
 }
diff --git a/src/core/hooks/Toc.js b/src/core/hooks/Toc.js
@@ -54,6 +54,8 @@ export default class Toc extends ParagraphBase {
   beforeMakeHtml(str) {
     let $str = str;
     if (this.test($str, 'extend')) {
+      // TODO: fix this error
+      // @ts-expect-error
       $str = $str.replace(this.RULE.extend.reg, (match, lines, toc) => {
         if (!this.allowMultiToc && !this.isFirstTocToken) {
           // 需要补齐非捕获的\n，以及第一个分组中的\n
@@ -65,6 +67,8 @@ export default class Toc extends ParagraphBase {
       });
     }
     if (this.test($str, 'standard')) {
+      // TODO: fix this error
+      // @ts-expect-error
       $str = $str.replace(this.RULE.standard.reg, (match, lines, toc) => {
         if (!this.allowMultiToc && !this.isFirstTocToken) {
           // 需要补齐非捕获的\n，以及第一个分组中的\n
@@ -245,10 +249,14 @@ export default class Toc extends ParagraphBase {
       match.replace(/(\]\]|\]|】】)([<~])/, '$1\n$2'),
     );
     // 首先识别扩展语法
+    // TODO: fix this error
+    // @ts-expect-error
     $str = $str.replace(this.RULE.extend.reg, (match, preLinesMatch) =>
       this.$makeToc(headerList, str2Md5, preLinesMatch),
     );
     // 处理标准语法
+    // TODO: fix this error
+    // @ts-expect-error
     $str = $str.replace(this.RULE.standard.reg, (match, preLinesMatch) =>
       this.$makeToc(headerList, str2Md5, preLinesMatch),
     );
@@ -261,6 +269,10 @@ export default class Toc extends ParagraphBase {
     return this.RULE[flavor].reg ? this.RULE[flavor].reg.test(str) : false;
   }
 
+  /**
+   * TODO: fix type errors, prefer use `rules` for multiple spec instead
+   * @returns
+   */
   rule() {
     const extend = {
       begin: '(?:^|\\n)(\\n*)',
@@ -270,6 +282,6 @@ export default class Toc extends ParagraphBase {
     extend.reg = new RegExp(extend.begin + extend.content + extend.end, 'g');
     const standard = { begin: '(?:^|\\n)(\\n*)', end: '(?=$|\\n)', content: '[ ]*(\\[(?:toc|TOC)\\])[ ]*' };
     standard.reg = new RegExp(standard.begin + standard.content + standard.end, 'g');
-    return { extend, standard };
+    return /** @type {any} */ ({ extend, standard });
   }
 }
diff --git a/src/core/hooks/Transfer.js b/src/core/hooks/Transfer.js
@@ -23,9 +23,12 @@ export default class Transfer extends SyntaxBase {
   // }
 
   rule() {
-    const ret = {};
-    ret.reg = new RegExp('');
-    return ret;
+    return {
+      begin: '',
+      content: '',
+      end: '',
+      reg: new RegExp(''),
+    };
   }
 
   beforeMakeHtml(str) {

diff --git a/src/utils/regexp.js b/src/utils/regexp.js
@@ -165,9 +165,15 @@ export function getCodeBlockRule() {
     begin: /(?:^|\n)(\n*((?:>[\t ]*)*)(?:[^\S\n]*))(`{3,})([^`]*?)\n/,
     content: /([\w\W]*?)/, // '([\\w\\W]*?)',
     end: /[^\S\n]*\3[ \t]*(?=$|\n+)/, // '\\s*```[ \\t]*(?=$|\\n+)',
+    reg: new RegExp(''),
   };
   codeBlock.reg = new RegExp(codeBlock.begin.source + codeBlock.content.source + codeBlock.end.source, 'g');
-  return codeBlock;
+  return {
+    ...codeBlock,
+    begin: codeBlock.begin.source,
+    content: codeBlock.content.source,
+    end: codeBlock.end.source,
+  };
 }
 
 /**