Reorganize constants in packages/core

packages/core/src/Layout/LayoutManager.js

@@ -5,7 +5,7 @@ const { Layout } = require('./Layout');
 
 const logger = require('../utils/logger');
 
-const { FRONT_MATTER_NONE_ATTR } = require('../Page/constants');
+const FRONT_MATTER_NONE_ATTR = 'none';
 
 class LayoutManager {
   constructor(config) {

packages/core/src/Layout/index.js

@@ -4,4 +4,6 @@ const { LayoutManager } = require('./LayoutManager');
 module.exports = {
   Layout,
   LayoutManager,
+  LAYOUT_DEFAULT_NAME: 'default.md',
+  LAYOUT_FOLDER_PATH: '_markbind/layouts',
 };

packages/core/src/Page/index.js

@@ -20,16 +20,18 @@ const logger = require('../utils/logger');
 
 const PACKAGE_VERSION = require('../../package.json').version;
 
-const {
-  PAGE_NAV_ID,
-  PAGE_NAV_TITLE_CLASS,
-  TITLE_PREFIX_SEPARATOR,
-  TITLE_SUFFIX_SEPARATOR,
-} = require('./constants');
-
 const {
   LAYOUT_DEFAULT_NAME,
-} = require('../constants');
+} = require('../Layout');
+
+const TITLE_PREFIX_SEPARATOR = ' - ';
+const TITLE_SUFFIX_SEPARATOR = ' - ';
+
+const PAGE_NAV_ID = 'mb-page-nav';
+const PAGE_NAV_TITLE_CLASS = 'page-nav-title';
+
+const SCROLL_TO_TOP_BUTTON_HTML = '<i class="fa fa-arrow-circle-up fa-lg d-print-none" '
+  + 'id="scroll-top-button" onclick="handleScrollTop()" aria-hidden="true"></i>';
 
 cheerio.prototype.options.decodeEntities = false; // Don't escape HTML entities
 
@@ -103,7 +105,7 @@ class Page {
      */
 
     /**
-     * The layout to use for this page, which may be further mutated in {@link processFrontMatter.}
+     * The layout to use for this page, which may be further mutated in {@link processFrontMatter}.
      * @type {string}
      */
     this.layout = this.pageConfig.layout;
@@ -435,7 +437,7 @@ class Page {
        portal-ing it into the mobile page nav.
        */
       return `${pageNavTitleHtml}\n`
-          + `<overlay-source id="${PAGE_NAV_ID}" tag-name="nav" to="mb-page-nav"`
+        + `<overlay-source id="${PAGE_NAV_ID}" tag-name="nav" to="${PAGE_NAV_ID}"`
             + ' class="nav nav-pills flex-column my-0 small no-flex-wrap">\n'
           + `${pageNavHeadingHTML}\n`
           + '</overlay-source>\n';
@@ -542,9 +544,7 @@ class Page {
   }
 
   static addScrollToTopButton(pageData) {
-    const button = '<i class="fa fa-arrow-circle-up fa-lg d-print-none" id="scroll-top-button" '
-    + 'onclick="handleScrollTop()" aria-hidden="true"></i>';
-    return `${pageData}\n${button}`;
+    return `${pageData}\n${SCROLL_TO_TOP_BUTTON_HTML}`;
   }
 
   /**

packages/core/src/Site/SiteConfig.js

@@ -1,8 +1,6 @@
 const logger = require('../utils/logger');
 
-const {
-  HEADING_INDEXING_LEVEL_DEFAULT,
-} = require('./constants');
+const HEADING_INDEXING_LEVEL_DEFAULT = 3;
 
 /**
  * Represents a read only site config read from the site configuration file,

packages/core/src/Site/constants.js

@@ -1,23 +1,5 @@
 module.exports = {
-  CONFIG_FOLDER_NAME: '_markbind',
-  HEADING_INDEXING_LEVEL_DEFAULT: 3,
-  SITE_FOLDER_NAME: '_site',
-  TEMP_FOLDER_NAME: '.temp',
-  TEMPLATE_SITE_ASSET_FOLDER_NAME: 'markbind',
-
-  ABOUT_MARKDOWN_FILE: 'about.md',
-  FAVICON_DEFAULT_PATH: 'favicon.ico',
   INDEX_MARKDOWN_FILE: 'index.md',
-  MAX_CONCURRENT_PAGE_GENERATION_PROMISES: 4,
-  PAGE_TEMPLATE_NAME: 'page.njk',
   SITE_CONFIG_NAME: 'site.json',
-  SITE_DATA_NAME: 'siteData.json',
-  LAYOUT_SITE_FOLDER_NAME: 'layouts',
   LAZY_LOADING_SITE_FILE_NAME: 'LazyLiveReloadLoadingSite.html',
-  LAZY_LOADING_BUILD_TIME_RECOMMENDATION_LIMIT: 30000,
-  LAZY_LOADING_REBUILD_TIME_RECOMMENDATION_LIMIT: 5000,
-  USER_VARIABLES_PATH: '_markbind/variables.md',
-  WIKI_SITE_NAV_PATH: '_Sidebar.md',
-  WIKI_FOOTER_PATH: '_Footer.md',
-  MARKBIND_WEBSITE_URL: 'https://markbind.org/',
 };

packages/core/src/Site/index.js

@@ -14,7 +14,7 @@ const { PageConfig } = require('../Page/PageConfig');
 const VariableProcessor = require('../variables/VariableProcessor');
 const VariableRenderer = require('../variables/VariableRenderer');
 const { ExternalManager } = require('../External/ExternalManager');
-const { LayoutManager } = require('../Layout');
+const { LayoutManager, LAYOUT_DEFAULT_NAME, LAYOUT_FOLDER_PATH } = require('../Layout');
 const { SiteLinkManager } = require('../html/SiteLinkManager');
 const { PluginManager } = require('../plugins/PluginManager');
 const Template = require('../../template/template');
@@ -24,11 +24,7 @@ const { delay } = require('../utils/delay');
 const fsUtil = require('../utils/fsUtil');
 const gitUtil = require('../utils/git');
 const logger = require('../utils/logger');
-
-const {
-  LAYOUT_DEFAULT_NAME,
-  LAYOUT_FOLDER_PATH,
-} = require('../constants');
+const { SITE_CONFIG_NAME, INDEX_MARKDOWN_FILE, LAZY_LOADING_SITE_FILE_NAME } = require('./constants');
 
 const _ = {};
 _.difference = require('lodash/difference');
@@ -50,27 +46,26 @@ url.join = path.posix.join;
 
 const MARKBIND_VERSION = require('../../package.json').version;
 
-const {
-  ABOUT_MARKDOWN_FILE,
-  CONFIG_FOLDER_NAME,
-  FAVICON_DEFAULT_PATH,
-  INDEX_MARKDOWN_FILE,
-  LAYOUT_SITE_FOLDER_NAME,
-  LAZY_LOADING_SITE_FILE_NAME,
-  LAZY_LOADING_BUILD_TIME_RECOMMENDATION_LIMIT,
-  LAZY_LOADING_REBUILD_TIME_RECOMMENDATION_LIMIT,
-  MARKBIND_WEBSITE_URL,
-  MAX_CONCURRENT_PAGE_GENERATION_PROMISES,
-  PAGE_TEMPLATE_NAME,
-  SITE_CONFIG_NAME,
-  SITE_DATA_NAME,
-  SITE_FOLDER_NAME,
-  TEMP_FOLDER_NAME,
-  TEMPLATE_SITE_ASSET_FOLDER_NAME,
-  USER_VARIABLES_PATH,
-  WIKI_SITE_NAV_PATH,
-  WIKI_FOOTER_PATH,
-} = require('./constants');
+const CONFIG_FOLDER_NAME = '_markbind';
+const SITE_FOLDER_NAME = '_site';
+const TEMP_FOLDER_NAME = '.temp';
+const TEMPLATE_SITE_ASSET_FOLDER_NAME = 'markbind';
+const LAYOUT_SITE_FOLDER_NAME = 'layouts';
+
+const ABOUT_MARKDOWN_FILE = 'about.md';
+const FAVICON_DEFAULT_PATH = 'favicon.ico';
+const USER_VARIABLES_PATH = '_markbind/variables.md';
+
+const PAGE_TEMPLATE_NAME = 'page.njk';
+const SITE_DATA_NAME = 'siteData.json';
+
+const WIKI_SITE_NAV_PATH = '_Sidebar.md';
+const WIKI_FOOTER_PATH = '_Footer.md';
+
+const MAX_CONCURRENT_PAGE_GENERATION_PROMISES = 4;
+
+const LAZY_LOADING_BUILD_TIME_RECOMMENDATION_LIMIT = 30000;
+const LAZY_LOADING_REBUILD_TIME_RECOMMENDATION_LIMIT = 5000;
 
 function getBootswatchThemePath(theme) {
   return require.resolve(`bootswatch/dist/${theme}/bootstrap.min.css`);
@@ -104,6 +99,7 @@ const HIGHLIGHT_ASSETS = {
 const ABOUT_MARKDOWN_DEFAULT = '# About\n'
   + 'Welcome to your **About Us** page.\n';
 
+const MARKBIND_WEBSITE_URL = 'https://markbind.org/';
 const MARKBIND_LINK_HTML = `<a href='${MARKBIND_WEBSITE_URL}'>MarkBind ${MARKBIND_VERSION}</a>`;
 
 class Site {

packages/core/src/constants.js

@@ -1,15 +1,3 @@
 module.exports = {
-  // Page.js and Site.js
-  LAYOUT_DEFAULT_NAME: 'default.md',
-  LAYOUT_FOLDER_PATH: '_markbind/layouts',
-
-  // packages/core/src/Parser.js
   ATTRIB_CWF: 'cwf',
-
-  BOILERPLATE_FOLDER_NAME: '_markbind/boilerplates',
-
-  // packages/core/src/plugins/algolia.js
-  ALGOLIA_CSS_URL: 'https://cdn.jsdelivr.net/npm/@docsearch/css@3.0.0-alpha.42/dist/style.css',
-  ALGOLIA_JS_URL: 'https://cdn.jsdelivr.net/npm/@docsearch/js@3.0.0-alpha.42/dist/umd/index.js',
-  ALGOLIA_INPUT_SELECTOR: '#algolia-search-input',
 };

packages/core/src/html/NodeProcessor.js

@@ -28,12 +28,12 @@ const { createErrorNode } = require('./elements');
 const fsUtil = require('../utils/fsUtil');
 const logger = require('../utils/logger');
 
-const { FRONT_MATTER_FENCE } = require('../Page/constants');
-
 const {
   ATTRIB_CWF,
 } = require('../constants');
 
+const FRONT_MATTER_FENCE = '---';
+
 cheerio.prototype.options.decodeEntities = false; // Don't escape HTML entities
 
 class NodeProcessor {

packages/core/src/html/siteAndPageNavProcessor.js

@@ -2,17 +2,25 @@ const { v4: uuidv4 } = require('uuid');
 const cheerio = require('cheerio'); require('../patches/htmlparser2');
 const md = require('../lib/markdown-it');
 
-const {
-  SITE_NAV_EMPTY_LINE_REGEX,
-  SITE_NAV_LIST_CLASS,
-  SITE_NAV_LIST_CLASS_ROOT,
-  SITE_NAV_LIST_ITEM_CLASS,
-  SITE_NAV_DEFAULT_LIST_ITEM_CLASS,
-  SITE_NAV_CUSTOM_LIST_ITEM_CLASS,
-  SITE_NAV_DROPDOWN_EXPAND_KEYWORD_REGEX,
-  SITE_NAV_DROPDOWN_ICON_ROTATED_HTML,
-  SITE_NAV_DROPDOWN_ICON_HTML,
-} = require('../Page/constants');
+const SITE_NAV_ID = 'site-nav';
+const SITE_NAV_EMPTY_LINE_REGEX = /\r?\n\s*\r?\n/g;
+
+const SITE_NAV_LIST_ITEM_CLASS = 'site-nav-list-item';
+const SITE_NAV_LIST_CLASS = 'site-nav-list';
+const SITE_NAV_LIST_CLASS_ROOT = 'site-nav-list-root';
+
+const SITE_NAV_DEFAULT_LIST_ITEM_CLASS = 'site-nav-default-list-item';
+const SITE_NAV_CUSTOM_LIST_ITEM_CLASS = 'site-nav-custom-list-item';
+
+const SITE_NAV_DROPDOWN_EXPAND_KEYWORD_REGEX = /:expanded:/g;
+const SITE_NAV_DROPDOWN_ICON_HTML = '<i class="site-nav-dropdown-btn-icon" '
+  + 'onclick="handleSiteNavClick(this.parentNode, false); event.stopPropagation();">\n'
+  + '<span class="glyphicon glyphicon-menu-down" aria-hidden="true"></span>\n'
+  + '</i>';
+const SITE_NAV_DROPDOWN_ICON_ROTATED_HTML = '<i class="site-nav-dropdown-btn-icon site-nav-rotate-icon" '
+  + 'onclick="handleSiteNavClick(this.parentNode, false); event.stopPropagation();">\n'
+  + '<span class="glyphicon glyphicon-menu-down" aria-hidden="true"></span>\n'
+  + '</i>';
 
 /**
  * Replaces and stores a uuid identifier to the only page-nav element, if there is one.
@@ -130,7 +138,7 @@ function addOverlayPortalSource(node, to) {
  * This component portals said element into the mobile navbar menus as needed.
  */
 function addSitePageNavPortal(node) {
-  if (node.attribs.id === 'site-nav' || node.attribs.id === 'page-nav') {
+  if (node.attribs.id === SITE_NAV_ID || node.attribs.id === 'page-nav') {
     addOverlayPortalSource(node, node.attribs.id);
   } else if (node.attribs['mb-site-nav']) {
     addOverlayPortalSource(node, 'mb-site-nav');

packages/core/src/plugins/algolia.js

@@ -1,10 +1,8 @@
 const cheerio = module.parent.require('cheerio');
 
-const {
-  ALGOLIA_CSS_URL,
-  ALGOLIA_JS_URL,
-  ALGOLIA_INPUT_SELECTOR,
-} = require('../constants');
+const ALGOLIA_CSS_URL = 'https://cdn.jsdelivr.net/npm/@docsearch/css@3.0.0-alpha.42/dist/style.css';
+const ALGOLIA_JS_URL = 'https://cdn.jsdelivr.net/npm/@docsearch/js@3.0.0-alpha.42/dist/umd/index.js';
+const ALGOLIA_INPUT_SELECTOR = '#algolia-search-input';
 
 function buildAlgoliaInitScript(pluginContext) {
   return `<script>

packages/core/src/utils/urlUtil.ts

@@ -1,9 +1,7 @@
 import path from 'path';
 import pathIsInside from 'path-is-inside';
 
-const {
-  BOILERPLATE_FOLDER_NAME,
-} = require('../constants');
+const BOILERPLATE_FOLDER_NAME = '_markbind/boilerplates';
 
 /**
  * Calculates the absolute path of of the immediate parent site of the specified filePath.