@ca-plant-list/ca-plant-list 0.4.3 → 0.4.4

package/lib/web/pagetaxon.js

@@ -4,205 +4,208 @@ import { GenericPage } from "../genericpage.js";
 import { ExternalSites } from "../externalsites.js";
 import { HTML } from "../html.js";
 import { HTMLTaxon } from "../htmltaxon.js";
+import { Markdown } from "../markdown.js";
+import { Config } from "../config.js";
 
 class PageTaxon extends GenericPage {
-    #config;
-    #taxon;
-
-    /**
-     * @param {string} outputDir
-     * @param {Config} config
-     * @param {Taxon} taxon
-     */
-    constructor(outputDir, config, taxon) {
-        super(outputDir, taxon.getName(), taxon.getBaseFileName());
-        this.#config = config;
-        this.#taxon = taxon;
+  #config;
+  #taxon;
+
+  /**
+   * @param {string} outputDir
+   * @param {Config} config
+   * @param {Taxon} taxon
+   */
+  constructor(outputDir, config, taxon) {
+    super(outputDir, taxon.getName(), taxon.getBaseFileName());
+    this.#config = config;
+    this.#taxon = taxon;
+  }
+
+  #getInfoLinks() {
+    const links = [];
+    const jepsonID = this.#taxon.getJepsonID();
+    if (jepsonID) {
+      links.push(Jepson.getEFloraLink(jepsonID));
     }
-
-    #getInfoLinks() {
-        const links = [];
-        const jepsonID = this.#taxon.getJepsonID();
-        if (jepsonID) {
-            links.push(Jepson.getEFloraLink(jepsonID));
-        }
-        const cfLink = this.#taxon.getCalfloraTaxonLink();
-        if (cfLink) {
-            links.push(cfLink);
-        }
-        const iNatLink = this.#taxon.getINatTaxonLink();
-        if (iNatLink) {
-            links.push(iNatLink);
-        }
-        const rpiLink = this.#taxon.getRPITaxonLink();
-        if (rpiLink) {
-            links.push(rpiLink);
-        }
-        return links;
+    const cfLink = this.#taxon.getCalfloraTaxonLink();
+    if (cfLink) {
+      links.push(cfLink);
     }
-
-    #getObsLinks() {
-        const links = [];
-        links.push(
-            HTML.getLink(
-                "https://www.calflora.org/entry/observ.html?track=m#srch=t&grezc=5&cols=b&lpcli=t&cc=" +
-                    this.#config.getCountyCodes().join("!") +
-                    "&incobs=f&taxon=" +
-                    this.#taxon.getCalfloraName().replaceAll(" ", "+"),
-                "Calflora",
-                {},
-                true
-            )
-        );
-        const iNatID = this.#taxon.getINatID();
-        if (iNatID) {
-            links.push(
-                HTML.getLink(
-                    ExternalSites.getInatObsLink({
-                        project_id: this.#config.getConfigValue(
-                            "inat",
-                            "project_id"
-                        ),
-                        subview: "map",
-                        taxon_id: iNatID,
-                    }),
-                    "iNaturalist",
-                    {},
-                    true
-                )
-            );
-        }
-
-        return links;
+    const iNatLink = this.#taxon.getINatTaxonLink();
+    if (iNatLink) {
+      links.push(iNatLink);
     }
-
-    /**
-     * @param {string[]} list
-     * @param {string} header
-     * @param {string} className
-     */
-    #getListSectionHTML(list, header, className) {
-        let html = "";
-        if (list.length > 0) {
-            html += '<div class="section ' + className + '">';
-            html += HTML.textElement("h2", header);
-            html += "<ul>";
-            html += HTML.arrayToLI(list);
-            html += "</ul>";
-            html += "</div>";
-        }
-        return html;
+    const rpiLink = this.#taxon.getRPITaxonLink();
+    if (rpiLink) {
+      links.push(rpiLink);
+    }
+    return links;
+  }
+
+  #getObsLinks() {
+    const links = [];
+    links.push(
+      HTML.getLink(
+        "https://www.calflora.org/entry/observ.html?track=m#srch=t&grezc=5&cols=b&lpcli=t&cc=" +
+          this.#config.getCountyCodes().join("!") +
+          "&incobs=f&taxon=" +
+          this.#taxon.getCalfloraName().replaceAll(" ", "+"),
+        "Calflora",
+        {},
+        true
+      )
+    );
+    const iNatID = this.#taxon.getINatID();
+    if (iNatID) {
+      const projectId = links.push(
+        HTML.getLink(
+          ExternalSites.getInatObsLink({
+            project_id: this.#config.getConfigValue("inat", "project_id"),
+            subview: "map",
+            taxon_id: iNatID,
+          }),
+          "iNaturalist",
+          {},
+          true
+        )
+      );
     }
 
