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

package/lib/sitegenerator.js

@@ -1,16 +1,29 @@
+import path from "node:path";
 import { optimize } from "svgo-ll";
 
 import { Config } from "./config.js";
 import { Files } from "./files.js";
 
-class SiteGenerator {
+const FRONT_DELIM = "---";
+
+export class SiteGenerator {
+    #config;
     #baseDir;
+    #options;
 
     /**
+     * @param {Config} config
      * @param {string} baseDir
+     * @param {import("./index.js").SiteGeneratorOptions} [options]
      */
-    constructor(baseDir) {
+    constructor(config, baseDir, options = {}) {
+        this.#config = config;
         this.#baseDir = baseDir;
+        this.#options = options;
+    }
+
+    copyGeneratorFiles() {
+        throw new Error("must be implemented by subclass");
     }
 
     /**
@@ -23,11 +36,11 @@ class SiteGenerator {
          */
         function createFlowerColorIcons(outputDir, flowerColors) {
             // Read generic input.
-            const inputFileName = Files.join(outputDir, "flower.svg");
+            const inputFileName = path.join(outputDir, "flower.svg");
             const srcSVG = Files.read(inputFileName);
             for (const color of flowerColors) {
                 Files.write(
-                    Files.join(outputDir, "f-" + color.getColorName() + ".svg"),
+                    path.join(outputDir, "f-" + color.getColorName() + ".svg"),
                     srcSVG.replace("#ff0", color.getColorCode()),
                 );
             }
@@ -59,26 +72,69 @@ class SiteGenerator {
         createFlowerColorIcons(outputDir, flowerColors);
     }
 
+    copyStaticFiles() {
+        // First copy default files from ca-plant-list.
+        Files.copyDir(
+            path.join(Config.getPackageDir(), "static"),
+            this.#baseDir,
+        );
+        // Then copy files from current directory (which may override default files).
+        Files.copyDir("./static", this.#baseDir);
+    }
+
+    /**
+     * @param {string} webDir
+     */
+    // eslint-disable-next-line no-unused-vars
+    async generate(webDir) {
+        throw new Error("must be implemented by subclass");
+    }
+
     getBaseDir() {
         return this.#baseDir;
     }
 
+    getConfig() {
+        return this.#config;
+    }
+
     /**
-     * @param {string} path
+     * @param {Object<string,string|undefined>} atts
      */
-    mkdir(path) {
-        Files.mkdir(Files.join(this.#baseDir, path));
+    getFrontMatter(atts) {
+        const lines = [FRONT_DELIM];
+        for (const [k, v] of Object.entries(atts)) {
+            if (v) {
+                lines.push(k + ': "' + v + '"');
+            }
+        }
+        lines.push(FRONT_DELIM);
+        return lines.join("\n") + "\n\n";
+    }
+
+    /**
+     * @returns {string[]}
+     */
+    getPassThroughPatterns() {
+        return this.#options.passThroughPatterns ?? [];
+    }
+
+    /**
+     * @param {string} outputSubdir
+     */
+    mkdir(outputSubdir) {
+        Files.mkdir(path.join(this.#baseDir, outputSubdir));
     }
 
     /**
      * @param {string} content
-     * @param {{title:string}} attributes
+     * @param {Object<string,string>} attributes
      * @param {string} filename
      */
-    // eslint-disable-next-line no-unused-vars
     writeTemplate(content, attributes, filename) {
-        throw new Error("must be implemented by subclass");
+        Files.write(
+            path.join(this.getBaseDir(), filename),
+            this.getFrontMatter(attributes) + content,
+        );
     }
 }
-
-export { SiteGenerator };

package/lib/taxonomy/taxa.js

@@ -40,7 +40,7 @@ class Taxa {
     #isSubset;
 
     /**
-     * @param {Object<string,import("../index.js").TaxonData>|true} inclusionList
+     * @param {Object<string,import("../index.js").TaxonOverrides>|true} inclusionList
      * @param {ErrorLog} errorLog
      * @param {boolean} showFlowerErrors
      * @param {function(import("../index.js").TaxonData,Genera):Taxon} taxonFactory
@@ -224,7 +224,7 @@ class Taxa {
 
     /**
      * @param {SynonymData[]} synCSV
-     * @param {Object<string,import("../index.js").TaxonData>|boolean} inclusionList
+     * @param {Object<string,import("../index.js").TaxonOverrides>|boolean} inclusionList
      */
     #loadSyns(synCSV, inclusionList) {
         for (const syn of synCSV) {
@@ -246,7 +246,7 @@ class Taxa {
 
     /**
      * @param {import("../index.js").TaxonData[]} taxaCSV
-     * @param {Object<string,import("../index.js").TaxonData>|true} inclusionList
+     * @param {Object<string,import("../index.js").TaxonOverrides>|true} inclusionList
      * @param {function(import("../index.js").TaxonData,Genera):Taxon} taxonFactory
      * @param {Genera} genera
      * @param {boolean} showFlowerErrors
@@ -255,7 +255,7 @@ class Taxa {
         for (const row of taxaCSV) {
             const name = row["taxon_name"];
 
-            /** @type {import("../index.js").TaxonData|{status?:import("../index.js").NativeStatusCode}} */
+            /** @type {import("../index.js").TaxonOverrides} */
             let taxon_overrides = {};
             if (inclusionList !== true) {
                 taxon_overrides = inclusionList[name];

package/lib/types.js

@@ -1,8 +1,12 @@
 /**
+ * Types
+ * @typedef {{t:string,c?:string,s?:string[]}} NameSearchData
+ *
  * Classes
  * @typedef {import("./config.js").Config} Config
  * @typedef {import("./taxonomy/families.js").Families} Families
  * @typedef {import("./taxonomy/families.js").Family} Family
+ * @typedef {import("./sitegenerator.js").SiteGenerator} SiteGenerator
  * @typedef {import("./taxonomy/taxa.js").Taxa} Taxa
  * @typedef {import("./index.js").TaxaColDef<import("./types.js").Taxon>} TaxaColDef
  * @typedef {import("./taxonomy/taxon.js").Taxon} Taxon

package/lib/utils/eleventyGenerator.js

@@ -0,0 +1,82 @@
+// @ts-ignore
+import { Eleventy } from "@11ty/eleventy";
+import { SiteGenerator } from "../sitegenerator.js";
+import path from "node:path";
+import { Files } from "../files.js";
+import { Config } from "../config.js";
+
+export class EleventyGenerator extends SiteGenerator {
+    copyGeneratorFiles() {
+        // First copy default files from package.
+        const layoutSrc = "./generators/eleventy/layouts";
+        const commonSrc = "./generators/_includes";
+        const dest = path.join(this.getBaseDir(), "_includes");
+
+        Files.copyDir(path.join(Config.getPackageDir(), commonSrc), dest);
+        Files.copyDir(path.join(Config.getPackageDir(), layoutSrc), dest);
+
+        // Then copy files from current dir (which may override default files).
+        if (Files.isDir(commonSrc)) {
+            Files.copyDir(commonSrc, dest);
+        }
+        if (Files.isDir(layoutSrc)) {
+            Files.copyDir(layoutSrc, dest);
+        }
+    }
+
+    /**
+     * @param {string} webDir
+     */
+    async generate(webDir) {
+        const srcDir = this.getBaseDir();
+        const config = this.getConfig();
+        const generator = this;
+        let elev = new Eleventy(srcDir, webDir, {
+            quietMode: true,
+            config:
+                // @ts-ignore
+                function (eleventyConfig) {
+                    // Not running in project root, so using .gitignore will break things.
+                    eleventyConfig.setUseGitIgnore(false);
+
+                    // Don't change file system structure when writing output files.
+                    eleventyConfig.addGlobalData("permalink", () => {
+                        // @ts-ignore
+                        return (data) => {
+                            // Include directories in the generated content.
+                            const inputPath = path.relative(
+                                srcDir,
+                                data.page.inputPath,
+                            );
+                            // Remove the file extension.
+                            const parsed = path.parse(inputPath);
+                            return path.join(parsed.dir, `${parsed.name}.html`);
+                        };
+                    });
+
+                    // Use layout with <h1> by default.
+                    eleventyConfig.addGlobalData("layout", "h1.njk");
+
+                    // Set site name for use in nav bar.
+                    eleventyConfig.addGlobalData(
+                        "siteName",
+                        config.getSiteName(),
+                    );
+
+                    const passThroughPatterns = [
+                        "assets",
+                        "i",
+                        "errors.tsv",
+                        ...generator.getPassThroughPatterns(),
+                    ];
+                    for (const pattern of passThroughPatterns) {
+                        eleventyConfig.addPassthroughCopy(
+                            // Eleventy apparently can't handle windows paths in globs, so change it.
+                            path.join(srcDir, pattern).replaceAll("\\", "/"),
+                        );
+                    }
+                },
+        });
+        await elev.write();
+    }
+}

package/lib/utils/htmlFragments.js

@@ -0,0 +1,19 @@
+import { HTML } from "../html.js";
+import { Markdown } from "../markdown.js";
+
+/**
+ * Utilities to create HTML fragments specific to ca-plant-list.
+ */
+export class HTMLFragments {
+    /**
+     * @param {string} filePath
+     * @returns {string}
+     */
+    static getMarkdownSection(filePath) {
+        const footerMarkdown = Markdown.fileToHTML(filePath);
+        if (footerMarkdown) {
+            return HTML.wrap("div", footerMarkdown, "section");
+        }
+        return "";
+    }
+}

package/lib/web/glossarypages.js

@@ -1,11 +1,11 @@
 import { Glossary } from "../plants/glossary.js";
 import { Markdown } from "../markdown.js";
 import { HTML } from "../html.js";
-import { Files } from "../files.js";
+import path from "node:path";
 
 const ENTRY_DIR = "g";
 
-class GlossaryPages {
+export class GlossaryPages {
     #siteGenerator;
     #glossary;
 
@@ -22,14 +22,13 @@ class GlossaryPages {
      */
     #generateEntryPage(entry) {
         const title = entry.getTermName();
-        let html = HTML.textElement("h1", title);
-        html += HTML.wrap("div", Markdown.strToHTML(entry.getMarkdown()), {
+        let html = HTML.wrap("div", Markdown.strToHTML(entry.getMarkdown()), {
             class: "glossary",
         });
         this.#siteGenerator.writeTemplate(
             html,
             { title: title },
-            Files.join(ENTRY_DIR, title + ".html"),
+            path.posix.join(ENTRY_DIR, title + ".html"),
         );
     }
 
@@ -49,13 +48,12 @@ class GlossaryPages {
         for (const entry of entries) {
             links.push(
                 HTML.getLink(
-                    Files.join(ENTRY_DIR, entry.getHTMLFileName()),
+                    path.posix.join(ENTRY_DIR, entry.getHTMLFileName()),
                     entry.getTermName(),
                 ),
             );
         }
-        let html = HTML.wrap("h1", "Glossary");
-        html += HTML.wrap("ol", HTML.arrayToLI(links));
+        const html = HTML.wrap("ol", HTML.arrayToLI(links));
         this.#siteGenerator.writeTemplate(
             html,
             { title: "Glossary" },
@@ -72,5 +70,3 @@ class GlossaryPages {
         this.#generateEntryPages();
     }
 }
-
-export { GlossaryPages };

package/lib/web/pageFamily.js

@@ -1,5 +1,5 @@
 import { ExternalSites } from "../externalsites.js";
-import { GenericPage } from "../genericpage.js";
+import { GenericPage } from "./pageGeneric.js";
 import { HTML } from "../html.js";
 import { HTMLTaxon } from "../htmltaxon.js";
 import { Sections } from "../taxonomy/families.js";
@@ -8,11 +8,11 @@ export class PageFamilyList extends GenericPage {
     #families;
 
     /**
-     * @param {string} outputDir
+     * @param {import("../types.js").SiteGenerator} siteGenerator
      * @param {import("../types.js").Family[]} families
      */
-    constructor(outputDir, families) {
-        super(outputDir, "Families", "list_families");
+    constructor(siteGenerator, families) {
+        super(siteGenerator, "Families", "list_families");
         this.#families = families;
     }
 
@@ -28,7 +28,7 @@ export class PageFamilyList extends GenericPage {
             const taxa = sections[name];
 
             // Render the section page.
-            new PageSection(this.getOutputDir(), name, taxa).render(
+            new PageSection(this.getSiteGenerator(), name, taxa).render(
                 taxaColumns,
             );
 
@@ -69,13 +69,13 @@ export class PageFamilyList extends GenericPage {
     }
 
     /**
-     * @param {string} outputDir
+     * @param {import("../types.js").SiteGenerator} siteGenerator
      * @param {import("../types.js").TaxaColDef[]} [taxaColumns]
      */
-    renderPages(outputDir, taxaColumns) {
+    renderPages(siteGenerator, taxaColumns) {
         for (const family of this.#families) {
             if (family.getTaxa()) {
-                new PageFamily(outputDir, family).render(taxaColumns);
+                new PageFamily(siteGenerator, family).render(taxaColumns);
             }
         }
     }
@@ -85,11 +85,11 @@ class PageFamily extends GenericPage {
     #family;
 
     /**
-     * @param {string} outputDir
+     * @param {import("../types.js").SiteGenerator} siteGenerator
      * @param {import("../types.js").Family} family
      */
-    constructor(outputDir, family) {
-        super(outputDir, family.getName(), family.getBaseFileName());
+    constructor(siteGenerator, family) {
+        super(siteGenerator, family.getName(), family.getBaseFileName());
         this.#family = family;
     }
 
@@ -124,12 +124,12 @@ class PageSection extends GenericPage {
     #taxa;
 
     /**
-     * @param {string} outputDir
+     * @param {import("../types.js").SiteGenerator} siteGenerator
      * @param {string} name
      * @param {import("../types.js").Taxon[]} taxa
      */
-    constructor(outputDir, name, taxa) {
-        super(outputDir, name, name);
+    constructor(siteGenerator, name, taxa) {
+        super(siteGenerator, name, name);
         this.#taxa = taxa;
     }
 

package/lib/web/pageGeneric.js

@@ -0,0 +1,78 @@
+import path from "node:path";
+import { Config } from "../config.js";
+import { Files } from "../files.js";
+import { HTMLFragments } from "../utils/htmlFragments.js";
+
+export class GenericPage {
+    #siteGenerator;
+    #title;
+    #baseFileName;
+    #js;
+
+    /**
+     * @param {import("../types.js").SiteGenerator} siteGenerator
+     * @param {string} title
+     * @param {string} baseFileName
+     * @param {string} [js]
+     */
+    constructor(siteGenerator, title, baseFileName, js) {
+        this.#siteGenerator = siteGenerator;
+        this.#title = title;
+        this.#baseFileName = baseFileName;
+        this.#js = js;
+    }
+
+    getBaseFileName() {
+        return this.#baseFileName;
+    }
+
+    getDefaultIntro() {
+        let html = this.getFrontMatter();
+        return html + this.getMarkdown();
+    }
+
+    getFrontMatter() {
+        return this.#siteGenerator.getFrontMatter({
+            title: this.#title,
+            js: this.#js,
+        });
+    }
+
+    getMarkdown() {
+        const localTextPath = path.join(
+            "./data/intros",
+            `${this.#baseFileName}.md`,
+        );
+        const globalTextPath = path.join(
+            Config.getPackageDir(),
+            "./data/text/",
+            `${this.#baseFileName}.md`,
+        );
+        return (
+            HTMLFragments.getMarkdownSection(localTextPath) +
+            HTMLFragments.getMarkdownSection(globalTextPath)
+        );
+    }
+
+    getOutputDir() {
+        return this.#siteGenerator.getBaseDir();
+    }
+
+    getSiteGenerator() {
+        return this.#siteGenerator;
+    }
+
+    getTitle() {
+        return this.#title;
+    }
+
+    /**
+     * @param {string} html
+     */
+    writeFile(html) {
+        Files.write(
+            path.join(this.getOutputDir(), `${this.#baseFileName}.html`),
+            html,
+        );
+    }
+}

package/lib/web/{pagetaxon.js → pageTaxon.js}

@@ -1,5 +1,5 @@
 import { RarePlants } from "../rareplants.js";
-import { GenericPage } from "../genericpage.js";
+import { GenericPage } from "./pageGeneric.js";
 import { HTML } from "../html.js";
 import { HTMLTaxon } from "../htmltaxon.js";
 
@@ -8,12 +8,12 @@ export class PageTaxon extends GenericPage {
     #taxon;
 
     /**
-     * @param {string} outputDir
+     * @param {import("../types.js").SiteGenerator} siteGenerator
      * @param {import("../config.js").Config} config
      * @param {import("../types.js").Taxon} taxon
      */
-    constructor(outputDir, config, taxon) {
-        super(outputDir, taxon.getName(), taxon.getBaseFileName());
+    constructor(siteGenerator, config, taxon) {
+        super(siteGenerator, taxon.getName(), taxon.getBaseFileName());
         this.#config = config;
         this.#taxon = taxon;
     }

package/lib/web/pageTaxonList.js

@@ -0,0 +1,53 @@
+import { GenericPage } from "./pageGeneric.js";
+import { HTML } from "../html.js";
+import { HTMLTaxon } from "../htmltaxon.js";
+
+export class PageTaxonList extends GenericPage {
+    /**
+     * @param {import("../types.js").SiteGenerator} siteGenerator
+     * @param {string} title
+     * @param {string} baseName
+     */
+    constructor(siteGenerator, title, baseName) {
+        super(siteGenerator, title, baseName);
+    }
+
+    /**
+     *
+     * @param {import("../types.js").Taxon[]} taxa
+     * @param {import("../types.js").TaxaColDef[]|undefined} columns
+     */
+    render(taxa, columns) {
+        let html = this.getDefaultIntro();
+
+        html += '<div class="wrapper">';
+
+        html += '<div class="section">';
+        html += HTMLTaxon.getTaxaTable(taxa, columns);
+        html += "</div>";
+
+        html += '<div class="section nobullet">';
+        html += HTML.textElement("h2", "Download");
+        html += "<ul>";
+        html +=
+            "<li>" +
+            HTML.getLink(
+                "./calflora_" + this.getBaseFileName() + ".txt",
+                "Calflora List",
+            ) +
+            "</li>";
+        html +=
+            "<li>" +
+            HTML.getLink(
+                "./inat_" + this.getBaseFileName() + ".txt",
+                "iNaturalist List",
+            ) +
+            "</li>";
+        html += "</ul>";
+        html += "</div>";
+
+        html += "</div>";
+
+        this.writeFile(html);
+    }
+}