refactor: refactor types (#5344)

Co-authored-by: Sukka <[email protected]>

lib/box/file.ts

@@ -19,12 +19,12 @@ class File {
  this.type = type;
  }
 
- read(options?: ReadFileOptions): Promise<string | Buffer> {
- return readFile(this.source, options);
+ read(options?: ReadFileOptions): Promise<string> {
+ return readFile(this.source, options) as Promise<string>;
  }
 
- readSync(options?: ReadFileOptions): string | Buffer {
- return readFileSync(this.source, options);
+ readSync(options?: ReadFileOptions): string {
+ return readFileSync(this.source, options) as string;
  }
 
  stat(): Promise<fs.Stats> {

lib/box/index.ts

@@ -7,12 +7,13 @@ import { magenta } from 'picocolors';
 import { EventEmitter } from 'events';
 import { isMatch, makeRe } from 'micromatch';
 import type Hexo from '../hexo';
+import type { NodeJSLikeCallback } from '../types';
 
 const defaultPattern = new Pattern(() => ({}));
 
 interface Processor {
  pattern: Pattern;
- process: (file: File) => void;
+ process: (file?: File) => any;
 }
 
 class Box extends EventEmitter {

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;
@@ -29,7 +30,7 @@ interface Store {
  [key: string]: StoreFunction
 }
 interface Alias {
- [key: string]: string
+ [abbreviation: string]: string
 }
 
 class Console {

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

lib/extend/filter.ts

@@ -11,6 +11,7 @@ interface FilterOptions {
  args?: any[];
 }
 
+
 interface StoreFunction {
  (data?: any, ...args: any[]): any;
  priority?: number;
@@ -75,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);
 
@@ -90,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;

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>;

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 {

lib/extend/renderer.ts

@@ -1,5 +1,6 @@
 import { extname } from 'path';
 import Promise from 'bluebird';
+import type { NodeJSLikeCallback } from '../types';
 
 const getExtname = (str: string) => {
  if (typeof str !== 'string') return '';
@@ -13,15 +14,15 @@ export interface StoreFunctionData {
  text?: string;
  engine?: string;
  toString?: any;
- onRenderEnd?: any;
+ onRenderEnd?: (...args: any[]) => any;
 }
 
 export interface StoreSyncFunction {
  [x: string]: any;
  (
  data: StoreFunctionData,
  options: object,
- // callback: NodeJSLikeCallback<string>
+ // callback?: NodeJSLikeCallback<string>
  ): any;
  output?: string;
  compile?: (local: object) => any;
@@ -30,6 +31,7 @@ export interface StoreFunction {
  (
  data: StoreFunctionData,
  options: object,
+ callback?: NodeJSLikeCallback<any>
  ): Promise<any>;
  (
  data: StoreFunctionData,
@@ -57,7 +59,7 @@ class Renderer {
  this.storeSync = {};
  }
 
- list(sync: boolean): Store | SyncStore {
+ list(sync = false): Store | SyncStore {
  return sync ? this.storeSync : this.store;
  }
 
@@ -97,7 +99,6 @@ class Renderer {
  this.storeSync[name].output = output;
 
  this.store[name] = Promise.method(fn);
- // eslint-disable-next-line no-extra-parens
  this.store[name].disableNunjucks = (fn as StoreFunction).disableNunjucks;
  } else {
  if (fn.length > 2) fn = Promise.promisify(fn);

lib/extend/tag.ts

@@ -2,12 +2,14 @@ import { stripIndent } from 'hexo-util';
 import { cyan, magenta, red, bold } from 'picocolors';
 import { Environment } from 'nunjucks';
 import Promise from 'bluebird';
+import type { NodeJSLikeCallback } from '../types';
+
 const rSwigRawFullBlock = /{% *raw *%}/;
 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>;
@@ -251,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(

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,