refactor: refactor types

D-Sketon · Jan 9, 2024 · a2432d6 · a2432d6
1 parent 46c4809
commit a2432d6
Show file tree

Hide file tree

Showing 9 changed files with 39 additions and 14 deletions.
diff --git a/lib/extend/console.ts b/lib/extend/console.ts
@@ -1,5 +1,6 @@
 import Promise from 'bluebird';
 import abbrev from 'abbrev';
+import type { NodeJSLikeCallback } from '../types';
 
 type Option = Partial<{
   usage: string;
@@ -19,7 +20,7 @@ interface Args {
   _: string[];
   [key: string]: string | boolean | string[];
 }
-type AnyFn = (args: Args) => any;
+type AnyFn = (args: Args, callback?: NodeJSLikeCallback<any>) => any;
 interface StoreFunction extends AnyFn {
   desc?: string;
   options?: Option;

diff --git a/lib/extend/deployer.ts b/lib/extend/deployer.ts
@@ -1,10 +1,11 @@
 import Promise from 'bluebird';
+import type { NodeJSLikeCallback } from '../types';
 
 interface StoreFunction {
   (deployArg: {
     type: string;
     [key: string]: any
-  }) : any;
+  }, callback?: NodeJSLikeCallback<any>) : any;
 }
 interface Store {
   [key: string]: StoreFunction

diff --git a/lib/extend/filter.ts b/lib/extend/filter.ts
@@ -76,7 +76,7 @@ class Filter {
     if (index !== -1) list.splice(index, 1);
   }
 
-  exec(type: string, data: any[], options: FilterOptions = {}): Promise<any> {
+  exec(type: string, data: any, options: FilterOptions = {}): Promise<any> {
     const filters = this.list(type);
     if (filters.length === 0) return Promise.resolve(data);
 
@@ -91,7 +91,7 @@ class Filter {
     })).then(() => args[0]);
   }
 
-  execSync(type: string, data: any[], options: FilterOptions = {}) {
+  execSync(type: string, data: any, options: FilterOptions = {}) {
     const filters = this.list(type);
     const filtersLen = filters.length;
     if (filtersLen === 0) return data;

diff --git a/lib/extend/generator.ts b/lib/extend/generator.ts
@@ -1,4 +1,5 @@
 import Promise from 'bluebird';
+import type { NodeJSLikeCallback } from '../types';
 
 interface BaseObj {
   path: string;
@@ -9,7 +10,7 @@ type ReturnType = BaseObj | BaseObj[];
 type GeneratorReturnType = ReturnType | Promise<ReturnType>;
 
 interface GeneratorFunction {
-  (locals: object): GeneratorReturnType;
+  (locals: object, callback?: NodeJSLikeCallback<any>): GeneratorReturnType;
 }
 
 type StoreFunctionReturn = Promise<ReturnType>;

diff --git a/lib/extend/migrator.ts b/lib/extend/migrator.ts
@@ -1,6 +1,8 @@
 import Promise from 'bluebird';
+import type { NodeJSLikeCallback } from '../types';
+
 interface StoreFunction {
-  (args: any): any
+  (args: any, callback?: NodeJSLikeCallback<any>): any
 }
 
 interface Store {

diff --git a/lib/extend/renderer.ts b/lib/extend/renderer.ts
@@ -22,7 +22,7 @@ export interface StoreSyncFunction {
   (
     data: StoreFunctionData,
     options: object,
-    // callback: NodeJSLikeCallback<string>
+    // callback?: NodeJSLikeCallback<string>
   ): any;
   output?: string;
   compile?: (local: object) => any;
@@ -31,6 +31,7 @@ export interface StoreFunction {
   (
     data: StoreFunctionData,
     options: object,
+    callback?: NodeJSLikeCallback<any>
   ): Promise<any>;
   (
     data: StoreFunctionData,
@@ -58,7 +59,7 @@ class Renderer {
     this.storeSync = {};
   }
 
-  list(sync: boolean): Store | SyncStore {
+  list(sync?: boolean): Store | SyncStore {
     return sync ? this.storeSync : this.store;
   }
 

diff --git a/lib/extend/tag.ts b/lib/extend/tag.ts
@@ -9,7 +9,7 @@ const rCodeTag = /<code[^<>]*>[\s\S]+?<\/code>/g;
 const escapeSwigTag = (str: string) => str.replace(/{/g, '&#123;').replace(/}/g, '&#125;');
 
 interface TagFunction {
-  (args: any[], content: string): string;
+  (args: any[], content: string, callback?: NodeJSLikeCallback<any>): string | PromiseLike<string>;
 }
 interface AsyncTagFunction {
   (args: any[], content: string): Promise<string>;
@@ -253,14 +253,17 @@ class Tag {
     if (env.hasExtension(name)) env.removeExtension(name);
   }
 
-  render(str: string, options: { source?: string } = {}, callback?: NodeJSLikeCallback<any>): Promise<any> {
+  render(str: string): Promise<any>;
+  render(str: string, callback: NodeJSLikeCallback<any>): Promise<any>;
+  render(str: string, options: { source?: string, [key: string]: any }, callback?: NodeJSLikeCallback<any>): Promise<any>;
+  render(str: string, options: { source?: string, [key: string]: any } | NodeJSLikeCallback<any> = {}, callback?: NodeJSLikeCallback<any>): Promise<any> {
     if (!callback && typeof options === 'function') {
       callback = options;
       options = {};
     }
 
     // Get path of post from source
-    const { source = '' } = options;
+    const { source = '' } = options as { source?: string };
 
     return Promise.fromCallback(cb => {
       this.env.renderString(

diff --git a/lib/hexo/default_config.ts b/lib/hexo/default_config.ts
@@ -46,7 +46,9 @@ export = {
     wrap: true,
     exclude_languages: [],
     language_attr: false,
-    hljs: false
+    hljs: false,
+    line_threshold: 0,
+    first_line_number: 'always1'
   },
   prismjs: {
     preprocess: true,

diff --git a/lib/plugins/highlight/highlight.ts b/lib/plugins/highlight/highlight.ts
@@ -1,8 +1,22 @@
+import type Hexo from '../../hexo';
+
+interface Options {
+  line_threshold?: number;
+  line_number?: boolean;
+  lines_length?: number;
+  language_attr?: boolean;
+  caption?: string;
+  firstLine?: number;
+  lang?: string;
+  mark?: number[];
+  firstLineNumber?: number;
+}
+
 // Lazy require highlight.js
 let highlight;
 
-module.exports = function highlightFilter(code, options) {
-  const hljsCfg = this.config.highlight || {};
+module.exports = function highlightFilter(this: Hexo, code: string, options: Options) {
+  const hljsCfg = this.config.highlight || {} as any;
   const line_threshold = options.line_threshold || hljsCfg.line_threshold || 0;
   const shouldUseLineNumbers = typeof options.line_number === 'undefined' ? hljsCfg.line_number : options.line_number;
   const surpassesLineThreshold = options.lines_length > line_threshold;