Refactor initSite method in Site/index.js (#2267)

MarkBind · Apr 10, 2023 · 0012f63 · 0012f63
1 parent fc027af
commit 0012f63
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 23 deletions.
diff --git a/packages/cli/src/cmd/init.js b/packages/cli/src/cmd/init.js
@@ -1,7 +1,7 @@
 const fs = require('fs-extra');
 const path = require('path');
 
-const { Site } = require('@markbind/core');
+const { Site, Template } = require('@markbind/core');
 
 const logger = require('../util/logger');
 
@@ -15,7 +15,8 @@ function init(root, options) {
     }
   }
 
-  Site.initSite(rootFolder, options.template)
+  const template = new Template(rootFolder, options.template);
+  template.init()
     .then(() => {
       logger.info('Initialization success.');
     })
@@ -34,7 +35,7 @@ function init(root, options) {
       }
     })
     .catch((error) => {
-      logger.error(error.message);
+      logger.error(`Failed to initialize site with given template with error: ${error.message}`);
       process.exitCode = 1;
     });
 }

diff --git a/packages/core/index.js b/packages/core/index.js
@@ -1,5 +1,7 @@
 const Site = require('./src/Site');
+const { Template } = require('./src/Site/template');
 
 module.exports = {
   Site,
+  Template,
 };
diff --git a/packages/core/src/Site/index.js b/packages/core/src/Site/index.js
@@ -17,7 +17,6 @@ const { ExternalManager } = require('../External/ExternalManager');
 const { LayoutManager, LAYOUT_DEFAULT_NAME, LAYOUT_FOLDER_PATH } = require('../Layout');
 const { SiteLinkManager } = require('../html/SiteLinkManager');
 const { PluginManager } = require('../plugins/PluginManager');
-const { Template } = require('./template');
 
 const { sequentialAsyncForEach } = require('../utils/async');
 const { delay } = require('../utils/delay');
@@ -170,21 +169,6 @@ class Site {
     }
   }
 
-  /**
-   * Static method for initializing a markbind site.
-   * Generate the site.json and an index.md file.
-   *
-   * @param rootPath
-   * @param templatePath
-   */
-  static async initSite(rootPath, templatePath) {
-    try {
-      return await new Template(rootPath, templatePath).initTemplate();
-    } catch (err) {
-      return new Error(`Failed to initialize site with given template with error: ${err.message}`);
-    }
-  }
-
   beforeSiteGenerate() {
     this.variableProcessor.invalidateCache();
     this.externalManager.reset();

diff --git a/packages/core/src/Site/template.ts b/packages/core/src/Site/template.ts
@@ -38,9 +38,13 @@ export class Template {
     });
   }
 
-  initTemplate() {
+  /**
+   * A method for initializing a markbind site according to the given template.
+   * Generate the site.json and an index.md file.
+   */
+  async init() {
     if (!this.validateTemplateFromPath()) {
-      throw new Error('Template validation failed. Required files does not exist');
+      throw new Error('Template validation failed. Required files does not exist.');
     }
 
     return new Promise((resolve, reject) => {

diff --git a/packages/core/test/unit/Site.test.js b/packages/core/test/unit/Site.test.js
@@ -2,6 +2,7 @@ const path = require('path');
 const fs = require('fs-extra');
 const ghpages = require('gh-pages');
 const Site = require('../../src/Site');
+const { Template } = require('../../src/Site/template');
 
 const {
   INDEX_MD_DEFAULT,
@@ -37,10 +38,11 @@ test('Site Init with invalid template fails', async () => {
 
   fs.vol.fromJSON(json, '');
 
-  Site.initSite('', DEFAULT_TEMPLATE)
+  const template = new Template('', DEFAULT_TEMPLATE);
+  await template.init('', DEFAULT_TEMPLATE)
     .catch((err) => {
       expect(err).toEqual(
-        new Error('Template validation failed. Required files does not exist'));
+        new Error('Template validation failed. Required files does not exist.'));
     });
 });