highmark-cli 1.3.21 → 1.3.23

package/bin/action/publish.js

@@ -1,8 +1,8 @@
 "use strict";
 
-const indexOptions = require("../indexOptions"),
-      watchOperation = require("../operation/watch"),
+const watchOperation = require("../operation/watch"),
       copyFontsOperation = require("../operation/copyFonts"),
+      indexOptionsOperation = require("../operation/indexOptions"),
       markdownHTMLOperation = require("../operation/markdownHTML"),
       copyClientFilesOperation = require("../operation/copyClientFiles"),
       createClientHTMLOperation = require("../operation/createClientHTML"),
@@ -13,6 +13,7 @@ const { executeOperations } = require("../utilities/operation"),
 
 function publishAction(port, fonts, watch, client, quietly, inputFileName, projectDirectoryName) {
   const operations = [
+          indexOptionsOperation,
           markdownHTMLOperation,
           markdownStylesCSSOperation,
           createClientHTMLOperation,
@@ -26,7 +27,6 @@ function publishAction(port, fonts, watch, client, quietly, inputFileName, proje
           watch,
           client,
           quietly,
-          indexOptions,
           inputFileName,
           projectDirectoryName
         };

package/bin/constants.js

@@ -1,7 +1,6 @@
 "use strict";
 
-const FONT = "font",
-      ERROR = "error",
+const ERROR = "error",
       STRING = "string",
       NUMBER = "number",
       BOOLEAN = "boolean",
@@ -9,13 +8,15 @@ const FONT = "font",
       INFINITY = "Infinity",
       DOUBLE_DOTS = "..",
       EMPTY_STRING = "",
+      DOUBLE_SPACE = "  ",
       HIGHMARK_CLI = "Highmark-CLI",
       LIVE_RELOAD_PATH = "/live-reload",
+      FONT_DIRECTORY_NAME = "font",
       DIVS_SELECTOR_STRING = "body > div",
+      INDEX_JSON_FILE_NAME = "index.json",
       DEFAULT_DIVISION_IDENTIFIER = "default";
 
 module.exports = {
-  FONT,
   ERROR,
   STRING,
   NUMBER,
@@ -24,8 +25,11 @@ module.exports = {
   INFINITY,
   DOUBLE_DOTS,
   EMPTY_STRING,
+  DOUBLE_SPACE,
   HIGHMARK_CLI,
   LIVE_RELOAD_PATH,
+  FONT_DIRECTORY_NAME,
   DIVS_SELECTOR_STRING,
+  INDEX_JSON_FILE_NAME,
   DEFAULT_DIVISION_IDENTIFIER
 };

package/bin/defaultIndexOptions.js

@@ -0,0 +1,11 @@
+"use strict";
+
+const defaultIndexOptions = {
+  "phrases": [],
+  "plurals": [],
+  "acronyms": [],
+  "properNouns": [],
+  "ignoredWords": []
+};
+
+module.exports = defaultIndexOptions;

package/bin/operation/copyFonts.js

@@ -3,7 +3,7 @@
 const { copyFonts } = require("highmark-client"),
       { pathUtilities } = require("necessary");
 
-const { FONT } = require("../constants");
+const { FONT_DIRECTORY_NAME } = require("../constants");
 
 const { concatenatePaths } = pathUtilities;
 
@@ -17,7 +17,7 @@ function copyFontsOperation(proceed, abort, context) {
   }
 
   const { projectDirectoryPath } = context,
-        fontDirectoryPath = concatenatePaths(projectDirectoryPath, FONT);
+        fontDirectoryPath = concatenatePaths(projectDirectoryPath, FONT_DIRECTORY_NAME);
 
   copyFonts(fontDirectoryPath);
 

package/bin/operation/indexOptions.js

@@ -0,0 +1,69 @@
+"use strict";
+
+const { pathUtilities } = require("necessary");
+
+const defaultIndexOptions = require("../defaultIndexOptions");
+
+const { readFile, writeFile } = require("../utilities/fileSystem"),
+      { DOUBLE_SPACE, INDEX_JSON_FILE_NAME } = require("../constants");
+
+const { concatenatePaths } = pathUtilities;
+
+function indexOptionsOperation(proceed, abort, context) {
+  const { projectDirectoryName } = context;
+
+  let content,
+      indexOptions;
+
+  const indexJSONFilePath = concatenatePaths(projectDirectoryName, INDEX_JSON_FILE_NAME),
+        filePath = indexJSONFilePath;
+
+  content = readFile(filePath);
+
+  if (content === null) {
+    indexOptions = defaultIndexOptions; ///
+  } else {
+    let json,
+        jsonString;
+
+    jsonString = content;  ///
+
+    json = JSON.parse(jsonString);
+
+    const { phrases = [],
+            plurals = [],
+            acronyms = [],
+            properNouns = [],
+            ignoredWords = [] } = json;
+
+    phrases.sort();
+    plurals.sort();
+    acronyms.sort();
+    properNouns.sort();
+    ignoredWords.sort();
+
+    json = {
+      phrases,
+      plurals,
+      acronyms,
+      properNouns,
+      ignoredWords
+    };
+
+    jsonString = JSON.stringify(json, null, DOUBLE_SPACE);
+
+    content = jsonString;  ///
+
+    writeFile(indexJSONFilePath, content);
+
+    indexOptions = json;  ///
+  }
+
+  Object.assign(context, {
+    indexOptions
+  });
+
+  proceed();
+}
+
+module.exports = indexOptionsOperation;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "highmark-cli",
   "author": "James Smith",
-  "version": "1.3.21",
+  "version": "1.3.23",
   "license": "MIT, Anti-996",
   "homepage": "https://github.com/djalbat/highmark-cli",
   "description": "Highmark's LIC tool.",
@@ -12,11 +12,11 @@
   "dependencies": {
     "argumentative": "^2.0.28",
     "express": "^4.19.2",
-    "highmark-client": "^0.0.104",
-    "highmark-markdown": "^0.0.451",
+    "highmark-client": "^0.0.105",
+    "highmark-markdown": "^0.0.452",
     "lively-cli": "^2.0.65",
     "necessary": "^14.0.1",
-    "occam-entities": "^1.0.123"
+    "occam-entities": "^1.0.124"
   },
   "bin": {
     "highmark": "./highmark.js"

package/bin/indexOptions.js

@@ -1,134 +0,0 @@
-"use strict";
-
-const indexOptions = {
-  "phrases": [
-    "symbolic reasoning"
-  ],
-  "plurals": [
-    "grammar",
-    "language(s)"
-  ],
-  "acronyms": [
-    "CLI",
-  ],
-  "properNouns": [
-    "Occam"
-  ],
-  "ignoredWords": [
-    "a",
-    "all",
-    "also",
-    "an",
-    "and",
-    "another",
-    "approach",
-    "apt",
-    "are",
-    "as",
-    "associated",
-    "at",
-    "between",
-    "boils",
-    "book",
-    "but",
-    "called",
-    "cannot",
-    "companion",
-    "considerable",
-    "contents",
-    "controlled",
-    "covers",
-    "day",
-    "detail",
-    "detailed",
-    "distinguish",
-    "divers",
-    "down",
-    "encompasses",
-    "end",
-    "expert",
-    "explains",
-    "explanation",
-    "explanations",
-    "fact",
-    "florence",
-    "footnote",
-    "former",
-    "foundations",
-    "future",
-    "getting",
-    "goes",
-    "grips",
-    "has",
-    "have",
-    "here",
-    "how",
-    "i",
-    "ide",
-    "in",
-    "indeed",
-    "index",
-    "indexing",
-    "into",
-    "introduction",
-    "is",
-    "it",
-    "its",
-    "largely",
-    "least",
-    "limits",
-    "list",
-    "make",
-    "more",
-    "most",
-    "natural",
-    "near",
-    "nebulously",
-    "need",
-    "not",
-    "of",
-    "often",
-    "on",
-    "ordered",
-    "originally",
-    "own",
-    "paragraph",
-    "parts",
-    "possible",
-    "provide",
-    "purpose",
-    "range",
-    "reference",
-    "s",
-    "seemed",
-    "services",
-    "short",
-    "some",
-    "somewhat",
-    "started",
-    "subject",
-    "support",
-    "system",
-    "test",
-    "that",
-    "the",
-    "there",
-    "these",
-    "this",
-    "to",
-    "tried",
-    "underlying",
-    "unordered",
-    "use",
-    "useable",
-    "used",
-    "was",
-    "well",
-    "which",
-    "will",
-    "with",
-    "word"
-  ]
-};
-
-module.exports = indexOptions;