@ca-plant-list/ca-plant-list 0.4.8 → 0.4.9

package/.github/workflows/main.yml

@@ -0,0 +1,20 @@
+on:
+    workflow_dispatch:
+    pull_request:
+    push:
+
+permissions:
+    contents: read
+
+jobs:
+    check:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v4
+            - uses: actions/setup-node@v4
+              with:
+                  node-version: latest
+                  cache: "npm"
+            - run: npm update
+            - run: npx eslint
+            - run: npx tsc

package/.vscode/settings.json

@@ -1,4 +1,9 @@
 {
-    "editor.formatOnSave": true,
-    "eslint.validate": ["javascript", "typescript"]
+    "eslint.validate": ["javascript", "typescript"],
+    "json.schemas": [
+        {
+            "fileMatch": ["exceptions.json"],
+            "url": "./schemas/exceptions.schema.json"
+        }
+    ]
 }

package/data/glossary/perianth.md

@@ -0,0 +1 @@
+The collection of petals and [sepals](./sepal.html) on a flower.

package/data/taxa.csv

@@ -1255,6 +1255,8 @@ Navarretia pubescens,downy pincushion,N,34471,5804,58976
 Navarretia squarrosa,skunkweed,N,34475,5807,53157
 Navarretia tagetina,,N,34477,5809,60226
 Navarretia viscidula,sticky navarretia,N,34478,5810,78195
+Nemacladus capillaris,common threadplant,N,34503,5815,78199,annual,white,5,7
+Nemacladus montanus,mountain threadplant,N,34508,5824,78203,annual,white,5,7
 Nemophila heterophylla,,N,34539,5834,53158,,white,2,6
 Nemophila menziesii var. atomaria,,N,62279,5837,50647,,white,2,6
 Nemophila menziesii var. menziesii,baby blue-eyes,N,62285,5839,50650
@@ -1771,9 +1773,9 @@ Torilis arvensis,tall sock-destroyer,X,46743,8004,56846
 Torilis nodosa,short sock-destroyer,X,46747,8007,53304
 Torreyochloa pallida var. pauciflora,,N,67197,8010,81431
 Toxicodendron diversilobum,poison-oak,N,46791,8015,51080,,white
-Toxicoscordion fremontii,zigadene,N,89163,11103,49649,,white
-Toxicoscordion paniculatum,,N,46802,11105,79380
-Toxicoscordion venenosum var. venenosum,death-camas,N,93851,11106,81432
+Toxicoscordion fremontii,zigadene,N,89163,11103,49649,bulb,white,2,6
+Toxicoscordion paniculatum,,N,46802,11105,79380,bulb,white,5,6
+Toxicoscordion venenosum var. venenosum,death-camas,N,93851,11106,81432,bulb,white,5,7
 Tradescantia fluminensis,,X,77137,8017,79382
 Tragopogon porrifolius,salsify,X,5449,8020,54141
 Trianthema portulacastrum,,N,46920,8023,79390

package/data/text/Toxicoscordion-fremontii.md

@@ -0,0 +1 @@
+Leaves 8-30 mm wide. [Perianth](./perianth.html) parts 5-15 mm long.

package/data/text/Toxicoscordion-paniculatum.md

@@ -0,0 +1 @@
+Leaves 6-16 mm wide. [Perianth](./perianth.html) parts 2-6 mm long. Perianth parts unequal, outer parts generally without claws, inner parts with claws. Stamens at least as long as perianth parts.

package/data/text/Toxicoscordion-venenosum-var-venenosum.md

@@ -0,0 +1 @@
+Leaves 4-10 mm wide. [Perianth](./perianth.html) parts 4-6 mm long. Stamens at least as long as perianth parts.

package/ebook/css/main.css

@@ -12,6 +12,14 @@ div.section {
     margin-bottom: .5rem;
 }
 
