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

package/data/taxa.csv

@@ -503,6 +503,7 @@ Cryptantha clevelandii var. florosa,,N,57120,11565,1045003,203153,,Coastal Crypt
 Cryptantha corollata,,N,21213,2452,58853,203157,,Coast Range Cryptantha
 Cryptantha flaccida,,N,21228,2460,56989,203167,,Flaccid Cryptantha
 Cryptantha hooveri,,N,21240,2468,57701,245944,,Hoover's Cryptantha,,,,,525,1A,,,SH,GH
+Cryptantha hispidula,Napa cryptantha,N,21237,2465,57703,203175,,Napa Cryptantha,annual,white,3,5
 Cryptantha intermedia var. intermedia,,N,71933,11568,80627,203183
 Cryptantha juniperensis,rigid cryptantha,N,103476,14557,769572,203205
 Cryptantha micromeres,,N,21263,2476,770232,203194,,Minute-flowered Cryptantha
@@ -720,11 +721,11 @@ Eriophyllum confertiflorum var. confertiflorum,golden-yarrow,N,69866,3423,53397,
 Eriophyllum jepsonii,Jepson's woolly-sunflower,N,2816,3426,77048,203742,true,Jepson's Woolly Sunflower,,,,,776,4.3,,,S3,G3
 Eriophyllum lanatum var. achilleoides,,N,7369,10587,80880,260847,true,Common Woollysunflower
 Eriophyllum staechadifolium,seaside woolly-sunflower,N,2825,3444,60963,203755,true,Seaside Woolly Sunflower
-Erodium botrys,long-beaked filaree,X,25037,3446,57090,17986,,,,pink,3,7
-Erodium brachycarpum,,X,25038,3447,58171,17987
-Erodium cicutarium,red-stemmed filaree,X,25041,3448,47687,17989
+Erodium botrys,long-beaked filaree,X,25037,3446,57090,17986,,,annual,pink,3,7
+Erodium brachycarpum,,X,25038,3447,58171,17987,,,annual,pink,3,7
+Erodium cicutarium,red-stemmed filaree,X,25041,3448,47687,17989,,,annual,pink,3,9
 Erodium malacoides,,X,76818,3451,77056,17994
-Erodium moschatum,white-stem filaree,X,25048,3452,57092,17995
+Erodium moschatum,white-stem filaree,X,25048,3452,57092,17995,,,"annual,biennial",pink,2,9
 Eryngium aristulatum var. aristulatum,coyote-thistle,N,58845,3458,64189,211707,,California Eryngo
 Eryngium aristulatum var. hooveri,,N,58846,3459,57904,203761,,Hoover's Button-celery,,,,,783,1B.1,,,S1,G5T1
 Eryngium aristulatum,Jepson's button celery,N,25070,3457,57901,203759,,Jepson's Button Celery
@@ -1599,7 +1600,7 @@ Salix exigua var. hindsiana,Hind's willow,N,81242,11063,64195,51553,true,Sandbar
 Salix gooddingii,Goodding's black willow,N,42825,7272,60240,31274,true,Goodding's Black Willow
 Salix laevigata,red willow,N,42850,7276,58319,31302,true,Red Willow
 Salix lasiandra var. lasiandra,Pacific willow,N,76043,11065,81358,51640,true,Yellow Willow
-Salix lasiolepis,arroyo willow,N,42855,7277,53452,31307,true,Arroyo Willow
+Salix lasiolepis,arroyo willow,N,42855,7277,53452,31307,true,Arroyo Willow,perennial,,1,6
 Salix melanopsis,dusky willow,N,42881,7284,78947,31332,true,Dusky Willow
 Salix scouleriana,Scouler's willow,N,42973,7289,71076,31425,true,Scouler's Willow
 Salix sitchensis,Sitka willow,N,42994,7291,61100,31435,true,Sitka Willow
@@ -1676,7 +1677,7 @@ Silene lemmonii,Lemmon's catchfly,N,44533,7603,60523,119295,true,Lemmon's Catchf
 Silene sargentii,Sargent's catchfly,N,44566,7614,62697,119340,true,Sargent's Catchfly,perennial,white,7,8
 Silene verecunda,,N,44589,7617,60581,119364,true,San Francisco Campion
 Silybum marianum,milk-thistle,X,4918,7622,52586,205950,true
