feat: add hexo type define

curbengh · Jan 14, 2025 · 9fa79f7 · 9fa79f7
1 parent a36d5ef
commit 9fa79f7
Show file tree

Hide file tree

Showing 9 changed files with 29 additions and 0 deletions.
diff --git a/index.js b/index.js
@@ -1,6 +1,8 @@
 /* global hexo */
 'use strict'
 
+/** @typedef {import("@types/hexo")} */
+
 hexo.config.minify = {
   enable: true,
   previewServer: true,

diff --git a/lib/css.js b/lib/css.js
@@ -5,6 +5,7 @@ const { isMatch, match, logFn } = require('./tools')
 /**
  * @param {string} str
  * @param {{ path: string }} data
+ * @this {import('@types/hexo')}
  */
 async function minifyCss(str, data) {
   const hexo = this
@@ -25,6 +26,9 @@ async function minifyCss(str, data) {
   }
 }
 
+/**
+ * @this {import('@types/hexo')}
+ */
 function minifyCssWithMap() {
   const hexo = this
   const options = hexo.config.minify.css

diff --git a/lib/html.js b/lib/html.js
@@ -5,6 +5,7 @@ const { isMatch, logFn } = require('./tools')
 /**
  * @param {string} str
  * @param {{ path: string }} data
+ * @this {import('@types/hexo')}
  */
 async function minifyHtml(str, data) {
   const hexo = this

diff --git a/lib/js.js b/lib/js.js
@@ -5,6 +5,7 @@ const { isMatch, match, logFn } = require('./tools')
 /**
  * @param {string} str
  * @param {{ path: string }} data
+ * @this {import('@types/hexo')}
  */
 async function minifyJs(str, data) {
   const hexo = this
@@ -31,6 +32,9 @@ async function minifyJs(str, data) {
   }
 }
 
+/**
+ * @this {import('@types/hexo')}
+ */
 function minifyJsWithMap() {
   const hexo = this
   const options = hexo.config.minify.js

diff --git a/lib/json.js b/lib/json.js
@@ -1,6 +1,9 @@
 'use strict'
 const { match, logFn } = require('./tools')
 
+/**
+ * @this {import('@types/hexo')}
+ */
 function minifyJson() {
   const hexo = this
   const options = hexo.config.minify.json

diff --git a/lib/svg.js b/lib/svg.js
@@ -2,6 +2,9 @@
 const { optimize: svgOptimize } = require('svgo')
 const { match, logFn } = require('./tools')
 
+/**
+ * @this {import('@types/hexo')}
+ */
 function minifySvg() {
   const hexo = this
   const options = hexo.config.minify.svg

diff --git a/lib/xml.js b/lib/xml.js
@@ -1,6 +1,9 @@
 'use strict'
 const { match, logFn } = require('./tools')
 
+/**
+ * @this {import('@types/hexo')}
+ */
 async function minifyXml() {
   const { minify: compressXml } = await import('minify-xml')
 

diff --git a/lib/zlib.js b/lib/zlib.js
@@ -5,6 +5,9 @@ const gzip = promisify(zlib.gzip)
 const br = promisify(zlib.brotliCompress)
 const { match, logFn } = require('./tools')
 
+/**
+ * @this {import('@types/hexo')}
+ */
 function gzipFn() {
   const hexo = this
   const options = hexo.config.minify.gzip
@@ -40,6 +43,9 @@ function gzipFn() {
   }))
 }
 
+/**
+ * @this {import('@types/hexo')}
+ */
 function brotliFn() {
   const hexo = this
   const options = hexo.config.minify.brotli

diff --git a/lib/zstd.js b/lib/zstd.js
@@ -25,6 +25,9 @@ function importZstd() {
 const { compress: zstd, init = undefined } = importZstd()
 const { match, logFn } = require('./tools')
 
+/**
+ * @this {import('@types/hexo')}
+ */
 async function zstdFn() {
   const hexo = this
   const options = hexo.config.minify.zstd