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

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);
+    }
+}

package/lib/{pagerenderer.js → web/renderAllPages.js}

@@ -1,10 +1,11 @@
-import { PageTaxon } from "./web/pagetaxon.js";
-import { RarePlants } from "./rareplants.js";
-import { BasePageRenderer } from "./basepagerenderer.js";
-import { GenericPage } from "./genericpage.js";
-import { Files } from "./files.js";
-import { HTML } from "./html.js";
-import { HTMLTaxon, TAXA_LIST_COLS } from "./htmltaxon.js";
+import { RarePlants } from "../rareplants.js";
+import { BasePageRenderer } from "../basepagerenderer.js";
+import { Files } from "../files.js";
+import { HTML } from "../html.js";
+import { TAXA_LIST_COLS } from "../htmltaxon.js";
+import { PageTaxonList } from "./pageTaxonList.js";
+import { HTMLFragments } from "../utils/htmlFragments.js";
+import { PageTaxon } from "./pageTaxon.js";
 
 const ENDANGERED_COLS = [
     TAXA_LIST_COLS.SPECIES,
@@ -18,33 +19,33 @@ const RPI_COLUMNS = [
     TAXA_LIST_COLS.CNPS_RANK,
 ];
 
-class PageRenderer extends BasePageRenderer {
+export class PageRenderer extends BasePageRenderer {
     /**
-     * @param {string} outputDir
-     * @param {import('./config.js').Config} config
-     * @param {import("./types.js").Taxa} taxa
+     * @param {import("../types.js").SiteGenerator} siteGenerator
+     * @param {import('../config.js').Config} config
+     * @param {import("../types.js").Taxa} taxa
      */
-    static render(outputDir, config, taxa) {
-        super.renderBasePages(outputDir, taxa);
+    static renderAll(siteGenerator, config, taxa) {
+        super.renderBasePages(siteGenerator, taxa);
 
-        this.renderLists(outputDir, config, taxa);
+        this.renderLists(siteGenerator, config, taxa);
 
         const taxonList = taxa.getTaxonList();
         for (const taxon of taxonList) {
-            new PageTaxon(outputDir, config, taxon).render();
+            new PageTaxon(siteGenerator, config, taxon).render();
         }
     }
 
     /**
-     * @param {string} outputDir
-     * @param {import('./config.js').Config} config
-     * @param {import("./types.js").Taxa} taxa
+     * @param {import("../types.js").SiteGenerator} siteGenerator
+     * @param {import('../config.js').Config} config
+     * @param {import("../types.js").Taxa} taxa
      */
-    static renderLists(outputDir, config, taxa) {
+    static renderLists(siteGenerator, config, taxa) {
         /**
          * @param {ListInfo[]} listInfo
          * @param {Object<string,string>} attributes
-         * @param {import("./types.js").TaxaColDef[]} [columns]
+         * @param {import("../types.js").TaxaColDef[]} [columns]
          * @returns {string}
          */
         function getListArray(listInfo, attributes = {}, columns) {
@@ -75,10 +76,11 @@ class PageRenderer extends BasePageRenderer {
                 );
 
                 const cols = columns ? columns : list.columns;
-                new PageTaxonList(outputDir, list.name, list.filename).render(
-                    listTaxa,
-                    cols,
-                );
+                new PageTaxonList(
+                    siteGenerator,
+                    list.name,
+                    list.filename,
+                ).render(listTaxa, cols);
 
                 // Check for sublists.
                 const subListHTML = list.listInfo
@@ -117,7 +119,9 @@ class PageRenderer extends BasePageRenderer {
             return html;
         }
 
-        /** @typedef {{name:string,filename:string,include:function(import("./types.js").Taxon):boolean,columns?:import("./types.js").TaxaColDef[],listInfo?:ListInfo[]}} ListInfo */
+        const outputDir = siteGenerator.getBaseDir();
+
+        /** @typedef {{name:string,filename:string,include:function(import("../types.js").Taxon):boolean,columns?:import("../types.js").TaxaColDef[],listInfo?:ListInfo[]}} ListInfo */
         /** @type {{title:string,listInfo:ListInfo[]}[]} */
         const sections = [
             {
@@ -191,7 +195,10 @@ class PageRenderer extends BasePageRenderer {
             },
         ];
 
-        let html = '<div class="wrapper">';
+        let html =
+            HTMLFragments.getMarkdownSection("./data/intros/index_lists.md") +
+            '<div class="wrapper">';
+
         for (const section of sections) {
             const listHTML = getListArray(section.listInfo);
 
@@ -208,59 +215,10 @@ class PageRenderer extends BasePageRenderer {
 
         html += "</div>";
 
-        // Write lists to includes directory so it can be inserted into pages.
-        Files.write(outputDir + "/_includes/plantlists.html", html);
-    }
-}
-
-class PageTaxonList extends GenericPage {
-    /**
-     * @param {string} outputDir
-     * @param {string} title
-     * @param {string} baseName
-     */
-    constructor(outputDir, title, baseName) {
-        super(outputDir, 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);
+        siteGenerator.writeTemplate(
+            html,
+            { title: "Plant lists" },
+            "index_lists.html",
+        );
     }
 }
-
-export { PageRenderer };

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@ca-plant-list/ca-plant-list",
-    "version": "0.4.26",
-    "description": "Tools to create Jekyll files for a website listing plants in an area of California.",
+    "version": "0.4.27",
+    "description": "Tools to create files for a website listing plants in an area of California.",
     "license": "MIT",
     "repository": {
         "type": "git",
@@ -12,9 +12,10 @@
     "files": [
         "data",
         "ebook",
-        "jekyll",
+        "generators",
         "lib",
-        "scripts"
+        "scripts",
+        "static"
     ],
     "exports": {
         ".": "./lib/index.js"
@@ -22,10 +23,10 @@
     "types": "./lib/index.d.ts",
     "scripts": {
         "check": "npm run eslint && npm run tsc && npm run jest",
-        "eslint": "npx eslint",
+        "eslint": "eslint",
         "jest": "node --experimental-vm-modules node_modules/jest/bin/jest.js tests",
-        "prettier": "npx prettier -l .",
-        "tsc": "npx tsc"
+        "prettier": "prettier -l .",
+        "tsc": "tsc"
     },
     "bin": {
         "ca-plant-list": "scripts/build-site.js",
@@ -35,10 +36,11 @@
         "inatobsphotos": "scripts/inatobsphotos.js"
     },
     "dependencies": {
+        "@11ty/eleventy": "^3.0.0",
         "@htmltools/scrape": "^0.1.1",
         "archiver": "^5.3.1",
         "cli-progress": "^3.12.0",
-        "commander": "^12.1.0",
+        "commander": "^13.1.0",
         "csv-parse": "^5.6.0",
         "csv-stringify": "^6.5.2",
         "exceljs": "^4.4.0",
@@ -55,9 +57,9 @@
         "@types/markdown-it": "^14.1.2",
         "@types/node": "^22.10.7",
         "@types/unzipper": "^0.10.9",
-        "eslint": "^9.18.0",
+        "eslint": "^9.20.1",
         "jest": "^29.7.0",
-        "prettier": "^3.4.2",
+        "prettier": "^3.5.1",
         "puppeteer": "^24.1.1",
         "typescript": "^5.7.3"
     }