-Sinapis arvensis,charlock,X,44609,7625,1562069,32232,true
+Sinapis arvensis,charlock,X,44609,7625,1562069,32232,true,,annual,yellow,3,10
 Sisymbrium irio,London rocket,X,44651,7628,58085,32256,true
 Sisymbrium officinale,hedge mustard,X,44653,7630,53266,32267,true
 Sisymbrium orientale,,X,44654,7631,58086,32268,true

package/data/text/Erodium-botrys.footer.md

@@ -0,0 +1,3 @@
+## Resources
+
+- [How to identify Erodium botrys](https://www.inaturalist.org/projects/erodium-botrys-mediterranean-stork-s-bill/journal/61038-how-to-identify-erodium-botrys-mediterranean-stork-s-bill) iNaturalist journal post

package/data/text/Erodium-botrys.md

@@ -0,0 +1 @@
+Petals with purple streaks.

package/data/text/Erodium-brachycarpum.footer.md

@@ -0,0 +1,3 @@
+## Resources
+
+- [How to identify Erodium brachycarpum](https://www.inaturalist.org/projects/erodium-brachycarpum-hairy-pitted-stork-s-bill/journal/61042-how-to-identify-erodium-brachycarpum-hairy-pitted-stork-s-bill) iNaturalist journal post

package/data/text/Erodium-brachycarpum.md

@@ -0,0 +1 @@
+Petals with purple streaks.

package/data/text/Erodium-cicutarium.md

@@ -0,0 +1 @@
+Petals not streaked. Leaf compound, fern-like. Bristles on sepals.

package/data/text/Erodium-moschatum.footer.md

@@ -0,0 +1,3 @@
+## Resources
+
+- [How to identify Erodium moschatum](https://www.inaturalist.org/projects/erodium-moschatum-musk-stork-s-bill/journal/61039-how-to-identify-erodium-moschatum-musk-stork-s-bill) iNaturalist journal post

package/data/text/Erodium-moschatum.md

@@ -0,0 +1 @@
+Petals not streaked, except near base. Leaves compound but not fern-like. No bristles on sepals.

package/generators/eleventy/layouts/h1.njk

@@ -0,0 +1,6 @@
+---
+layout: html.njk
+---
+
+<h1>{{title}}</h1>
+{{content|safe}}

package/generators/eleventy/layouts/html.njk

@@ -0,0 +1,55 @@
+<!DOCTYPE html>
+<html lang="en">
+
+    <head>
+        <meta charset="utf-8">
+        <meta name="viewport" content="width=device-width, initial-scale=1">
+        <link href="https://cdn.jsdelivr.net/npm/bootstrap/dist/css/bootstrap.min.css" rel="stylesheet" crossorigin="anonymous">
+        <title>{{title}}</title>
+        <link href="/assets/css/main.css" rel="stylesheet">
+    </head>
+
+    <body>
+
+        <nav class="navbar navbar-expand-md">
+            <div class="container-xxl px-5">
+                <button id="hamburger" class="navbar-toggler" type="button" data-bs-toggle="collapse"
+                data-bs-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false"
+                aria-label="Toggle navigation">
+                    <span class="navbar-toggler-icon"></span>
+                </button>
+                <a class="navbar-brand" href="/index.html">{{siteName}}</a>
+                <div class="collapse navbar-collapse" id="navbarSupportedContent">
+                    <ul class="navbar-nav me-auto mb-lg-0">
+                        <li class="nav-item">
+                            <a class="nav-link" href="/index_lists.html">Plant Lists</a>
+                        </li>
+                        <li class="nav-item">
+                            <a class="nav-link" href="/rare_plants.html">Rare Plants</a>
+                        </li>
+                        <li class="nav-item">
+                            <a class="nav-link" href="/name_search.html">Name Search</a>
+                        </li>
+                        <li class="nav-item">
+                            <a class="nav-link" href="/glossary.html">Glossary</a>
+                        </li>
+                        {%include "menu_extra.html" %}
+                    </ul>
+                </div>
+            </div>
+        </nav>
+
+        <div class="container-xxl px-5">
+            {{content|safe}}
+        </div>
+
+        <script src="https://cdn.jsdelivr.net/npm/bootstrap/dist/js/bootstrap.bundle.min.js" crossorigin="anonymous"></script>
+
+        {%if js%}<script src="/assets/js/{{js}}" type="module"></script>{%endif%}
+
+        <script src="/assets/js/ui.js" type="module"></script>
+
+        {%include "analytics.html"%}
+        </body>
+
+    </html>

package/lib/basepagerenderer.js

@@ -1,33 +1,49 @@
-import { Config } from "./config.js";
+import path from "node:path";
 import { Files } from "./files.js";
-import { Jekyll } from "./jekyll.js";
 import { GlossaryPages } from "./web/glossarypages.js";
 import { PageFamilyList } from "./web/pageFamily.js";
+import { Jekyll } from "./jekyll.js";
+import { EleventyGenerator } from "./utils/eleventyGenerator.js";
 
-class BasePageRenderer {
+export class BasePageRenderer {
     /**
+     * @param {import("./types.js").Config} config
      * @param {string} outputDir
+     * @param {import("./index.js").SiteGeneratorOptions} options
+     * @param {"11ty"|"jekyll"} [type="11ty"]
+     * @returns {import("./types.js").SiteGenerator}
+     */
+    static newSiteGenerator(config, outputDir, options = {}, type = "11ty") {
+        switch (type) {
+            case "jekyll":
+                return new Jekyll(config, outputDir);
+        }
+        return new EleventyGenerator(config, outputDir, options);
+    }
+
+    /**
+     * @param {import("./types.js").SiteGenerator} siteGenerator
      * @param {import("./types.js").Taxa} taxa
      * @param {import("./types.js").TaxaColDef[]} [familyCols]
      */
-    static renderBasePages(outputDir, taxa, familyCols) {
-        const siteGenerator = new Jekyll(outputDir);
+    static renderBasePages(siteGenerator, taxa, familyCols) {
+        const outputDir = siteGenerator.getBaseDir();
+
+        // Copy static files
+        siteGenerator.copyStaticFiles();
 
         // Copy static files
-        // First copy default Jekyll files from package.
-        Files.copyDir(Config.getPackageDir() + "/jekyll", outputDir);
-        // Then copy Jekyll files from current dir (which may override default files).
-        Files.copyDir("jekyll", outputDir);
+        siteGenerator.copyGeneratorFiles();
 
         // Copy illustrations.
         siteGenerator.copyIllustrations(taxa.getFlowerColors());
 
         const fl = new PageFamilyList(
-            outputDir,
+            siteGenerator,
             taxa.getFamilies().getFamilies(),
         );
         fl.render(familyCols);
-        fl.renderPages(outputDir, familyCols);
+        fl.renderPages(siteGenerator, familyCols);
 
         new GlossaryPages(siteGenerator).renderPages();
 
@@ -41,24 +57,26 @@ class BasePageRenderer {
     static renderTools(outputDir, taxa) {
         const names = [];
         for (const taxon of taxa.getTaxonList()) {
-            const row = [];
-            row.push(taxon.getName());
+            /** @type {(import("./types.js").NameSearchData)} */
+            const row = { t: taxon.getName() };
             const cn = taxon.getCommonNames().join(", ");
             if (cn) {
-                row.push(cn);
+                row.c = cn;
             }
             const synonyms = [];
             for (const syn of taxon.getSynonyms()) {
                 synonyms.push(syn);
             }
             if (synonyms.length > 0) {
-                row[2] = synonyms;
+                row.s = synonyms;
             }
             names.push(row);
         }
 
-        Files.write(outputDir + "/_includes/names.json", JSON.stringify(names));
+        Files.write(
+            path.join(outputDir, "./assets/js/nameSearchData.js"),
+            `export const NAMES = ${JSON.stringify(names)};`,
+            true,
+        );
     }
 }
-
-export { BasePageRenderer };

package/lib/config.js

@@ -8,7 +8,7 @@ const COUNTY_NAMES = {
     CCA: "Contra Costa",
 };
 
-class Config {
+export class Config {
     static #packageDir = path.dirname(
         path.dirname(url.fileURLToPath(import.meta.url)),
     );
@@ -88,6 +88,8 @@ class Config {
     static getPackageDir() {
         return this.#packageDir;
     }
-}
 
-export { Config };
+    getSiteName() {
+        return this.#config.siteName ?? "California Plants";
+    }
+}

package/lib/ebook/ebookpage.js

@@ -1,12 +1,11 @@
 import * as fs from "node:fs";
 
-class EBookPage {
+export class EBookPage {
     #fileName;
     #title;
     #rootPrefix;
 
     /**
-     *
      * @param {string} fileName
      * @param {string} title
      * @param {string} rootPrefix
@@ -56,5 +55,3 @@ class EBookPage {
         return html;
     }
 }
-
-export { EBookPage };

package/lib/ebook/ebooksitegenerator.js

@@ -1,14 +1,8 @@
+import path from "node:path";
 import { Files } from "../files.js";
 import { SiteGenerator } from "../sitegenerator.js";
 
-class EBookSiteGenerator extends SiteGenerator {
-    /**
-     * @param {string} baseDir
-     */
-    constructor(baseDir) {
-        super(baseDir);
-    }
-
+export class EBookSiteGenerator extends SiteGenerator {
     #pageEnd() {
         return "</body></html>";
     }
@@ -47,10 +41,8 @@ class EBookSiteGenerator extends SiteGenerator {
     writeTemplate(content, attributes, filename) {
         const depth = (filename.match(/\//g) || []).length;
         Files.write(
-            Files.join(this.getBaseDir(), filename),
-            this.#wrap(depth, content, attributes)
+            path.join(this.getBaseDir(), filename),
+            this.#wrap(depth, content, attributes),
         );
     }
 }
-
-export { EBookSiteGenerator };

package/lib/ebook/glossarypages.js

@@ -1,7 +1,7 @@
 import { GlossaryPages as BaseGlossaryPages } from "../web/glossarypages.js";
 import { EBook } from "./ebook.js";
 
-class GlossaryPages extends BaseGlossaryPages {
+export class GlossaryPages extends BaseGlossaryPages {
     /**
      * @param {import("../sitegenerator.js").SiteGenerator} siteGenerator
      */
@@ -39,5 +39,3 @@ class GlossaryPages extends BaseGlossaryPages {
         return spineEntries.join("");
     }
 }
-
-export { GlossaryPages };

package/lib/ebook/plantbook.js

@@ -29,7 +29,7 @@ class PlantBook extends EBook {
         );
 
         this.#taxa = taxa;
-        const generator = new EBookSiteGenerator(this.getContentDir());
+        const generator = new EBookSiteGenerator(config, this.getContentDir());
         this.#glossary = new GlossaryPages(generator);
         this.#images = new Images(generator, this.getContentDir(), taxa);
     }

package/lib/files.js

@@ -83,6 +83,7 @@ class Files {
     /**
      * @param {string[]} paths
      * @returns {string}
+     * @deprecated
      */
     static join(...paths) {
         return path.join(...paths).replaceAll("\\", "/");

package/lib/htmltaxon.js

@@ -1,10 +1,11 @@
+import path from "node:path";
 import { Config } from "./config.js";
 import { DateUtils } from "./dateutils.js";
 import { ExternalSites } from "./externalsites.js";
 import { HTML } from "./html.js";
-import { Markdown } from "./markdown.js";
 import { RarePlants } from "./rareplants.js";
 import { TextUtils } from "./textutils.js";
+import { HTMLFragments } from "./utils/htmlFragments.js";
 
 /**
  * @type {Record<string,import("./types.js").TaxaColDef>}
@@ -204,12 +205,12 @@ class HTMLTaxon {
      * @returns {string}
      */
     static getFooterHTML(taxon) {
-        const footerTextPath =
-            Config.getPackageDir() +
-            "/data/text/" +
-            taxon.getBaseFileName() +
-            ".footer.md";
-        return HTMLTaxon.getMarkdownSection(footerTextPath);
+        const footerTextPath = path.join(
+            Config.getPackageDir(),
+            "/data/text/",
+            `${taxon.getBaseFileName()}.footer.md`,
+        );
+        return HTMLFragments.getMarkdownSection(footerTextPath);
     }
 
     /**
@@ -271,18 +272,6 @@ class HTMLTaxon {
         return html;
     }
 
-    /**
-     * @param {string} filePath
-     * @returns {string}
-     */
-    static getMarkdownSection(filePath) {
-        const footerMarkdown = Markdown.fileToHTML(filePath);
-        if (footerMarkdown) {
-            return HTML.wrap("div", footerMarkdown, "section");
-        }
-        return "";
-    }
-
     /**
      * @param {import("./types.js").Taxon} taxon
      */

package/lib/index.d.ts

@@ -15,6 +15,10 @@ type RefSourceCode =
     | "jepson"
     | "rpi";
 
+type SiteGeneratorOptions = {
+    passThroughPatterns?: string[];
+};
+
 type TaxaColDef<T> = {
     title: string;
     class?: string;
@@ -46,11 +50,20 @@ export type TaxonData = TaxonomyData & {
     taxon_name: string;
 };
 
+export type TaxonOverrides = {
+    status?: NativeStatusCode;
+};
+
 // Classes
 
 export class BasePageRenderer {
-    static renderBasePages<T extends Taxon>(
+    static newSiteGenerator(
+        config: Config,
         outputDir: string,
+        options?: SiteGeneratorOptions,
+    ): SiteGenerator;
+    static renderBasePages<T extends Taxon>(
+        siteGenerator: SiteGenerator,
         taxa: Taxa<T>,
         familyCols?: TaxaColDef<T>[],
     ): void;
@@ -73,6 +86,11 @@ export class CSV {
         fileName: string,
         delimeter?: string,
     ): Record<string, string>[];
+    static writeFileObject(
+        fileName: string,
+        data: Record<string, any>[],
+        headerData: string[],
+    ): void;
 }
 
 export class ErrorLog {
@@ -104,6 +122,7 @@ export class Files {
         targetFileName: string | undefined,
     ): Promise<Headers>;
     static mkdir(dir: string): void;
+    static read(path: string): string;
     static rmDir(dir: string): void;
     static write(fileName: string, data: string, overwrite?: boolean): void;
 }
@@ -140,6 +159,10 @@ export class HTML {
     ): string;
 }
 
+export class HTMLFragments {
+    static getMarkdownSection(filePath: string): string;
+}
+
 export class HTMLTaxon {
     static addLink(
         links: string[],
@@ -164,12 +187,6 @@ export class HTMLTaxon {
         header: string,
         className?: string,
     ): string;
-    static getMarkdownSection(filePath: string): string;
-}
-
-export class Jekyll {
-    static hasInclude(baseDir: string, path: string): boolean;
-    static include(fileName: string): string;
 }
 
 export class Photo {
@@ -185,13 +202,19 @@ export class Program {
     static getProgram(): Command;
 }
 
+export class SiteGenerator {
+    generate(outputDir: string): Promise<void>;
+    getBaseDir(): string;
+    getFrontMatter(atts: Record<string, string | undefined>): string;
+}
+
 export class Taxa<T> {
     constructor(
-        inclusionList: Record<string, TaxonData> | true,
+        inclusionList: Record<string, TaxonOverrides> | true,
         errorLog: ErrorLog,
         showFlowerErrors: boolean,
         taxonFactory?: (td: TaxonData, g: Genera) => T,
-        extraTaxa?: TaxonData[],
+        extraTaxa?: TaxonOverrides[],
         extraSynonyms?: Record<string, string>[],
     );
     getTaxon(name: string): T;

package/lib/index.js

@@ -7,10 +7,11 @@ import { ExternalSites } from "./externalsites.js";
 import { Families } from "./taxonomy/families.js";
 import { Files } from "./files.js";
 import { HTML } from "./html.js";
+import { HTMLFragments } from "./utils/htmlFragments.js";
 import { HTMLTaxon } from "./htmltaxon.js";
-import { Jekyll } from "./jekyll.js";
 import { PlantBook } from "./ebook/plantbook.js";
 import { Program } from "./program.js";
+import { SiteGenerator } from "./sitegenerator.js";
 import { Taxa } from "./taxonomy/taxa.js";
 import { Taxon } from "./taxonomy/taxon.js";
 
@@ -24,10 +25,11 @@ export {
     Families,
     Files,
     HTML,
+    HTMLFragments,
     HTMLTaxon,
-    Jekyll,
     PlantBook,
     Program,
+    SiteGenerator,
     Taxa,
     Taxon,
 };

package/lib/jekyll.js

@@ -1,71 +1,52 @@
+import * as child_process from "node:child_process";
+import * as path from "node:path";
 import { Files } from "./files.js";
 import { SiteGenerator } from "./sitegenerator.js";
-
-const FRONT_DELIM = "---";
-
-class Jekyll extends SiteGenerator {
-    /**
-     * @param {string} baseDir
-     */
-    constructor(baseDir) {
-        super(baseDir);
+import { Config } from "./config.js";
+
+export class Jekyll extends SiteGenerator {
+    copyGeneratorFiles() {
+        // First copy default files from package.
+        Files.copyDir(
+            path.join(Config.getPackageDir(), "./generators/jekyll"),
+            this.getBaseDir(),
+        );
+        // Then copy files from current dir (which may override default files).
+        Files.copyDir("./generators/jekyll", this.getBaseDir());
     }
 
-    /**
-     * @param {Object<string,string>} atts
-     */
-    static getFrontMatter(atts) {
-        const lines = [FRONT_DELIM];
-        for (const [k, v] of Object.entries(atts)) {
-            lines.push(k + ': "' + v + '"');
+    async generate() {
+        /**
+         * @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);
+            }
         }
-        if (!atts.layout) {
-            lines.push("layout: default");
-        }
-        lines.push(FRONT_DELIM);
-        return lines.join("\n") + "\n";
-    }
 
-    /**
-     * @param {string} baseDir
-     * @param {string} path
-     */
-    static hasInclude(baseDir, path) {
-        return Files.exists(baseDir + "/_includes/" + path);
-    }
+        const srcDir = "./output";
+        const destDir = "./public";
 
-    /**
-     * @param {string} path
-     */
-    static include(path) {
-        // This works for .md includes; should have conditional logic to detect other types.
-        return (
-            "{% capture my_include %}{% include " +
-            path +
-            " %}{% endcapture %}{{ my_include | markdownify }}"
-        );
-    }
+        // Remove existing files.
+        Files.rmDir(destDir);
 
-    /**
-     * @param {string} baseDir
-     * @param {string} path
-     * @param {string} data
-     */
-    static writeInclude(baseDir, path, data) {
-        Files.write(baseDir + "/_includes/" + path, data);
-    }
+        const options = ["--source", srcDir, "--destination", destDir];
 
-    /**
-     * @param {string} content
-     * @param {Object<string,string>} attributes
-     * @param {string} filename
-     */
-    writeTemplate(content, attributes, filename) {
-        Files.write(
-            Files.join(this.getBaseDir(), filename),
-            Jekyll.getFrontMatter(attributes) + content
+        // Find out what config files are available.
+        /** @type {string[]} */
+        const configFiles = [];
+        addConfigFile(configFiles, srcDir, "_config.yml");
+        addConfigFile(configFiles, 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());
     }
 }
-
-export { Jekyll };

package/lib/markdown.js

@@ -1,16 +1,16 @@
 import markdownIt from "markdown-it";
 import { Files } from "./files.js";
 
-class Markdown {
+export class Markdown {
     static #md = new markdownIt({ xhtmlOut: true });
 
     /**
      * @param {string} filePath
-     * @returns {string|undefined}
+     * @returns {string}
      */
     static fileToHTML(filePath) {
         if (!Files.exists(filePath)) {
-            return;
+            return "";
         }
         return this.strToHTML(Files.read(filePath));
     }
@@ -22,5 +22,3 @@ class Markdown {
         return this.#md.render(str);
     }
 }
-
-export { Markdown };