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

package/lib/ebook/plantbook.js

@@ -10,158 +10,166 @@ import { TaxonPage } from "./pages/taxonpage.js";
 import { TOCPage } from "./pages/tocpage.js";
 
 class PlantBook extends EBook {
-    #taxa;
-    #glossary;
-    #images;
-
-    /**
-     * @param {string} outputDir
-     * @param {Config} config
-     * @param {Taxa} taxa
-     */
-    constructor(outputDir, config, taxa) {
-        super(
-            outputDir,
-            config.getConfigValue("ebook", "filename"),
-            config.getConfigValue("ebook", "pub_id"),
-            config.getConfigValue("ebook", "title")
-        );
-
-        this.#taxa = taxa;
-        const generator = new EBookSiteGenerator(this.getContentDir());
-        this.#glossary = new GlossaryPages(generator);
-        this.#images = new Images(generator, this.getContentDir(), taxa);
+  #taxa;
+  #glossary;
+  #images;
+
+  /**
+   * @param {string} outputDir
+   * @param {Config} config
+   * @param {Taxa} taxa
+   */
+  constructor(outputDir, config, taxa) {
+    super(
+      outputDir,
+      getRequiredConfigValue(config, "filename"),
+      getRequiredConfigValue(config, "pub_id"),
+      getRequiredConfigValue(config, "title")
+    );
+
+    this.#taxa = taxa;
+    const generator = new EBookSiteGenerator(this.getContentDir());
+    this.#glossary = new GlossaryPages(generator);
+    this.#images = new Images(generator, this.getContentDir(), taxa);
+  }
+
+  async createPages() {
+    const contentDir = this.getContentDir();
+
+    await this.#images.createImages();
+
+    console.log("creating taxon pages");
+    const taxonList = this.#taxa.getTaxonList();
+    for (const taxon of taxonList) {
+      const name = taxon.getName();
+      new TaxonPage(
+        contentDir,
+        taxon,
+        this.#images.getTaxonImages(name)
+      ).create();
     }
 
-    async createPages() {
-        const contentDir = this.getContentDir();
-
-        await this.#images.createImages();
-
-        console.log("creating taxon pages");
-        const taxonList = this.#taxa.getTaxonList();
-        for (const taxon of taxonList) {
-            const name = taxon.getName();
-            new TaxonPage(
-                contentDir,
-                taxon,
-                this.#images.getTaxonImages(name)
-            ).create();
-        }
-
-        // Create lists.
-        for (const color of this.#taxa.getFlowerColors()) {
-            new PageListFlowerColor(contentDir, color).create();
-        }
-
-        PageListFlowers.createPages(contentDir, this.#taxa);
-
-        new PageListFamilies(contentDir, this.#taxa.getFamilies()).create();
-        for (const family of this.#taxa.getFamilies().getFamilies()) {
-            const taxa = family.getTaxa();
-            if (!taxa) {
-                continue;
-            }
-            const name = family.getName();
-            new PageListSpecies(
-                contentDir,
-                taxa,
-                name + ".html",
-                name
-            ).create();
-        }
-        new PageListSpecies(
-            contentDir,
-            taxonList,
-            "list_species.html",
-            "All Species"
-        ).create();
-
-        this.#glossary.renderPages();
-
-        new TOCPage(contentDir, this.#taxa).create();
+    // Create lists.
+    for (const color of this.#taxa.getFlowerColors()) {
+      new PageListFlowerColor(contentDir, color).create();
     }
 
-    renderManifestEntries() {
-        let xml = "";
-
-        // Add lists.
-        xml +=
-            '<item id="lspecies" href="list_species.html" media-type="application/xhtml+xml" />';
-        xml +=
-            '<item id="lfamilies" href="list_families.html" media-type="application/xhtml+xml" />';
-        for (const color of this.#taxa.getFlowerColors()) {
-            xml +=
-                '<item id="l' +
-                color.getColorName() +
-                '" href="' +
-                color.getFileName() +
-                '" media-type="application/xhtml+xml" />';
-        }
-
-        // Add family pages.
-        for (const family of this.#taxa.getFamilies().getFamilies()) {
-            const taxa = family.getTaxa();
-            if (!taxa) {
-                continue;
-            }
-            xml +=
-                '<item id="fam' +
-                family.getName() +
-                '" href="' +
-                family.getFileName() +
-                '" media-type="application/xhtml+xml" />';
-        }
-
-        // Add taxon pages.
-        const taxa = this.#taxa.getTaxonList();
-        for (let index = 0; index < taxa.length; index++) {
-            const taxon = taxa[index];
-            xml +=
-                '<item id="t' +
-                index +
-                '" href="' +
-                taxon.getFileName() +
-                '" media-type="application/xhtml+xml" />';
-        }
-
-        xml += PageListFlowers.getManifestEntries();
-        xml += this.#glossary.getManifestEntries();
-        xml += this.#images.getManifestEntries();
-
-        return xml;
+    PageListFlowers.createPages(contentDir, this.#taxa);
+
+    new PageListFamilies(contentDir, this.#taxa.getFamilies()).create();
+    for (const family of this.#taxa.getFamilies().getFamilies()) {
+      const taxa = family.getTaxa();
+      if (!taxa) {
+        continue;
+      }
+      const name = family.getName();
+      new PageListSpecies(contentDir, taxa, name + ".html", name).create();
+    }
+    new PageListSpecies(
+      contentDir,
+      taxonList,
+      "list_species.html",
+      "All Species"
+    ).create();
+
+    this.#glossary.renderPages();
+
+    new TOCPage(contentDir, this.#taxa).create();
+  }
+
+  renderManifestEntries() {
+    let xml = "";
+
+    // Add lists.
+    xml +=
+      '<item id="lspecies" href="list_species.html" media-type="application/xhtml+xml" />';
+    xml +=
+      '<item id="lfamilies" href="list_families.html" media-type="application/xhtml+xml" />';
+    for (const color of this.#taxa.getFlowerColors()) {
+      xml +=
+        '<item id="l' +
+        color.getColorName() +
+        '" href="' +
+        color.getFileName() +
+        '" media-type="application/xhtml+xml" />';
     }
 
-    renderSpineElements() {
-        let xml = "";
+    // Add family pages.
+    for (const family of this.#taxa.getFamilies().getFamilies()) {
+      const taxa = family.getTaxa();
+      if (!taxa) {
+        continue;
+      }
+      xml +=
+        '<item id="fam' +
+        family.getName() +
+        '" href="' +
+        family.getFileName() +
+        '" media-type="application/xhtml+xml" />';
+    }
 
-        // Add lists.
-        for (const color of this.#taxa.getFlowerColors()) {
-            xml += '<itemref idref="l' + color.getColorName() + '"/>';
-        }
-        xml += PageListFlowers.getSpineEntries();
+    // Add taxon pages.
+    const taxa = this.#taxa.getTaxonList();
+    for (let index = 0; index < taxa.length; index++) {
+      const taxon = taxa[index];
+      xml +=
+        '<item id="t' +
+        index +
+        '" href="' +
+        taxon.getFileName() +
+        '" media-type="application/xhtml+xml" />';
+    }
 
-        xml += '<itemref idref="lfamilies"/>';
-        xml += '<itemref idref="lspecies"/>';
+    xml += PageListFlowers.getManifestEntries();
+    xml += this.#glossary.getManifestEntries();
+    xml += this.#images.getManifestEntries();
 
-        // Add families.
-        for (const family of this.#taxa.getFamilies().getFamilies()) {
-            const taxa = family.getTaxa();
-            if (!taxa) {
-                continue;
-            }
-            xml += '<itemref idref="fam' + family.getName() + '"/>';
-        }
+    return xml;
+  }
 
-        // Add taxa.
-        for (let index = 0; index < this.#taxa.getTaxonList().length; index++) {
-            xml += '<itemref idref="t' + index + '"/>';
-        }
+  renderSpineElements() {
+    let xml = "";
 
-        xml += this.#glossary.getSpineEntries();
+    // Add lists.
+    for (const color of this.#taxa.getFlowerColors()) {
+      xml += '<itemref idref="l' + color.getColorName() + '"/>';
+    }
+    xml += PageListFlowers.getSpineEntries();
+
+    xml += '<itemref idref="lfamilies"/>';
+    xml += '<itemref idref="lspecies"/>';
+
+    // Add families.
+    for (const family of this.#taxa.getFamilies().getFamilies()) {
+      const taxa = family.getTaxa();
+      if (!taxa) {
+        continue;
+      }
+      xml += '<itemref idref="fam' + family.getName() + '"/>';
+    }
 
-        return xml;
+    // Add taxa.
+    for (let index = 0; index < this.#taxa.getTaxonList().length; index++) {
+      xml += '<itemref idref="t' + index + '"/>';
     }
+
+    xml += this.#glossary.getSpineEntries();
+
+    return xml;
+  }
+}
+
+/**
+ * @param {Config} config
+ * @param {string} name
+ * @returns {string}
+ */
+function getRequiredConfigValue(config, name) {
+  const value = config.getConfigValue("ebook", name);
+  if (value === undefined) {
+    throw new Error();
+  }
+  return value;
 }
 
 export { PlantBook };

package/lib/genericpage.js

@@ -50,10 +50,9 @@ class GenericPage {
         // Include package markdown.
         const mdPath =
             Config.getPackageDir() + "/data/text/" + this.#baseFileName + ".md";
-        if (Files.exists(mdPath)) {
-            html += HTML.wrap("div", Markdown.fileToHTML(mdPath), {
-                class: "section",
-            });
+        const markdownHTML = Markdown.fileToHTML(mdPath);
+        if (markdownHTML) {
+            html += HTML.wrap("div", markdownHTML, { class: "section" });
         }
 
         return html;

package/lib/htmltaxon.js

@@ -4,149 +4,144 @@ import { RarePlants } from "./rareplants.js";
 import { TextUtils } from "./textutils.js";
 
 /**
- * @type {Object<string,{title:string,data:function (Taxon):string}>}
+ * @type {Record<string,{title:string,data:function (Taxon):string}>}
  */
 const TAXA_LIST_COLS = {
-    CESA: {
-        title: "California",
-        data: (t) => RarePlants.getCESADescription(t.getCESA()),
-    },
-    COMMON_NAME: {
-        title: "Common Name",
-        data: (t) => t.getCommonNames().join(", "),
-    },
-    CNPS_RANK: {
-        title: "CNPS Rank",
-        data: (t) =>
-            HTML.getToolTip(
-                HTML.textElement("span", t.getRPIRankAndThreat()),
-                t.getRPIRankAndThreatTooltip()
-            ),
-    },
-    FESA: {
-        title: "Federal",
-        data: (t) => RarePlants.getFESADescription(t.getFESA()),
-    },
-    SPECIES: {
-        title: "Species",
-        data: (t) => t.getHTMLLink(true, true),
-    },
-    SPECIES_BARE: {
-        title: "Species",
-        data: (t) => t.getHTMLLink(true, false),
-    },
+  CESA: {
+    title: "California",
+    data: (t) => RarePlants.getCESADescription(t.getCESA()),
+  },
+  COMMON_NAME: {
+    title: "Common Name",
+    data: (t) => t.getCommonNames().join(", "),
+  },
+  CNPS_RANK: {
+    title: "CNPS Rank",
+    data: (t) =>
+      HTML.getToolTip(
+        HTML.textElement("span", t.getRPIRankAndThreat()),
+        t.getRPIRankAndThreatTooltip()
+      ),
+  },
+  FESA: {
+    title: "Federal",
+    data: (t) => RarePlants.getFESADescription(t.getFESA()),
+  },
+  SPECIES: {
+    title: "Species",
+    data: (t) => t.getHTMLLink(true, true),
+  },
+  SPECIES_BARE: {
+    title: "Species",
+    data: (t) => t.getHTMLLink(true, false),
+  },
 };
 
 const DEFAULT_TAXA_COLUMNS = [
-    TAXA_LIST_COLS.SPECIES,
-    TAXA_LIST_COLS.COMMON_NAME,
+  TAXA_LIST_COLS.SPECIES,
+  TAXA_LIST_COLS.COMMON_NAME,
 ];
 
 class HTMLTaxon {
-    /**
-     * @param {string[]|undefined} colors
-     */
-    static getFlowerColors(colors, includeColorLink = true) {
-        let html = "";
-        if (colors) {
-            for (const color of colors) {
-                const img = HTML.textElement("img", "", {
-                    src: "./i/f-" + color + ".svg",
-                    alt: color + " flowers",
-                    title: color,
-                    class: "flr-color",
-                });
-                if (includeColorLink) {
-                    html += HTML.wrap("a", img, {
-                        href: "./list_fc_" + color + ".html",
-                    });
-                } else {
-                    html += img;
-                }
-            }
+  /**
+   * @param {string[]|undefined} colors
+   */
+  static getFlowerColors(colors, includeColorLink = true) {
+    let html = "";
+    if (colors) {
+      for (const color of colors) {
+        const img = HTML.textElement("img", "", {
+          src: "./i/f-" + color + ".svg",
+          alt: color + " flowers",
+          title: color,
+          class: "flr-color",
+        });
+        if (includeColorLink) {
+          html += HTML.wrap("a", img, {
+            href: "./list_fc_" + color + ".html",
+          });
+        } else {
+          html += img;
         }
-        return html;
+      }
     }
+    return html;
+  }
 
-    /**
-     * @param {Taxon} taxon
-     * @param {string} classNames
-     * @param {boolean} [includeColorLink=true]
-     */
-    static getFlowerInfo(
-        taxon,
-        classNames = "section",
-        includeColorLink = true
-    ) {
-        const lifeCycle = taxon.getLifeCycle();
-        const colors = taxon.getFlowerColors();
-        const monthStart = taxon.getBloomStart();
-        const monthEnd = taxon.getBloomEnd();
+  /**
+   * @param {Taxon} taxon
+   * @param {string} classNames
+   * @param {boolean} [includeColorLink=true]
+   */
+  static getFlowerInfo(taxon, classNames = "section", includeColorLink = true) {
+    const lifeCycle = taxon.getLifeCycle();
+    const colors = taxon.getFlowerColors();
+    const monthStart = taxon.getBloomStart();
+    const monthEnd = taxon.getBloomEnd();
 
-        const parts = [];
-        if (lifeCycle) {
-            const text =
-                HTML.wrap("span", TextUtils.ucFirst(lifeCycle), "lc") + ".";
-            parts.push(HTML.wrap("span", text, "lcs"));
-        }
-
-        if (colors || monthStart) {
-            let html = "Flowers: ";
-            html += this.getFlowerColors(colors, includeColorLink);
-            if (monthStart && monthEnd) {
-                html += HTML.wrap(
-                    "span",
-                    DateUtils.getMonthName(monthStart) +
-                        "-" +
-                        DateUtils.getMonthName(monthEnd),
-                    { class: "flr-time" }
-                );
-            }
-            parts.push(HTML.wrap("span", html));
-        }
-        return HTML.wrap("div", parts.join(""), { class: classNames });
+    const parts = [];
+    if (lifeCycle) {
+      const text = HTML.wrap("span", TextUtils.ucFirst(lifeCycle), "lc") + ".";
+      parts.push(HTML.wrap("span", text, "lcs"));
     }
 
-    /**
-     * @param {Taxon} taxon
-     */
-    static getLink(taxon) {
-        return (
-            HTML.getLink(taxon.getFileName(), taxon.getName()) +
-            this.getFlowerColors(taxon.getFlowerColors())
+    if (colors || monthStart) {
+      let html = "Flowers: ";
+      html += this.getFlowerColors(colors, includeColorLink);
+      if (monthStart && monthEnd) {
+        html += HTML.wrap(
+          "span",
+          DateUtils.getMonthName(monthStart) +
+            "-" +
+            DateUtils.getMonthName(monthEnd),
+          { class: "flr-time" }
         );
+      }
+      parts.push(HTML.wrap("span", html));
     }
+    return HTML.wrap("div", parts.join(""), { class: classNames });
+  }
 
-    /**
-     * @param {Taxon[]} taxa
-     * @param {TaxaCol[]} [columns]
-     */
-    static getTaxaTable(taxa, columns = DEFAULT_TAXA_COLUMNS) {
-        let html = "<table><thead>";
-        for (const col of columns) {
-            const className = col.class;
-            const atts = className !== undefined ? className : {};
-            html += HTML.textElement("th", col.title, atts);
-        }
-        html += "</thead>";
-        html += "<tbody>";
+  /**
+   * @param {Taxon} taxon
+   */
+  static getLink(taxon) {
+    return (
+      HTML.getLink(taxon.getFileName(), taxon.getName()) +
+      this.getFlowerColors(taxon.getFlowerColors())
+    );
+  }
 
-        for (const taxon of taxa) {
-            html += "<tr>";
-            for (const col of columns) {
-                const data = col.data(taxon);
-                const className = col.class;
-                const atts = className !== undefined ? className : {};
-                html += HTML.wrap("td", data, atts);
-            }
-            html += "</tr>";
-        }
-
-        html += "</tbody>";
-        html += "</table>";
+  /**
+   * @param {Taxon[]} taxa
+   * @param {TaxaCol[]} [columns]
+   */
+  static getTaxaTable(taxa, columns = DEFAULT_TAXA_COLUMNS) {
+    let html = "<table><thead>";
+    for (const col of columns) {
+      const className = col.class;
+      const atts = className !== undefined ? className : {};
+      html += HTML.textElement("th", col.title, atts);
+    }
+    html += "</thead>";
+    html += "<tbody>";
 
-        return html;
+    for (const taxon of taxa) {
+      html += "<tr>";
+      for (const col of columns) {
+        const data = col.data(taxon);
+        const className = col.class;
+        const atts = className !== undefined ? className : {};
+        html += HTML.wrap("td", data, atts);
+      }
+      html += "</tr>";
     }
+
+    html += "</tbody>";
+    html += "</table>";
+
+    return html;
+  }
 }
 
 export { HTMLTaxon, TAXA_LIST_COLS };

package/lib/index.d.ts

@@ -13,26 +13,29 @@ export class Config {
 }
 
 export class CSV {
-    static parseFile(dir: string, fileName: string);
+    static parseFile(dir: string, fileName: string): void;
 }
 
 export class ErrorLog {
     constructor(fileName: string, echo?: boolean);
-    log(...msg: string[]);
+    log(...msg: string[]): void;
     write(): void;
 }
 
 export class Exceptions {
     constructor(dataDir: string);
-    hasException(name: string, cat: string, subcat: string);
+    hasException(name: string, cat: string, subcat: string): boolean;
 }
 
 export class Files {
     static exists(fileName: string): boolean;
-    static async fetch(url: string | URL, targetFileName: string | undefined);
-    static mkdir(dir: string);
-    static rmDir(dir: string);
-    static write(fileName: string, data: string, overwrite: boolean);
+    static fetch(
+        url: string | URL,
+        targetFileName: string | undefined
+    ): Promise<Headers>;
+    static mkdir(dir: string): void;
+    static rmDir(dir: string): void;
+    static write(fileName: string, data: string, overwrite: boolean): void;
 }
 
 export class Program {
@@ -42,13 +45,13 @@ export class Program {
 
 export class Taxa {
     constructor(
-        inclusionList: Object<string, TaxonData> | true,
+        inclusionList: Record<string, TaxonData> | true,
         errorLog: ErrorLog,
         showFlowerErrors: boolean,
         taxonFactory?: (td: TaxonData, g: Genera) => Taxon,
         extraTaxa?: TaxonData[],
         extraSynonyms?: SynonymData[]
     );
-    getTaxon(string): Taxon;
+    getTaxon(name: string): Taxon;
     getTaxonList(): Taxon[];
 }

package/lib/markdown.js

@@ -6,8 +6,12 @@ class Markdown {
 
     /**
      * @param {string} filePath
+     * @returns {string|undefined}
      */
     static fileToHTML(filePath) {
+        if (!Files.exists(filePath)) {
+            return;
+        }
         return this.strToHTML(Files.read(filePath));
     }