@ca-plant-list/ca-plant-list 0.4.26 → 0.4.27

package/scripts/build-site.js

@@ -1,76 +1,44 @@
 #!/usr/bin/env node
 
-import * as child_process from "node:child_process";
-import * as path from "node:path";
 import { Config } from "../lib/config.js";
-import { PageRenderer } from "../lib/pagerenderer.js";
+import { PageRenderer } from "../lib/web/renderAllPages.js";
 import { Files } from "../lib/files.js";
 import { Program } from "../lib/program.js";
 import { Taxa } from "../lib/taxonomy/taxa.js";
 import { ErrorLog } from "../lib/errorlog.js";
 
-class JekyllRenderer {
-    #srcDir = "./output";
-    #destDir = "./public";
-
-    async renderPages() {
-        /**
-         * @param {string[]} configFiles
-         * @param {string} dir
-         * @param {string} name
-         */
-        function addConfigFile(configFiles, dir, name) {
-            const fullPath = path.join(dir, name);
-            if (Files.exists(fullPath)) {
-                configFiles.push(fullPath);
-            }
-        }
-
-        // Remove existing files.
-        Files.rmDir(this.#destDir);
-
-        const options = [
-            "--source",
-            this.#srcDir,
-            "--destination",
-            this.#destDir,
-        ];
-
-        // Find out what config files are available.
-        /** @type {string[]} */
-        const configFiles = [];
-        addConfigFile(configFiles, this.#srcDir, "_config.yml");
-        addConfigFile(configFiles, this.#srcDir, "_config-local.yml");
-        addConfigFile(configFiles, ".", "_config-dev.yml");
-        options.push("--config", `"${configFiles.join()}"`);
-
-        const result = child_process.execSync(
-            "bundle exec jekyll build " + options.join(" "),
-        );
-        console.log(result.toString());
-    }
-}
-
 /**
- * @param {import("commander").OptionValues} options
+ * @param {{outputdir:string,datadir:string,webdir:string,showFlowerErrors:boolean,render:boolean}} options
  */
 async function build(options) {
-    Files.rmDir(options.outputdir);
-    const errorLog = new ErrorLog(options.outputdir + "/errors.tsv");
+    console.info("generating templates");
+    const outputDir = options.outputdir;
+    Files.rmDir(outputDir);
+    const errorLog = new ErrorLog(outputDir + "/errors.tsv");
     const taxa = new Taxa(
         Program.getIncludeList(options.datadir),
         errorLog,
         options.showFlowerErrors,
     );
-    PageRenderer.render(options.outputdir, new Config(options.datadir), taxa);
+    const config = new Config(options.datadir);
+    const generator = PageRenderer.newSiteGenerator(config, outputDir);
+    PageRenderer.renderAll(generator, config, taxa);
     errorLog.write();
 
-    console.log("generating site");
-    const r = new JekyllRenderer();
-    await r.renderPages();
+    if (options.render) {
+        console.info("generating site");
+        Files.rmDir(options.webdir);
+        await generator.generate(options.webdir);
+    }
 }
 
 const program = Program.getProgram();
+program.option(
+    "--no-render",
+    "Do not render full HTML output (only build the templates)",
+);
+program.option("-w, --webdir", "Directory for fully processed files", "public");
+
 program.action(build);
 
 await program.parseAsync();

package/static/assets/js/nameSearchData.js

@@ -0,0 +1,2 @@
+/** @type {import("../../../lib/types.js").NameSearchData[]} */
+export const NAMES = [];

package/{jekyll → static}/assets/js/name_search.js

@@ -1,8 +1,8 @@
+import { NAMES } from "./nameSearchData.js";
 import { Utils } from "./utils.js";
 
 /**
- * @typedef {[string]|[string,string]|[string,string|undefined,string[]]} RawSearchData
- * @typedef {{raw:RawSearchData,searchSci:string,searchCommon?:string,synonyms?:string[]}} SearchData
+ * @typedef {{raw:import("../../../lib/types.js").NameSearchData,searchSci:string,searchCommon?:string,synonyms?:string[]}} SearchData
  */
 
 const MIN_LEN = 2;
@@ -52,9 +52,9 @@ class Search {
                 // Include any matching synonyms.
                 for (const index of syns) {
                     matches.push([
-                        taxon.raw[0],
-                        taxon.raw[1],
-                        taxon.raw[2] ? taxon.raw[2][index] : undefined,
+                        taxon.raw.t,
+                        taxon.raw.c,
+                        taxon.raw.s ? taxon.raw.s[index] : undefined,
                     ]);
                 }
             } else {
@@ -62,7 +62,7 @@ class Search {
                 const namesMatch =
                     name.includes(value) || (cn && cn.includes(value));
                 if (namesMatch) {
-                    matches.push([taxon.raw[0], taxon.raw[1]]);
+                    matches.push([taxon.raw.t, taxon.raw.c]);
                 }
             }
         }
@@ -146,23 +146,21 @@ class Search {
         /** @type {SearchData[]} */
         const searchData = [];
 
-        /** @type {RawSearchData[]} */
-        // @ts-ignore
-        // eslint-disable-next-line no-undef
+        /** @type {import("../../../lib/types.js").NameSearchData[]} */
         const names = NAMES;
 
         for (const taxon of names) {
             /** @type {SearchData} */
             const taxonData = {
                 raw: taxon,
-                searchSci: this.#normalizeName(taxon[0]),
+                searchSci: this.#normalizeName(taxon.t),
             };
-            if (taxon[1]) {
-                taxonData.searchCommon = taxon[1].toLowerCase();
+            if (taxon.c) {
+                taxonData.searchCommon = taxon.c.toLowerCase();
             }
-            if (taxon[2]) {
+            if (taxon.s) {
                 const syns = [];
-                for (const syn of taxon[2]) {
+                for (const syn of taxon.s) {
                     syns.push(this.#normalizeName(syn));
                 }
                 taxonData.synonyms = syns;

package/static/name_search.html

@@ -0,0 +1,15 @@
+---
+title: Name Search
+js: name_search.js
+---
+
+<form id="search_form">
+    <input type="text" id="name" />
+    <label for="name"
+        >Search for scientific name, common name, or synonym.</label
+    >
+</form>
+
+<div class="section" id="message"></div>
+
+<table id="results"></table>

package/jekyll/name_search.html

@@ -1,17 +0,0 @@
----
-title: Name Search
-js: name_search.js
----
-
-<script>
-    const NAMES = {% include names.json %};
-</script>
-
-<form id="search_form">
-    <input type="text" id="name">
-    <label for="name">Search for scientific name, common name, or synonym.</label>
-</form>
-
-<div class="section" id="message"></div>
-
-<table id="results"></table>

package/lib/genericpage.js

@@ -1,88 +0,0 @@
-import { Config } from "./config.js";
-import { Files } from "./files.js";
-import { HTML } from "./html.js";
-import { Jekyll } from "./jekyll.js";
-import { Markdown } from "./markdown.js";
-
-class GenericPage {
-    #outputDir;
-    #title;
-    #baseFileName;
-    #js;
-
-    /**
-     * @param {string} outputDir
-     * @param {string} title
-     * @param {string} baseFileName
-     * @param {string} [js]
-     */
-    constructor(outputDir, title, baseFileName, js) {
-        this.#outputDir = outputDir;
-        this.#title = title;
-        this.#baseFileName = baseFileName;
-        this.#js = js;
-    }
-
-    getBaseFileName() {
-        return this.#baseFileName;
-    }
-
-    getDefaultIntro() {
-        let html = this.getFrontMatter();
-        return html + this.getMarkdown();
-    }
-
-    getFrontMatter() {
-        return (
-            "---\n" +
-            'title: "' +
-            this.#title +
-            '"\n' +
-            (this.#js ? "js: " + this.#js + "\n" : "") +
-            "---\n"
-        );
-    }
-
-    getMarkdown() {
-        // Include site-specific markdown.
-        let html = this.#getMarkdown("intros");
-
-        // Include package markdown.
-        const mdPath =
-            Config.getPackageDir() + "/data/text/" + this.#baseFileName + ".md";
-        const markdownHTML = Markdown.fileToHTML(mdPath);
-        if (markdownHTML) {
-            html += HTML.wrap("div", markdownHTML, { class: "section" });
-        }
-
-        return html;
-    }
-
-    /**
-     * @param {string} path
-     */
-    #getMarkdown(path) {
-        const textPath = path + "/" + this.#baseFileName + ".md";
-        if (!Jekyll.hasInclude(this.#outputDir, textPath)) {
-            return "";
-        }
-        return HTML.wrap("div", Jekyll.include(textPath), { class: "section" });
-    }
-
-    getOutputDir() {
-        return this.#outputDir;
-    }
-
-    getTitle() {
-        return this.#title;
-    }
-
-    /**
-     * @param {string} html
-     */
-    writeFile(html) {
-        Files.write(this.#outputDir + "/" + this.#baseFileName + ".html", html);
-    }
-}
-
-export { GenericPage };