+div.photos {
+    display: flex;
+}
+
+figure {
+    margin: auto;
+}
+
 img.flr-color {
     padding-right: .25rem;
     width: 1rem;
@@ -29,4 +37,4 @@ span.lcs {
 /* Glossary */
 div.glossary img {
     max-height: 300px;
-}
+}

package/eslint.config.mjs

@@ -1,13 +1,13 @@
+import globals from "globals";
+import pluginJs from "@eslint/js";
+
+/** @type {import('eslint').Linter.Config[]} */
 export default [
+    { files: ["**/*.{js,mjs,cjs}"], ignores: ["output/**"] },
     {
-        rules: {
-            indent: ["error", 4, {
-                SwitchCase: 1,
-            }],
-
-            "linebreak-style": ["error", "unix"],
-            quotes: ["error", "double"],
-            semi: ["error", "always"],
+        languageOptions: {
+            globals: { ...globals.browser, ...globals.node, bootstrap: false },
         },
-    }
+    },
+    pluginJs.configs.recommended,
 ];

package/lib/ebook/images.js

@@ -1,20 +1,15 @@
 import * as fs from "node:fs";
-import path from "node:path";
 
 import sharp from "sharp";
 
 import { EBook } from "./ebook.js";
-import { Config } from "../config.js";
-import { CSV } from "../csv.js";
 import { Files } from "../files.js";
-import { TaxonImage } from "./taxonimage.js";
+import { ProgressMeter } from "../progressmeter.js";
 
 class Images {
     #siteGenerator;
     #contentDir;
     #taxa;
-    /** @type {Object<string,TaxonImage[]>} */
-    #images = {};
 
     /**
      * @param {SiteGenerator} siteGenerator
@@ -27,53 +22,63 @@ class Images {
         this.#taxa = taxa;
     }
 
-    async createImages() {
+    /**
+     * @param {Taxon[]} taxa
+     */
+    async createImages(taxa) {
+        const meter = new ProgressMeter("processing photos", taxa.length);
+
+        const width = 300;
+        const quality = 40;
+
         const photoDirSrc = "external_data/photos";
-        const imagePrefix = "i";
-        const photoDirTarget = this.#contentDir + "/" + imagePrefix;
-        fs.mkdirSync(photoDirSrc, { recursive: true });
-        fs.mkdirSync(photoDirTarget, { recursive: true });
-
-        const rows = CSV.parseFile(
-            Config.getPackageDir() + "/data",
-            "photos.csv"
+        const photoDirCache = `external_data/photos-${width}-${quality}`;
+        [photoDirSrc, photoDirCache, this.#contentDir + "/i"].forEach((dir) =>
+            fs.mkdirSync(dir, { recursive: true }),
         );
-        for (const row of rows) {
-            const name = row["taxon_name"];
-            const taxon = this.#taxa.getTaxon(name);
-            if (!taxon) {
-                continue;
-            }
 
-            let imageList = this.#images[name];
-            if (!imageList) {
-                imageList = [];
-                this.#images[name] = imageList;
+        let downloadCount = 0;
+        let compressCount = 0;
+        let copyCount = 0;
+
+        for (let index = 0; index < taxa.length; index++) {
+            const taxon = taxa[index];
+            const photos = Images.getTaxonPhotos(taxon);
+            for (const photo of photos) {
+                const ext = photo.getExt();
+                const cachedFileName = `${photoDirCache}/${this.getCompressedImageName(photo)}`;
+
+                if (!fs.existsSync(cachedFileName)) {
+                    const srcFileName = `${photoDirSrc}/${photo.getId()}.${ext}`;
+                    // Compress and cache source file.
+                    if (!fs.existsSync(srcFileName)) {
+                        // Retrieve original file.
+                        if (!fs.existsSync(srcFileName)) {
+                            // File is not there; retrieve it.
+                            await Files.fetch(photo.getUrl(), srcFileName);
+                            downloadCount++;
+                        }
+                    }
+                    await sharp(srcFileName)
+                        .resize({ width: width })
+                        .jpeg({ quality: quality })
+                        .toFile(cachedFileName);
+                    compressCount++;
+                }
+
+                fs.copyFileSync(
+                    cachedFileName,
+                    this.getCompressedFilePath(photo),
+                );
+                copyCount++;
             }
-
-            const src = new URL(row["source"]);
-            const parts = path.parse(src.pathname).dir.split("/");
-            const prefix = src.host.includes("calflora") ? "cf-" : "inat-";
-            const filename = prefix + parts.slice(-1)[0] + ".jpg";
-            const srcFileName = photoDirSrc + "/" + filename;
-            const targetFileName = photoDirTarget + "/" + filename;
-
-            if (!fs.existsSync(srcFileName)) {
-                // File is not there; retrieve it.
-                console.log("retrieving " + srcFileName);
-                await Files.fetch(src, srcFileName);
-            }
-
-            await sharp(srcFileName)
-                .resize({ width: 300 })
-                .jpeg({ quality: 40 })
-                .toFile(targetFileName);
-
-            imageList.push(
-                new TaxonImage(imagePrefix + "/" + filename, row["credit"])
-            );
+            meter.update(index + 1, {
+                custom: ` | ${copyCount} copied - ${compressCount} compressed - ${downloadCount} downloaded`,
+            });
         }
 
+        meter.stop();
+
         this.#siteGenerator.copyIllustrations(this.#taxa.getFlowerColors());
     }
 
@@ -88,8 +93,8 @@ class Images {
                 EBook.getManifestEntry(
                     "i" + index,
                     "i/" + fileName,
-                    EBook.getMediaTypeForExt(ext)
-                )
+                    EBook.getMediaTypeForExt(ext),
+                ),
             );
         }
 
@@ -97,10 +102,32 @@ class Images {
     }
 
     /**
-     * @param {string} name
+     * @param {Photo} photo
+     * @returns {string}
+     */
+    getCompressedFilePath(photo) {
+        return `${this.#contentDir}/i/${this.getCompressedImageName(photo)}`;
+    }
+
+    /**
+     * @param {Photo} photo
+     * @returns {string}
      */
-    getTaxonImages(name) {
-        return this.#images[name];
+    getCompressedImageName(photo) {
+        return `${photo.getId()}.${photo.getExt().toLowerCase()}`;
+    }
+
+    /**
+     * @param {Taxon} taxon
+     * @returns {Photo[]}
+     */
+    static getTaxonPhotos(taxon) {
+        const photos = taxon
+            .getPhotos()
+            .filter((photo) =>
+                ["jpg", "jpeg"].includes(photo.getExt().toLowerCase()),
+            );
+        return photos.length > 0 ? [photos[0]] : photos;
     }
 }
 

package/lib/ebook/pages/taxonpage.js

@@ -1,26 +1,25 @@
-import imageSize from "image-size";
 import { EBookPage } from "../ebookpage.js";
 import { XHTML } from "../xhtml.js";
 import { Markdown } from "../../markdown.js";
 import { HTMLTaxon } from "../../htmltaxon.js";
 import { Config } from "../../config.js";
 import { Files } from "../../files.js";
+import { Images } from "../images.js";
+import imageSize from "image-size";
 
 class TaxonPage extends EBookPage {
-    #outputDir;
     #taxon;
-    #photos;
+    #images;
 
     /**
      * @param {string} outputDir
      * @param {Taxon} taxon
-     * @param {TaxonImage[]} photos
+     * @param {Images} images
      */
-    constructor(outputDir, taxon, photos) {
+    constructor(outputDir, taxon, images) {
         super(outputDir + "/" + taxon.getFileName(), taxon.getName());
-        this.#outputDir = outputDir;
         this.#taxon = taxon;
-        this.#photos = photos;
+        this.#images = images;
     }
 
     renderPageBody() {
@@ -45,7 +44,7 @@ class TaxonPage extends EBookPage {
         html += XHTML.wrap(
             "div",
             XHTML.getLink(family.getFileName(), family.getName()),
-            { class: "section" }
+            { class: "section" },
         );
 
         const cn = this.#taxon.getCommonNames();
@@ -59,26 +58,25 @@ class TaxonPage extends EBookPage {
 
         html += renderCustomText(this.#taxon.getBaseFileName());
 
-        if (this.#photos) {
-            let photoHTML = "";
-            for (const photo of this.#photos) {
-                const src = photo.getSrc();
-                const dimensions = imageSize.imageSize(
-                    this.#outputDir + "/" + src
-                );
-                let img = XHTML.textElement("img", "", {
-                    src: src,
-                    style: "max-width:" + dimensions.width + "px",
-                });
-                const caption = photo.getCaption();
-                if (caption) {
-                    img += XHTML.textElement("figcaption", caption);
-                }
-                photoHTML += XHTML.wrap("figure", img);
-            }
-            if (photoHTML) {
-                html += XHTML.wrap("div", photoHTML);
+        const photos = Images.getTaxonPhotos(this.#taxon);
+
+        let photoHTML = "";
+        for (const photo of photos) {
+            const dimensions = imageSize.imageSize(
+                this.#images.getCompressedFilePath(photo),
+            );
+            let img = XHTML.textElement("img", "", {
+                src: `i/${this.#images.getCompressedImageName(photo)}`,
+                style: "max-width:" + dimensions.width + "px",
+            });
+            const caption = `${photo.rights === "CC0" ? "By" : "(c)"} ${photo.rightsHolder} ${photo.rights && `(${photo.rights})`}`;
+            if (caption) {
+                img += XHTML.textElement("figcaption", caption);
             }
+            photoHTML += XHTML.wrap("figure", img);
+        }
+        if (photoHTML) {
+            html += XHTML.wrap("div", photoHTML, "photos");
         }
 
         return html;