refactor: migrate typescript (#5430)

* chore: remove unused test entry file * refactor: migrate ts
hexojs · Mar 30, 2024 · a3b9638 · a3b9638
1 parent 3c7729d
commit a3b9638
Show file tree

Hide file tree

Showing 11 changed files with 46 additions and 62 deletions.
diff --git a/test/fixtures/.eslintrc b/test/fixtures/.eslintrc
@@ -0,0 +1,6 @@
+{
+  "extends": "hexo/ts",
+  "rules": {
+    "node/no-unsupported-features/es-syntax": 0
+  }
+}
diff --git a/test/fixtures/post_render.js → test/fixtures/post_render.ts b/test/fixtures/post_render.js → test/fixtures/post_render.ts
@@ -1,13 +1,11 @@
-'use strict';
-
-const { highlight } = require('hexo-util');
+import { highlight } from 'hexo-util';
 
 const code = [
   'if tired && night:',
   '  sleep()'
 ].join('\n');
 
-exports.content = [
+export const content = [
   '# Title',
   '``` python',
   code,
@@ -24,7 +22,7 @@ exports.content = [
   '{% endquote %}'
 ].join('\n');
 
-exports.expected = [
+export const expected = [
   '<h1 id="Title"><a href="#Title" class="headerlink" title="Title"></a>Title</h1>',
   highlight(code, {lang: 'python'}),
   '\n<p>some content</p>\n',
@@ -36,7 +34,7 @@ exports.expected = [
   '<footer><strong>Hello World</strong></footer></blockquote>'
 ].join('');
 
-exports.expected_disable_nunjucks = [
+export const expected_disable_nunjucks = [
   '<h1 id="Title"><a href="#Title" class="headerlink" title="Title"></a>Title</h1>',
   highlight(code, {lang: 'python'}),
   '\n<p>some content</p>\n',
@@ -49,7 +47,7 @@ exports.expected_disable_nunjucks = [
   '{% endquote %}</p>'
 ].join('');
 
-exports.content_for_issue_3346 = [
+export const content_for_issue_3346 = [
   '# Title',
   '```',
   '{% test1 %}',
@@ -63,7 +61,7 @@ exports.content_for_issue_3346 = [
   '{% endblockquote %}'
 ].join('\n');
 
-exports.expected_for_issue_3346 = [
+export const expected_for_issue_3346 = [
   '<h1 id="Title"><a href="#Title" class="headerlink" title="Title"></a>Title</h1>',
   highlight('{% test1 %}\n{{ test2 }}').replace(/{/g, '&#123;').replace(/}/g, '&#125;'), // Escaped by backtick_code_block
   '\n<p>some content</p>\n',
@@ -73,7 +71,7 @@ exports.expected_for_issue_3346 = [
   '</blockquote>'
 ].join('');
 
-exports.content_for_issue_4460 = [
+export const content_for_issue_4460 = [
   '```html',
   '<body>',
   '<!-- here goes the rest of the page -->',

diff --git a/test/index.js b/test/index.js
diff --git a/test/scripts/generators/asset.ts b/test/scripts/generators/asset.ts
@@ -1,6 +1,6 @@
 import { join } from 'path';
 import { mkdirs, rmdir, unlink, writeFile } from 'hexo-fs';
-import testUtil from '../../util';
+import { readStream } from '../../util';
 import Hexo from '../../../lib/hexo';
 import assetGenerator from '../../../lib/plugins/generator/asset';
 import { spy } from 'sinon';
@@ -15,7 +15,7 @@ describe('asset', () => {
   const Asset = hexo.model('Asset');
 
   const checkStream = async (stream, expected) => {
-    const data = await testUtil.stream.read(stream);
+    const data = await readStream(stream);
     data.should.eql(expected);
   };
 

diff --git a/test/scripts/hexo/hexo.ts b/test/scripts/hexo/hexo.ts
@@ -3,7 +3,7 @@ import { mkdirs, rmdir, unlink, writeFile } from 'hexo-fs';
 // @ts-ignore
 import Promise from 'bluebird';
 import { spy } from 'sinon';
-import testUtil from '../../util';
+import { readStream } from '../../util';
 import { full_url_for } from 'hexo-util';
 import Hexo from '../../../lib/hexo';
 import chai from 'chai';
@@ -20,7 +20,7 @@ describe('Hexo', () => {
   const { route } = hexo;
 
   async function checkStream(stream, expected) {
-    const data = await testUtil.stream.read(stream);
+    const data = await readStream(stream);
     data.should.eql(expected);
   }
 

diff --git a/test/scripts/hexo/post.ts b/test/scripts/hexo/post.ts
@@ -3,7 +3,7 @@ import moment from 'moment';
 import { readFile, mkdirs, unlink, rmdir, writeFile, exists, stat, listDir } from 'hexo-fs';
 import { spy, useFakeTimers } from 'sinon';
 import { parse as yfm } from 'hexo-front-matter';
-import fixture from '../../fixtures/post_render';
+import { expected, content, expected_disable_nunjucks, content_for_issue_3346, expected_for_issue_3346, content_for_issue_4460 } from '../../fixtures/post_render';
 import { highlight } from 'hexo-util';
 import Hexo from '../../../lib/hexo';
 import chai from 'chai';
@@ -659,17 +659,17 @@ describe('Post', () => {
     hexo.extend.filter.register('after_post_render', afterHook);
 
     const data = await post.render('', {
-      content: fixture.content,
+      content,
       engine: 'markdown'
     });
-    data.content.trim().should.eql(fixture.expected);
+    data.content.trim().should.eql(expected);
     beforeHook.calledOnce.should.be.true;
     afterHook.calledOnce.should.be.true;
   });
 
   it('render() - callback', done => {
     post.render('', {
-      content: fixture.content,
+      content,
       engine: 'markdown'
     }, err => {
       done(err);
@@ -795,10 +795,10 @@ describe('Post', () => {
 
     try {
       const data = await post.render('', {
-        content: fixture.content,
+        content,
         engine: 'markdown'
       });
-      data.content.trim().should.eql(fixture.expected_disable_nunjucks);
+      data.content.trim().should.eql(expected_disable_nunjucks);
     } finally {
       renderer.disableNunjucks = false;
     }
@@ -811,10 +811,10 @@ describe('Post', () => {
 
     try {
       const data = await post.render('', {
-        content: fixture.content,
+        content,
         engine: 'markdown'
       });
-      data.content.trim().should.eql(fixture.expected);
+      data.content.trim().should.eql(expected);
     } finally {
       renderer.disableNunjucks = false;
     }
@@ -848,11 +848,11 @@ describe('Post', () => {
 
     try {
       const data = await post.render('', {
-        content: fixture.content,
+        content,
         engine: 'markdown',
         disableNunjucks: false
       });
-      data.content.trim().should.eql(fixture.expected);
+      data.content.trim().should.eql(expected);
     } finally {
       renderer.disableNunjucks = false;
     }
@@ -864,11 +864,11 @@ describe('Post', () => {
 
     try {
       const data = await post.render('', {
-        content: fixture.content,
+        content,
         engine: 'markdown',
         disableNunjucks: true
       });
-      data.content.trim().should.eql(fixture.expected_disable_nunjucks);
+      data.content.trim().should.eql(expected_disable_nunjucks);
     } finally {
       renderer.disableNunjucks = false;
     }
@@ -881,12 +881,12 @@ describe('Post', () => {
 
     try {
       const data = await post.render('', {
-        content: fixture.content,
+        content,
         engine: 'markdown',
         // @ts-ignore
         disableNunjucks: null
       });
-      data.content.trim().should.eql(fixture.expected_disable_nunjucks);
+      data.content.trim().should.eql(expected_disable_nunjucks);
     } finally {
       renderer.disableNunjucks = false;
     }
@@ -1155,14 +1155,14 @@ describe('Post', () => {
 
   // #3346
   it('render() - swig tag inside backtick code block', async () => {
-    const content = fixture.content_for_issue_3346;
+    const content = content_for_issue_3346;
 
     const data = await post.render('', {
       content,
       engine: 'markdown'
     });
 
-    data.content.trim().should.eql(fixture.expected_for_issue_3346);
+    data.content.trim().should.eql(expected_for_issue_3346);
   });
 
   // test for https://github.com/hexojs/hexo/pull/4171#issuecomment-594412367
@@ -1343,7 +1343,7 @@ describe('Post', () => {
   it('render() - issue #4460', async () => {
     hexo.config.syntax_highlighter = 'prismjs';
 
-    const content = fixture.content_for_issue_4460;
+    const content = content_for_issue_4460;
 
     const data = await post.render('', {
       content,

diff --git a/test/scripts/hexo/router.ts b/test/scripts/hexo/router.ts
@@ -5,7 +5,7 @@ import { join } from 'path';
 import crypto from 'crypto';
 import { createReadStream } from 'hexo-fs';
 import { spy, assert as sinonAssert } from 'sinon';
-import testUtil from '../../util';
+import { readStream } from '../../util';
 import Router from '../../../lib/hexo/router';
 import chai from 'chai';
 const should = chai.should();
@@ -14,7 +14,7 @@ describe('Router', () => {
   const router = new Router();
 
   function checkStream(stream, expected) {
-    return testUtil.stream.read(stream).then(data => {
+    return readStream(stream).then(data => {
       data.should.eql(expected);
     });
   }
@@ -125,7 +125,7 @@ describe('Router', () => {
       throw new Error('error test');
     });
 
-    return testUtil.stream.read(router.get('test')).then(() => {
+    return readStream(router.get('test')).then(() => {
       should.fail('Return value must be rejected');
     }, err => {
       err.should.have.property('message', 'error test');

diff --git a/test/util/.eslintrc b/test/util/.eslintrc
@@ -0,0 +1,6 @@
+{
+  "extends": "hexo/ts",
+  "rules": {
+    "node/no-unsupported-features/es-syntax": 0
+  }
+}
diff --git a/test/util/index.js b/test/util/index.js
diff --git a/test/util/index.ts b/test/util/index.ts
@@ -0,0 +1 @@
+export { readStream } from './stream';
diff --git a/test/util/stream.js → test/util/stream.ts b/test/util/stream.js → test/util/stream.ts
@@ -1,8 +1,6 @@
-'use strict';
+import Promise from 'bluebird';
 
-const Promise = require('bluebird');
-
-function readStream(stream) {
+export function readStream(stream): Promise<string> {
   return new Promise((resolve, reject) => {
     let data = '';
 
@@ -13,5 +11,3 @@ function readStream(stream) {
     }).on('error', reject);
   });
 }
-
-exports.read = readStream;