highmark-occam 1.0.1 → 1.0.3

package/README.md

@@ -1,20 +1,21 @@
-# Highmark Yapp
+# Highmark Occam
 
 Highmark support for Occam.
 
 This package augments the HTML created with Highmark with listings for the following languages:
 
 * BNF
-* Furtle
 * JSON
-* Markdown
-* Markdown Style
+* Furtle
 * Nominal
 * Plain Text
+* Markdown
+* Markdown Style
 
 Additinoally, a pakbage name can be stipulated for Nominal listings and, provided the corresponding custom grammars have been registered, the Nominal listing will be parsed accordingly. For example:
 
-```nominal:first-order-logic
+```
+\`\`\`nominal:first-order-logic
 Lemma
   Suppose
     [F] |- R :: S
@@ -24,6 +25,7 @@ Lemma
     [G] is 𝘧𝘳𝘦𝘦 in [G] |- R :: S by FreeMetavariable
   Therefore
     ∃[G] [G] |- R :: S by MetaExistentialIntroduction
+\`\`\`
 ```
 
 The results are listings that are effectively indistinguishable from the pretty printed source in Occam's IDE.
@@ -44,8 +46,8 @@ There are several packages in the distribution.
 
 - [Highmark-CLI](https://github.com/djalbat/highmark-cli) Highmark's CLI tool.
 - [Highmark Yapp](https://github.com/djalbat/highmark-yapp) Highmark with Yapp listings.
-- [Highmark Occam](https://github.com/djalbat/highmark-yapp) Highmark support for Occam.
 - [Highmark Client](https://github.com/djalbat/highmark-client) Highmark's bundled client for viewing HTML.
+- [Highmark Occam](https://github.com/djalbat/highmark-occam) Highmark support for Occam.
 - [Highmark Markdown](https://github.com/djalbat/highmark-markdown) Highmark's Markdown and Markdown Style languages.
 
 Only the CLI tool is needed by end users.
@@ -55,7 +57,7 @@ All of the other packages are likely only of interest to prospective developers.
 
 If you would like to contribute or would simply like to have a look at the code, you can clone the repository with [Git](https://git-scm.com/)...
 
-    git clone https://github.com/djalbat/highmark-yapp.git
+    git clone https://github.com/djalbat/highmark-occam.git
 
 ...and then install the dependencies with [npm](https://www.npmjs.com/) from within the project's root directory:
 
@@ -81,12 +83,12 @@ One last thing to bear in mind is that this package is included by way of a rela
 
 ## Usage
 
-To begin with, in order to make use of Yapp you must render the requisite styles:
+To begin with you must render the requisite styles:
 
 ```
-import { renderYappStyles } from "highmark-yapp";
+import { renderOccamStyles } from "highmark-occam";
 
-renderYappStyles();
+renderOccamStyles();
 
 ...
 ```
@@ -94,9 +96,9 @@ renderYappStyles();
 Next, to create a node from some Markdown content, use the `tokensFromMarkdown()`, `markdownNodeFromTokens()` and `topmostHTMLNodeFromMarkdownNode()` utility functions:
 
 ```
-import { markdownUtilities } from "highmark-yapp";
+import { grammarUtilities } from "highmark-occam";
 
-const { tokensFromMarkdown, markdownNodeFromTokens } = markdownUtilities;
+const { tokensFromMarkdown, markdownNodeFromTokens } = grammarUtilities;
 
 const markdown = `
 
@@ -127,6 +129,38 @@ Note the use of the tokens in a `context` plain old JavaScript object that must
 This is why there are two utility functions to create the node in two stages.
 By the way, the sibling DOM element, if not null, must be a child of the parent DOM element, in which case the node will be mounted immediately after it.
 
+Lastly, if you plan to use Nominal lisintgs then register the custom grammars beforehand:
+
+```
+"use strict";
+
+import { customGrammarsUtilities } from "../index"; ///
+
+import firstOrderLogicCustomGrammarsJSON from "./customGrammarsJSON/firstOrderLogic";
+
+const { registerCustomGrammarsMap } = customGrammarsUtilities;
+
+const customGrammarsJSONMap = {
+  "first-order-logic": firstOrderLogicCustomGrammarsJSON
+}
+
+registerCustomGrammarsMap(customGrammarsJSONMap);
+```
+
+You can export the custom grammars directly from Occam's IDE and then paste them into the requisite file:
+
+```
+"use strict";
+
+export default [
+  { ... },
+  { ... }
+];
+```
+
+Registering the custom grammars in this way must be done before any listings are rendered.
+It is best to Follow the example application and place this code in a preamble.
+
 ## Building
 
 Automation is done with [npm scripts](https://docs.npmjs.com/misc/scripts), have a look at the `package.json` file. The pertinent commands are:

package/lib/example.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 require("juxtapose");
 const _easywithstyle = /*#__PURE__*/ _interop_require_default(require("easy-with-style"));
 const _easy = require("easy");
-const _occamstyles = require("occam-styles");
+const _index = require("./index");
 require("./example/preamble");
 const _view = /*#__PURE__*/ _interop_require_default(require("./example/view"));
 function _interop_require_default(obj) {
@@ -13,11 +13,10 @@ function _interop_require_default(obj) {
         default: obj
     };
 }
-const { renderStyle, renderStyles } = _easywithstyle.default;
+const { renderStyles } = _easywithstyle.default;
 const body = new _easy.Body();
+(0, _index.renderOccamStyles)();
 renderStyles();
-renderStyle(_occamstyles.prettyPrinterStyle);
-renderStyle(_occamstyles.juliaMonoStyle);
 body.mount(/*#__PURE__*/ React.createElement(_view.default, null));
 
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uL3NyYy9leGFtcGxlLmpzIl0sInNvdXJjZXNDb250ZW50IjpbIlwidXNlIHN0cmljdFwiO1xuXG5pbXBvcnQgXCJqdXh0YXBvc2VcIjtcblxuaW1wb3J0IHdpdGhTdHlsZSBmcm9tIFwiZWFzeS13aXRoLXN0eWxlXCI7ICAvLy9cblxuaW1wb3J0IHsgQm9keSB9IGZyb20gXCJlYXN5XCI7XG5pbXBvcnQgeyBqdWxpYU1vbm9TdHlsZSwgcHJldHR5UHJpbnRlclN0eWxlIH0gZnJvbSBcIm9jY2FtLXN0eWxlc1wiO1xuXG5pbXBvcnQgXCIuL2V4YW1wbGUvcHJlYW1ibGVcIjtcblxuaW1wb3J0IFZpZXcgZnJvbSBcIi4vZXhhbXBsZS92aWV3XCI7XG5cbmNvbnN0IHsgcmVuZGVyU3R5bGUsIHJlbmRlclN0eWxlcyB9ID0gd2l0aFN0eWxlO1xuXG5jb25zdCBib2R5ID0gbmV3IEJvZHkoKTtcblxucmVuZGVyU3R5bGVzKCk7XG5cbnJlbmRlclN0eWxlKHByZXR0eVByaW50ZXJTdHlsZSk7XG5cbnJlbmRlclN0eWxlKGp1bGlhTW9ub1N0eWxlKTtcblxuYm9keS5tb3VudChcblxuICA8Vmlldy8+XG5cbik7XG4iXSwibmFtZXMiOlsicmVuZGVyU3R5bGUiLCJyZW5kZXJTdHlsZXMiLCJ3aXRoU3R5bGUiLCJib2R5IiwiQm9keSIsInByZXR0eVByaW50ZXJTdHlsZSIsImp1bGlhTW9ub1N0eWxlIiwibW91bnQiLCJWaWV3Il0sIm1hcHBpbmdzIjoiQUFBQTs7OztRQUVPO3NFQUVlO3NCQUVEOzZCQUM4QjtRQUU1Qzs2REFFVTs7Ozs7O0FBRWpCLE1BQU0sRUFBRUEsV0FBVyxFQUFFQyxZQUFZLEVBQUUsR0FBR0Msc0JBQVM7QUFFL0MsTUFBTUMsT0FBTyxJQUFJQyxVQUFJO0FBRXJCSDtBQUVBRCxZQUFZSywrQkFBa0I7QUFFOUJMLFlBQVlNLDJCQUFjO0FBRTFCSCxLQUFLSSxLQUFLLGVBRVIsb0JBQUNDLGFBQUkifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uL3NyYy9leGFtcGxlLmpzIl0sInNvdXJjZXNDb250ZW50IjpbIlwidXNlIHN0cmljdFwiO1xuXG5pbXBvcnQgXCJqdXh0YXBvc2VcIjtcblxuaW1wb3J0IHdpdGhTdHlsZSBmcm9tIFwiZWFzeS13aXRoLXN0eWxlXCI7ICAvLy9cblxuaW1wb3J0IHsgQm9keSB9IGZyb20gXCJlYXN5XCI7XG5pbXBvcnQgeyByZW5kZXJPY2NhbVN0eWxlcyB9IGZyb20gXCIuL2luZGV4XCI7IC8vL1xuXG5pbXBvcnQgXCIuL2V4YW1wbGUvcHJlYW1ibGVcIjtcblxuaW1wb3J0IFZpZXcgZnJvbSBcIi4vZXhhbXBsZS92aWV3XCI7XG5cbmNvbnN0IHsgcmVuZGVyU3R5bGVzIH0gPSB3aXRoU3R5bGU7XG5cbmNvbnN0IGJvZHkgPSBuZXcgQm9keSgpO1xuXG5yZW5kZXJPY2NhbVN0eWxlcygpO1xuXG5yZW5kZXJTdHlsZXMoKTtcblxuYm9keS5tb3VudChcblxuICA8Vmlldy8+XG5cbik7XG4iXSwibmFtZXMiOlsicmVuZGVyU3R5bGVzIiwid2l0aFN0eWxlIiwiYm9keSIsIkJvZHkiLCJyZW5kZXJPY2NhbVN0eWxlcyIsIm1vdW50IiwiVmlldyJdLCJtYXBwaW5ncyI6IkFBQUE7Ozs7UUFFTztzRUFFZTtzQkFFRDt1QkFDYTtRQUUzQjs2REFFVTs7Ozs7O0FBRWpCLE1BQU0sRUFBRUEsWUFBWSxFQUFFLEdBQUdDLHNCQUFTO0FBRWxDLE1BQU1DLE9BQU8sSUFBSUMsVUFBSTtBQUVyQkMsSUFBQUEsd0JBQWlCO0FBRWpCSjtBQUVBRSxLQUFLRyxLQUFLLGVBRVIsb0JBQUNDLGFBQUkifQ==

package/lib/index.js

@@ -17,10 +17,21 @@ _export(exports, {
     },
     get grammarUtilities () {
         return _grammar.default;
+    },
+    get juliaMonoStyle () {
+        return _occamstyles.juliaMonoStyle;
+    },
+    get prettyPrinterStyle () {
+        return _occamstyles.prettyPrinterStyle;
+    },
+    get renderOccamStyles () {
+        return _renderOccamStyles.default;
     }
 });
+const _occamstyles = require("occam-styles");
 const _blockListing = /*#__PURE__*/ _interop_require_default(require("./blockListing"));
 const _grammar = /*#__PURE__*/ _interop_require_default(require("./utilities/grammar"));
+const _renderOccamStyles = /*#__PURE__*/ _interop_require_default(require("./renderOccamStyles"));
 const _customGrammars = /*#__PURE__*/ _interop_require_default(require("./utilities/customGrammars"));
 function _interop_require_default(obj) {
     return obj && obj.__esModule ? obj : {
@@ -28,4 +39,4 @@ function _interop_require_default(obj) {
     };
 }
 
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uL3NyYy9pbmRleC5qcyJdLCJzb3VyY2VzQ29udGVudCI6WyJcInVzZSBzdHJpY3RcIjtcblxuZXhwb3J0IHsgZGVmYXVsdCBhcyBCbG9ja0xpc3RpbmcgfSBmcm9tIFwiLi9ibG9ja0xpc3RpbmdcIjtcbmV4cG9ydCB7IGRlZmF1bHQgYXMgZ3JhbW1hclV0aWxpdGllcyB9IGZyb20gXCIuL3V0aWxpdGllcy9ncmFtbWFyXCI7XG5leHBvcnQgeyBkZWZhdWx0IGFzIGN1c3RvbUdyYW1tYXJzVXRpbGl0aWVzIH0gZnJvbSBcIi4vdXRpbGl0aWVzL2N1c3RvbUdyYW1tYXJzXCI7XG4iXSwibmFtZXMiOlsiQmxvY2tMaXN0aW5nIiwiY3VzdG9tR3JhbW1hcnNVdGlsaXRpZXMiLCJncmFtbWFyVXRpbGl0aWVzIl0sIm1hcHBpbmdzIjoiQUFBQTs7Ozs7Ozs7Ozs7UUFFb0JBO2VBQUFBLHFCQUFZOztRQUVaQztlQUFBQSx1QkFBdUI7O1FBRHZCQztlQUFBQSxnQkFBZ0I7OztxRUFESTtnRUFDSTt1RUFDTyJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uL3NyYy9pbmRleC5qcyJdLCJzb3VyY2VzQ29udGVudCI6WyJcInVzZSBzdHJpY3RcIjtcblxuZXhwb3J0IHsganVsaWFNb25vU3R5bGUsIHByZXR0eVByaW50ZXJTdHlsZSB9IGZyb20gXCJvY2NhbS1zdHlsZXNcIjtcblxuZXhwb3J0IHsgZGVmYXVsdCBhcyBCbG9ja0xpc3RpbmcgfSBmcm9tIFwiLi9ibG9ja0xpc3RpbmdcIjtcbmV4cG9ydCB7IGRlZmF1bHQgYXMgZ3JhbW1hclV0aWxpdGllcyB9IGZyb20gXCIuL3V0aWxpdGllcy9ncmFtbWFyXCI7XG5leHBvcnQgeyBkZWZhdWx0IGFzIHJlbmRlck9jY2FtU3R5bGVzIH0gZnJvbSBcIi4vcmVuZGVyT2NjYW1TdHlsZXNcIjtcbmV4cG9ydCB7IGRlZmF1bHQgYXMgY3VzdG9tR3JhbW1hcnNVdGlsaXRpZXMgfSBmcm9tIFwiLi91dGlsaXRpZXMvY3VzdG9tR3JhbW1hcnNcIjtcbiJdLCJuYW1lcyI6WyJCbG9ja0xpc3RpbmciLCJjdXN0b21HcmFtbWFyc1V0aWxpdGllcyIsImdyYW1tYXJVdGlsaXRpZXMiLCJqdWxpYU1vbm9TdHlsZSIsInByZXR0eVByaW50ZXJTdHlsZSIsInJlbmRlck9jY2FtU3R5bGVzIl0sIm1hcHBpbmdzIjoiQUFBQTs7Ozs7Ozs7Ozs7UUFJb0JBO2VBQUFBLHFCQUFZOztRQUdaQztlQUFBQSx1QkFBdUI7O1FBRnZCQztlQUFBQSxnQkFBZ0I7O1FBSDNCQztlQUFBQSwyQkFBYzs7UUFBRUM7ZUFBQUEsK0JBQWtCOztRQUl2QkM7ZUFBQUEsMEJBQWlCOzs7NkJBSmM7cUVBRVg7Z0VBQ0k7MEVBQ0M7dUVBQ00ifQ==

package/lib/renderOccamStyles.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return renderOccamStyles;
+    }
+});
+const _easywithstyle = /*#__PURE__*/ _interop_require_default(require("easy-with-style"));
+const _index = require("./index");
+function _interop_require_default(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+const { renderStyle } = _easywithstyle.default;
+function renderOccamStyles() {
+    renderStyle(_index.prettyPrinterStyle);
+    renderStyle(_index.juliaMonoStyle);
+}
+
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uL3NyYy9yZW5kZXJPY2NhbVN0eWxlcy5qcyJdLCJzb3VyY2VzQ29udGVudCI6WyJcInVzZSBzdHJpY3RcIjtcblxuaW1wb3J0IHdpdGhTdHlsZSBmcm9tIFwiZWFzeS13aXRoLXN0eWxlXCI7ICAvLy9cblxuaW1wb3J0IHsganVsaWFNb25vU3R5bGUsIHByZXR0eVByaW50ZXJTdHlsZSB9IGZyb20gXCIuL2luZGV4XCI7IC8vL1xuXG5jb25zdCB7IHJlbmRlclN0eWxlIH0gPSB3aXRoU3R5bGU7XG5cbmV4cG9ydCBkZWZhdWx0IGZ1bmN0aW9uIHJlbmRlck9jY2FtU3R5bGVzKCkge1xuICByZW5kZXJTdHlsZShwcmV0dHlQcmludGVyU3R5bGUpO1xuXG4gIHJlbmRlclN0eWxlKGp1bGlhTW9ub1N0eWxlKTtcbn1cbiJdLCJuYW1lcyI6WyJyZW5kZXJPY2NhbVN0eWxlcyIsInJlbmRlclN0eWxlIiwid2l0aFN0eWxlIiwicHJldHR5UHJpbnRlclN0eWxlIiwianVsaWFNb25vU3R5bGUiXSwibWFwcGluZ3MiOiJBQUFBOzs7OytCQVFBOzs7ZUFBd0JBOzs7c0VBTkY7dUJBRTZCOzs7Ozs7QUFFbkQsTUFBTSxFQUFFQyxXQUFXLEVBQUUsR0FBR0Msc0JBQVM7QUFFbEIsU0FBU0Y7SUFDdEJDLFlBQVlFLHlCQUFrQjtJQUU5QkYsWUFBWUcscUJBQWM7QUFDNUIifQ==

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "highmark-occam",
   "author": "James Smith",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "license": "MIT, Anti-996",
   "homepage": "https://github.com/djalbat/highmark-occam",
   "description": "Highmark support for Occam.",
@@ -11,7 +11,8 @@
   },
   "dependencies": {
     "easy": "^24.1.8",
-    "highmark-markdown": "^1.2.93",
+    "easy-with-style": "^3.0.549",
+    "highmark-markdown": "^1.2.94",
     "occam-custom-grammars": "^6.0.36",
     "occam-grammars": "^1.3.529",
     "occam-lexers": "^23.1.48",
@@ -24,7 +25,6 @@
   "devDependencies": {
     "@swc/core": "1.13.20",
     "easy-layout": "^6.0.301",
-    "easy-with-style": "^3.0.549",
     "esbuild": "0.11.14",
     "express": "^4.17.1",
     "juxtapose": "^4.0.136",

package/src/example.js

@@ -5,21 +5,19 @@ import "juxtapose";
 import withStyle from "easy-with-style";  ///
 
 import { Body } from "easy";
-import { juliaMonoStyle, prettyPrinterStyle } from "occam-styles";
+import { renderOccamStyles } from "./index"; ///
 
 import "./example/preamble";
 
 import View from "./example/view";
 
-const { renderStyle, renderStyles } = withStyle;
+const { renderStyles } = withStyle;
 
 const body = new Body();
 
-renderStyles();
-
-renderStyle(prettyPrinterStyle);
+renderOccamStyles();
 
-renderStyle(juliaMonoStyle);
+renderStyles();
 
 body.mount(
 

package/src/index.js

@@ -1,5 +1,8 @@
 "use strict";
 
+export { juliaMonoStyle, prettyPrinterStyle } from "occam-styles";
+
 export { default as BlockListing } from "./blockListing";
 export { default as grammarUtilities } from "./utilities/grammar";
+export { default as renderOccamStyles } from "./renderOccamStyles";
 export { default as customGrammarsUtilities } from "./utilities/customGrammars";

package/src/renderOccamStyles.js

@@ -0,0 +1,13 @@
+"use strict";
+
+import withStyle from "easy-with-style";  ///
+
+import { juliaMonoStyle, prettyPrinterStyle } from "./index"; ///
+
+const { renderStyle } = withStyle;
+
+export default function renderOccamStyles() {
+  renderStyle(prettyPrinterStyle);
+
+  renderStyle(juliaMonoStyle);
+}