Strip more locations from models (#240)

Author: Will Scullin

package-lock.json

@@ -42,6 +42,7 @@
     "fs-extra": "^10.1.0",
     "http-server": "^14.1.1",
     "jsdom": "^19.0.0",
+    "prettier": "^3.0.1",
     "remark-gfm": "^1.0.0",
     "remark-parse": "^10.0.1",
     "shiki": "^0.10.1",

package.json

@@ -22,7 +22,7 @@
  */
 import packageJson from "../package.json";
 const argIndex = process.argv.indexOf("--baseurl");
-const BASEURL =  argIndex != -1 ? process.argv[argIndex + 1] : undefined;
+const BASEURL = argIndex != -1 ? process.argv[argIndex + 1] : undefined;
 
 if (BASEURL === undefined) {
   throw new Error("--baseurl is required");
@@ -31,7 +31,7 @@ if (BASEURL === undefined) {
 export const DEFAULT_CONTEXT = {
   site: {
     baseurl: BASEURL,
-    ga_site_id: 'G-0M10W7C20Y',
+    ga_site_id: "G-0M10W7C20Y",
     malloyRenderVersion: packageJson.devDependencies["@malloydata/render"],
   },
-}
+};

scripts/context.ts

@@ -27,4 +27,4 @@ export interface DocsError {
   position: Position;
   message: string;
   path: string;
-}
+}

scripts/errors.ts

@@ -63,8 +63,8 @@ const malloySQLTMGrammar = JSON.parse(
 const HIGHLIGHTER = shiki.getHighlighter({
   theme: "light-plus",
   paths: {
-    themes: "node_modules/shiki/themes/", 
-    languages: "node_modules/shiki/languages/"
+    themes: "node_modules/shiki/themes/",
+    languages: "node_modules/shiki/languages/",
   },
   langs: [
     "sql",

scripts/highlighter.ts

@@ -26,7 +26,10 @@ const YELLOW = "\x1b[33m";
 const GREEN = "\x1b[32m";
 const RESET = "\x1b[0m";
 
-export function log(message: string, style: "error" | "info" | "warning" | "success" = "info"): void {
+export function log(
+  message: string,
+  style: "error" | "info" | "warning" | "success" = "info"
+): void {
   const color = {
     error: RED,
     info: "",

scripts/log.ts

@@ -48,9 +48,9 @@ export type Markdown =
   | Yaml;
 
 export interface Position {
-  start: { line: number, column: number, offset: number },
-  end: { line: number, column: number, offset: number }
-};
+  start: { line: number; column: number; offset: number };
+  end: { line: number; column: number; offset: number };
+}
 
 export interface Node {
   position: Position;

scripts/markdown_types.ts

@@ -63,7 +63,10 @@ function enrichTableOfContents(sections: Section[]): EnrichedSection[] {
           const fullLink = path.join("/documentation", item.link);
           const compareLink = convertDocPathToHTML(fullLink);
           const htmlLinkRaw = fullLink.replace(/\.malloynb$/, "");
-          const htmlLink = htmlLinkRaw === "/documentation/index" ? "/documentation" : htmlLinkRaw;
+          const htmlLink =
+            htmlLinkRaw === "/documentation/index"
+              ? "/documentation"
+              : htmlLinkRaw;
           return { title: item.title, link: item.link, htmlLink, compareLink };
         } else {
           return enrichTableOfContents([item])[0];
@@ -141,15 +144,16 @@ const FOOTER_TEMPLATE_STRING = `
       <a href="{{ next.relative }}">{{ next.title }}<img src="{{ site.baseurl }}/img/next.svg" alt="next"/></a>
     {{/if }}
   </div>
-</div>`
+</div>`;
 const FOOTER_TEMPLATE = Handlebars.compile(FOOTER_TEMPLATE_STRING);
 
 export function renderFooter(
   sections: Section[],
   rootPath: string,
   docPath: string
 ): string {
-  const makeFullLink = (l: string) => path.join('/documentation', convertDocPathToHTML(l));
+  const makeFullLink = (l: string) =>
+    path.join("/documentation", convertDocPathToHTML(l));
   const items = extractItems(sections);
   const thisIndex = items.findIndex(
     (item) => makeFullLink(item.link) === docPath
@@ -175,13 +179,17 @@ export function renderFooter(
 
   return FOOTER_TEMPLATE({
     ...DEFAULT_CONTEXT,
-    next: next ? {
-      relative: nextRelative,
-      title: next.title
-    } : undefined,
-    previous: previous ? {
-      relative: previousRelative,
-      title: previous.title
-    } : undefined,
+    next: next
+      ? {
+          relative: nextRelative,
+          title: next.title,
+        }
+      : undefined,
+    previous: previous
+      ? {
+          relative: previousRelative,
+          title: previous.title,
+        }
+      : undefined,
   });
 }

scripts/page.ts

@@ -253,7 +253,7 @@ const isLocation = (value: unknown) => {
 
 const stripLocation = (modelDef: ModelDef): ModelDef => {
   return JSON.parse(JSON.stringify(modelDef), (key, value) => {
-    if (key === "location" && isLocation(value)) {
+    if (["location", "at"].includes(key) && isLocation(value)) {
       return undefined;
     } else {
       return value;

scripts/run_code.ts

@@ -25,7 +25,11 @@ import fs from "fs";
 import path from "path";
 
 export function isMalloyNB(file: string): boolean {
-  return file.endsWith(".malloysql") || file.endsWith(".malloynb") || file.endsWith("quick_reference.html");
+  return (
+    file.endsWith(".malloysql") ||
+    file.endsWith(".malloynb") ||
+    file.endsWith("quick_reference.html")
+  );
 }
 
 export function convertDocPathToHTML(file: string): string {
@@ -82,7 +86,7 @@ export function escape(html: string): string {
         ">": ">",
         '"': """,
         "'": "'",
-      }[ch] || "")
+      })[ch] || ""
   );
 }
 
@@ -124,5 +128,5 @@ export function watchDebouncedRecursive(
 }
 
 export function hashForHeading(heading: string) {
-  return heading.toLowerCase().replace(/[^\w]+/g, "-");;
+  return heading.toLowerCase().replace(/[^\w]+/g, "-");
 }