chore: improvement hexo.extend

lib/extend/filter.ts

@@ -1,4 +1,5 @@
 import Promise from 'bluebird';
+import { extend_filter_before_post_render_data } from '../plugins/filter/before_post_render/dataType';
 
 const typeAlias = {
   pre: 'before_post_render',
@@ -17,7 +18,7 @@ interface StoreFunction {
 }
 
 interface Store {
-  [key: string]: StoreFunction[]
+  [key: string]: StoreFunction[];
 }
 
 class Filter {
@@ -34,11 +35,27 @@ class Filter {
     return this.store[type] || [];
   }
 
-  register(fn: StoreFunction): void
-  register(fn: StoreFunction, priority: number): void
-  register(type: string, fn: StoreFunction): void
-  register(type: string, fn: StoreFunction, priority: number): void
-  register(type: string | StoreFunction, fn?: StoreFunction | number, priority?: number) {
+  register(fn: StoreFunction): void;
+  register(fn: StoreFunction, priority: number): void;
+  register(type: string, fn: StoreFunction): void;
+  register(
+    type: 'server_middleware',
+    fn: (app: import('connect').Server) => void
+  ): void;
+  register(
+    type: 'before_post_render',
+    fn: (data: extend_filter_before_post_render_data) => void
+  ): void;
+  register(
+    type: 'before_post_render',
+    fn: (data: extend_filter_before_post_render_data) => Promise<void>
+  ): void;
+  register(type: string, fn: StoreFunction, priority: number): void;
+  register(
+    type: string | StoreFunction,
+    fn?: StoreFunction | number,
+    priority?: number
+  ) {
     if (!priority) {
       if (typeof type === 'function') {
         priority = fn as number;
@@ -84,10 +101,12 @@ class Filter {
 
     args.unshift(data);
 
-    return Promise.each(filters, filter => Reflect.apply(Promise.method(filter), ctx, args).then(result => {
-      args[0] = result == null ? args[0] : result;
-      return args[0];
-    })).then(() => args[0]);
+    return Promise.each(filters, filter =>
+      Reflect.apply(Promise.method(filter), ctx, args).then(result => {
+        args[0] = result == null ? args[0] : result;
+        return args[0];
+      })
+    ).then(() => args[0]);
   }
 
   execSync(type: string, data: any[], options: FilterOptions = {}) {

lib/extend/generator.ts

@@ -9,13 +9,13 @@ type ReturnType = BaseObj | BaseObj[];
 type GeneratorReturnType = ReturnType | Promise<ReturnType>;
 
 interface GeneratorFunction {
-  (locals: object): GeneratorReturnType;
+  (locals: Record<string, any>): GeneratorReturnType;
 }
 
 type StoreFunctionReturn = Promise<ReturnType>;
 
 interface StoreFunction {
-  (locals: object): StoreFunctionReturn;
+  (locals: Record<string, any>): StoreFunctionReturn;
 }
 
 interface Store {

lib/extend/helper.ts

@@ -1,12 +1,11 @@
 interface StoreFunction {
-  (...args: any[]): string;
+  (this: import('../hexo'), ...args: any[]): any;
 }
 
 interface Store {
-  [key: string]: StoreFunction
+  [key: string]: StoreFunction;
 }
 
-
 class Helper {
   public store: Store;
 

lib/extend/processor.ts

@@ -26,9 +26,9 @@ class Processor {
   register(fn: StoreFunction): void;
   register(pattern: patternType, fn: StoreFunction): void;
   register(pattern: patternType | StoreFunction, fn?: StoreFunction) {
-    if (!fn) {
+    if (typeof fn !== 'function') {
       if (typeof pattern === 'function') {
-        fn = pattern;
+        fn = pattern as StoreFunction;
         pattern = /(.*)/;
       } else {
         throw new TypeError('fn must be a function');

lib/extend/renderer-d.ts

@@ -0,0 +1,40 @@
+/**
+ * to cast `data` type look example below
+ * @example
+ * type rendererData = Parameters<Parameters<typeof hexo.extend.renderer.register>[2]>[0];
+ * // or
+ * type rendererData = Parameters<Parameters<import('hexo')['extend']['renderer']['register']>[2]>[0];
+ * // or
+ * type rendererData = import('hexo/extend/renderer-d.ts').StoreFunctionData;
+ */
+export interface StoreFunctionData {
+  [key: string]: any;
+  path?: string;
+  text: string;
+}
+
+export interface StoreSyncFunction {
+  (
+    data: StoreFunctionData,
+    options: Record<string, any>
+    // callback: (err: Error, value: string) => any
+  ): any;
+  output?: string;
+  compile?: (local: Record<string, any>) => string;
+  disableNunjucks?: boolean;
+}
+
+export interface StoreFunction {
+  (data: StoreFunctionData, options: Record<string, any>): Promise<any>;
+  (data: StoreFunctionData, options: Record<string, any>, callback: (err: Error, value: string) => any): void;
+  output?: string;
+  compile?: (local: Record<string, any>) => string;
+  disableNunjucks?: boolean;
+}
+
+export interface SyncStore {
+  [key: string]: StoreSyncFunction;
+}
+export interface Store {
+  [key: string]: StoreFunction;
+}

lib/extend/renderer.ts

@@ -1,5 +1,6 @@
 import { extname } from 'path';
 import Promise from 'bluebird';
+import { Store, SyncStore, StoreSyncFunction, StoreFunction } from './renderer-d';
 
 const getExtname = (str: string) => {
   if (typeof str !== 'string') return '';
@@ -8,46 +9,6 @@ const getExtname = (str: string) => {
   return ext.startsWith('.') ? ext.slice(1) : ext;
 };
 
-interface StoreSyncFunction {
-  (
-    data: {
-      path?: string;
-      text: string;
-    },
-    options: object,
-    // callback: (err: Error, value: string) => any
-  ): any;
-  output?: string;
-  compile?: (local: object) => string;
-}
-interface StoreFunction {
-  (
-    data: {
-      path?: string;
-      text: string;
-    },
-    options: object,
-  ): Promise<any>;
-  (
-    data: {
-      path?: string;
-      text: string;
-    },
-    options: object,
-    callback: (err: Error, value: string) => any
-  ): void;
-  output?: string;
-  compile?: (local: object) => string;
-  disableNunjucks?: boolean;
-}
-
-interface SyncStore {
-  [key: string]: StoreSyncFunction;
-}
-interface Store {
-  [key: string]: StoreFunction;
-}
-
 class Renderer {
   public store: Store;
   public storeSync: SyncStore;
@@ -80,10 +41,50 @@ class Renderer {
     return renderer ? renderer.output : '';
   }
 
+  /**
+   * register renderer engine
+   * - [hexo-renderer-nunjucks example](https://github.com/hexojs/hexo-renderer-nunjucks/blob/c71a1979535c47c3949ff6bf3a85691641841e12/lib/renderer.js#L55-L56)
+   * - [typescript example](https://github.com/dimaslanjaka/hexo-renderers/blob/feed801e90920bea8a5e7000b275b912e4ef6c43/src/renderer-sass.ts#L37-L38)
+   * @param name input extension name. ex: ejs
+   * @param output output extension name. ex: html
+   * @param fn renderer function
+   */
   register(name: string, output: string, fn: StoreFunction): void;
+
+  /**
+   * register renderer engine asynchronous
+   * @param name input extension name. ex: ejs
+   * @param output output extension name. ex: html
+   * @param fn renderer asynchronous function
+   * @param sync is synchronous?
+   */
   register(name: string, output: string, fn: StoreFunction, sync: false): void;
+
+  /**
+   * register renderer engine
+   * @param name input extension name. ex: ejs
+   * @param output output extension name. ex: html
+   * @param fn renderer function
+   * @param sync is synchronous?
+   */
   register(name: string, output: string, fn: StoreSyncFunction, sync: true): void;
+
+  /**
+   * register renderer engine
+   * @param name input extension name. ex: ejs
+   * @param output output extension name. ex: html
+   * @param fn renderer function
+   * @param sync is synchronous?
+   */
   register(name: string, output: string, fn: StoreFunction | StoreSyncFunction, sync: boolean): void;
+
+  /**
+   * register renderer engine
+   * @param name input extension name. ex: ejs
+   * @param output output extension name. ex: html
+   * @param fn renderer function
+   * @param sync is synchronous?
+   */
   register(name: string, output: string, fn: StoreFunction | StoreSyncFunction, sync?: boolean) {
     if (!name) throw new TypeError('name is required');
     if (!output) throw new TypeError('output is required');

lib/extend/syntax_highlight.ts

@@ -1,12 +1,12 @@
 import type Hexo from '../hexo';
 
 export interface HighlightOptions {
-  lang: string | undefined,
-  caption: string | undefined,
-  lines_length: number,
+  lang: string | undefined;
+  caption: string | undefined;
+  lines_length: number;
 
-  // plulgins/filter/before_post_render/backtick_code_block
-  firstLineNumber?: string | number
+  // plugins/filter/before_post_render/backtick_code_block
+  firstLineNumber?: string | number;
 
   // plugins/tag/code.ts
   language_attr?: boolean | undefined;
@@ -15,7 +15,6 @@ export interface HighlightOptions {
   line_threshold?: number | undefined;
   mark?: number[];
   wrap?: boolean | undefined;
-
 }
 
 interface HighlightExecArgs {
@@ -29,7 +28,7 @@ interface StoreFunction {
 }
 
 interface Store {
-  [key: string]: StoreFunction
+  [key: string]: StoreFunction;
 }
 
 class SyntaxHighlight {
@@ -52,7 +51,9 @@ class SyntaxHighlight {
   exec(name: string, options: HighlightExecArgs): string {
     const fn = this.store[name];
 
-    if (!fn) throw new TypeError(`syntax highlighter ${name} is not registered`);
+    if (!fn) {
+      throw new TypeError(`syntax highlighter ${name} is not registered`);
+    }
     const ctx = options.context;
     const args = options.args || [];