-    #getRarityInfo() {
-        const cnpsRank = this.#taxon.getRPIRankAndThreat();
-        if (!cnpsRank) {
-            return "";
-        }
-        const ranks = [];
-
-        ranks.push(
-            HTML.textElement("span", "CNPS Rare Plant Rank:", {
-                class: "label",
-            }) +
-                HTML.getToolTip(
-                    cnpsRank,
-                    this.#taxon.getRPIRankAndThreatTooltip()
-                )
-        );
-        if (this.#taxon.getCESA()) {
-            ranks.push(
-                HTML.textElement("span", "CESA:", { class: "label" }) +
-                    RarePlants.getCESADescription(this.#taxon.getCESA())
-            );
-        }
+    return links;
+  }
+
+  /**
+   * @param {string[]} list
+   * @param {string} header
+   * @param {string} className
+   */
+  #getListSectionHTML(list, header, className) {
+    let html = "";
+    if (list.length > 0) {
+      html += '<div class="section nobullet ' + className + '">';
+      html += HTML.textElement("h2", header);
+      html += "<ul>";
+      html += HTML.arrayToLI(list);
+      html += "</ul>";
+      html += "</div>";
+    }
+    return html;
+  }
 
-        return HTML.wrap("div", "<ul>" + HTML.arrayToLI(ranks) + "</ul>", {
-            class: "section",
-        });
+  #getRarityInfo() {
+    const cnpsRank = this.#taxon.getRPIRankAndThreat();
+    if (!cnpsRank) {
+      return "";
+    }
+    const ranks = [];
+
+    ranks.push(
+      HTML.textElement("span", "CNPS Rare Plant Rank:", {
+        class: "label",
+      }) + HTML.getToolTip(cnpsRank, this.#taxon.getRPIRankAndThreatTooltip())
+    );
+    if (this.#taxon.getCESA()) {
+      ranks.push(
+        HTML.textElement("span", "CESA:", { class: "label" }) +
+          RarePlants.getCESADescription(this.#taxon.getCESA())
+      );
     }
 
-    #getRelatedTaxaLinks() {
-        const links = [];
-        const genus = this.#taxon.getGenus();
-        if (genus) {
-            const taxa = genus.getTaxa();
-            if (taxa.length > 1) {
-                for (const taxon of taxa) {
-                    links.push(
-                        taxon.getHTMLLink(
-                            taxon.getName() !== this.#taxon.getName()
-                        )
-                    );
-                }
-            }
+    return HTML.wrap("div", "<ul>" + HTML.arrayToLI(ranks) + "</ul>", {
+      class: "section",
+    });
+  }
+
+  #getRelatedTaxaLinks() {
+    const links = [];
+    const genus = this.#taxon.getGenus();
+    if (genus) {
+      const taxa = genus.getTaxa();
+      if (taxa.length > 1) {
+        for (const taxon of taxa) {
+          links.push(
+            taxon.getHTMLLink(taxon.getName() !== this.#taxon.getName())
+          );
         }
-        return links;
+      }
     }
+    return links;
+  }
 
-    #getSynonyms() {
-        return this.#taxon.getSynonyms();
-    }
+  #getSynonyms() {
+    return this.#taxon.getSynonyms();
+  }
 
