Adapt Site/index.js to Typescript

MarkBind · Apr 10, 2023 · 0f12a21 · 0f12a21
1 parent da44988
commit 0f12a21
Show file tree

Hide file tree

Showing 9 changed files with 324 additions and 204 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/cli/src/cmd/build.js b/packages/cli/src/cmd/build.js
@@ -1,6 +1,6 @@
 const path = require('path');
 
-const { Site } = require('@markbind/core');
+const { Site } = require('@markbind/core').Site;
 
 const cliUtil = require('../util/cliUtil');
 const logger = require('../util/logger');

diff --git a/packages/cli/src/cmd/deploy.js b/packages/cli/src/cmd/deploy.js
@@ -1,6 +1,6 @@
 const path = require('path');
 
-const { Site } = require('@markbind/core');
+const { Site } = require('@markbind/core').Site;
 
 const cliUtil = require('../util/cliUtil');
 const logger = require('../util/logger');

diff --git a/packages/cli/src/cmd/init.js b/packages/cli/src/cmd/init.js
@@ -1,7 +1,8 @@
 const fs = require('fs-extra');
 const path = require('path');
 
-const { Site, Template } = require('@markbind/core');
+const { Template } = require('@markbind/core');
+const { Site } = require('@markbind/core').Site;
 
 const logger = require('../util/logger');
 

diff --git a/packages/cli/src/cmd/serve.js b/packages/cli/src/cmd/serve.js
@@ -1,7 +1,7 @@
 const chokidar = require('chokidar');
 const path = require('path');
 
-const { Site } = require('@markbind/core');
+const { Site } = require('@markbind/core').Site;
 const { pageVueServerRenderer } = require('@markbind/core/src/Page/PageVueServerRenderer');
 
 const fsUtil = require('@markbind/core/src/utils/fsUtil');

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -80,6 +80,7 @@
     "@types/crypto-js": "^4.1.1",
     "@types/domhandler": "^2.4.2",
     "@types/fs-extra": "^9.0.13",
+    "@types/gh-pages": "^3.2.1",
     "@types/htmlparser2": "^3.10.3",
     "@types/jest": "^27.4.1",
     "@types/js-beautify": "^1.13.3",

diff --git a/packages/core/src/Site/SiteConfig.ts b/packages/core/src/Site/SiteConfig.ts
@@ -1,5 +1,24 @@
+import { FrontMatter } from '../plugins/Plugin';
+
 const HEADING_INDEXING_LEVEL_DEFAULT = 3;
 
+export type SiteConfigPage = {
+  glob?: string,
+  layout?: string,
+  src?: string[],
+  title?: string,
+  externalScripts?: string[],
+  globExclude?: string,
+  searchable?: string | boolean,
+  frontmatter?: FrontMatter,
+};
+
+export type SiteConfigStyle = {
+  bootstrapTheme?: string;
+  codeTheme: 'dark' | 'light';
+  codeLineNumbers: boolean; // Default hide display of line numbers for code blocks
+};
+
 /**
  * Represents a read only site config read from the site configuration file,
  * with default values for unspecified properties.
@@ -10,16 +29,9 @@ export class SiteConfig {
   faviconPath?: string;
   headingIndexingLevel: number;
 
-  style: {
-    bootstrapTheme?: string;
-    codeTheme: string;
-    /**
-     * Default hide display of line numbers for code blocks
-     */
-    codeLineNumbers: boolean;
-  };
+  style: SiteConfigStyle;
 
-  pages: string[];
+  pages: SiteConfigPage[];
   pagesExclude: string[];
   ignore: string[];
 
@@ -40,6 +52,7 @@ export class SiteConfig {
     message?: string;
     repo?: string;
     branch?: string;
+    baseDir?: string;
   };
 
   intrasiteLinkValidation: {
@@ -87,5 +100,3 @@ export class SiteConfig {
       ? siteConfigJson.plantumlCheck : true; // check PlantUML's prerequisite by default
   }
 }
-
-module.exports = SiteConfig;