-    render() {
-        let html = this.getFrontMatter();
+  render() {
+    let html = this.getFrontMatter();
 
-        html += '<div class="wrapper">';
+    html += '<div class="wrapper">';
 
-        const cn = this.#taxon.getCommonNames();
-        if (cn.length > 0) {
-            html += HTML.textElement("div", cn.join(", "), {
-                class: "section common-names",
-            });
-        }
+    const cn = this.#taxon.getCommonNames();
+    if (cn.length > 0) {
+      html += HTML.textElement("div", cn.join(", "), {
+        class: "section common-names",
+      });
+    }
 
-        html += HTML.textElement(
-            "div",
-            this.#taxon.getStatusDescription(this.#config),
-            { class: "section native-status" }
-        );
-
-        const family = this.#taxon.getFamily();
-        html += HTML.wrap(
-            "div",
-            HTML.textElement("span", "Family:", { class: "label" }) +
-                HTML.getLink("./" + family.getFileName(), family.getName()),
-            { class: "section" }
-        );
-
-        html += this.#getRarityInfo();
-
-        html += "</div>";
-
-        html += HTMLTaxon.getFlowerInfo(this.#taxon, undefined, false);
-
-        html += this.getMarkdown();
-
-        html += '<div class="grid borders">';
-        html += this.#getListSectionHTML(
-            this.#getInfoLinks(),
-            "References",
-            "info"
-        );
-        html += this.#getListSectionHTML(
-            this.#getObsLinks(),
-            "Observations",
-            "obs"
-        );
-        html += this.#getListSectionHTML(
-            this.#getRelatedTaxaLinks(),
-            "Related Species",
-            "rel-taxa"
-        );
-        html += this.#getListSectionHTML(
-            this.#getSynonyms(),
-            "Synonyms",
-            "synonyms"
-        );
-        html += "</div>";
-
-        this.writeFile(html);
+    html += HTML.textElement(
+      "div",
+      this.#taxon.getStatusDescription(this.#config),
+      { class: "section native-status" }
+    );
+
+    const family = this.#taxon.getFamily();
+    html += HTML.wrap(
+      "div",
+      HTML.textElement("span", "Family:", { class: "label" }) +
+        HTML.getLink("./" + family.getFileName(), family.getName()),
+      { class: "section" }
+    );
+
+    html += this.#getRarityInfo();
+
+    html += "</div>";
+
+    html += HTMLTaxon.getFlowerInfo(this.#taxon, undefined, false);
+
+    html += this.getMarkdown();
+
+    html += '<div class="grid borders">';
+    html += this.#getListSectionHTML(
+      this.#getInfoLinks(),
+      "References",
+      "info"
+    );
+    html += this.#getListSectionHTML(
+      this.#getObsLinks(),
+      "Observations",
+      "obs"
+    );
+    html += this.#getListSectionHTML(
+      this.#getRelatedTaxaLinks(),
+      "Related Species",
+      "rel-taxa"
+    );
+    html += this.#getListSectionHTML(
+      this.#getSynonyms(),
+      "Synonyms",
+      "synonyms"
+    );
+    html += "</div>";
+
+    const footerTextPath =
+      Config.getPackageDir() +
+      "/data/text/" +
+      this.getBaseFileName() +
+      ".footer.md";
+    const footerMarkdown = Markdown.fileToHTML(footerTextPath);
+    if (footerMarkdown) {
+      html += HTML.wrap("div", footerMarkdown, "section");
     }
+
+    this.writeFile(html);
+  }
 }
 
 export { PageTaxon };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ca-plant-list/ca-plant-list",
-    "version": "0.4.3",
+    "version": "0.4.4",
     "description": "Tools to create Jekyll files for a website listing plants in an area of California.",
     "license": "MIT",
     "repository": {
@@ -22,18 +22,18 @@
         "commander": "^12.1.0",
         "csv-parse": "^5.3.1",
         "image-size": "^1.1.1",
-        "markdown-it": "^13.0.1",
+        "markdown-it": "^14.1.0",
         "sharp": "^0.32.1",
-        "svgo-ll": "^5.4.0",
+        "svgo-ll": "^5.5.0",
         "unzipper": "^0.10.11"
     },
     "devDependencies": {
         "@types/archiver": "^6.0.2",
         "@types/markdown-it": "^14.1.2",
-        "@types/node": "^22.5.5",
+        "@types/node": "^22.7.8",
         "@types/unzipper": "^0.10.9",
         "ajv-cli": "^5.0.0",
-        "eslint": "^8.26.0",
-        "typescript": "^5.3.3"
+        "eslint": "^9.13.0",
+        "typescript": "^5.6.3"
     }
 }

package/types/classes.d.ts

@@ -10,20 +10,20 @@ declare class Config {
         name: string,
         subcategory?: string,
         defaultValue?: string
-    ): string;
+    ): string | undefined;
     getCountyCodes(): string[];
     getLabel(name: string, dflt: string): string;
 }
 
 declare class ErrorLog {
     log(...args: string[]): void;
-    write();
+    write(): void;
 }
 
 declare class Families {
     getFamilies(): Family[];
     getFamily(name: string): Family;
-    renderPages(outputDir: string, cols?: TaxaCol[]);
+    renderPages(outputDir: string, cols?: TaxaCol[]): void;
 }
 
 declare class Family {
@@ -41,7 +41,7 @@ declare class FlowerColor {
 }
 
 declare class Genera {
-    addTaxon(Taxon);
+    addTaxon(taxon: Taxon): void;
     getGenus(name: string): Genus;
 }
 
@@ -67,13 +67,13 @@ declare class InatObsOptions {
 }
 
 declare class SiteGenerator {
-    copyIllustrations(flowerColors: FlowerColor[]);
-    mkdir(path: string);
+    copyIllustrations(flowerColors: FlowerColor[]): void;
+    mkdir(path: string): void;
     writeTemplate(
         content: string,
-        attributes: Object<string, string>,
+        attributes: Record<string, string>,
         filename: string
-    );
+    ): void;
 }
 
 declare class SynonymData {
@@ -91,7 +91,7 @@ declare class Taxa {
 
 declare class TaxaCol {
     class?: string;
-    data: Object<string, Taxon>;
+    data: function (Taxon):string;
     title: string;
 }