@ca-plant-list/ca-plant-list 0.3.2 → 0.3.4

package/lib/basepagerenderer.js

@@ -1,58 +1,59 @@
 import { Config } from "./config.js";
-import { Families } from "./families.js";
 import { Files } from "./files.js";
 import { Jekyll } from "./jekyll.js";
 import { Taxa } from "./taxa.js";
 import { GlossaryPages } from "./web/glossarypages.js";
 
 class BasePageRenderer {
-
-    static render( outputDir, taxa, familyCols ) {
-
-        const siteGenerator = new Jekyll( outputDir );
+    /**
+     * @param {string} outputDir
+     * @param {Taxa} taxa
+     * @param {*} familyCols
+     */
+    static render(outputDir, taxa, familyCols) {
+        const siteGenerator = new Jekyll(outputDir);
 
         // Copy static files
         // First copy default Jekyll files from package.
-        Files.copyDir( Config.getPackageDir() + "/jekyll", outputDir );
+        Files.copyDir(Config.getPackageDir() + "/jekyll", outputDir);
         // Then copy Jekyll files from current dir (which may override default files).
-        Files.copyDir( "jekyll", outputDir );
+        Files.copyDir("jekyll", outputDir);
 
         // Copy illustrations.
-        siteGenerator.copyIllustrations( Taxa.getFlowerColors() );
+        siteGenerator.copyIllustrations(Taxa.getFlowerColors());
 
-        Families.renderPages( outputDir, familyCols );
+        taxa.getFamilies().renderPages(outputDir, familyCols);
 
-        new GlossaryPages( siteGenerator ).renderPages();
-
-        this.renderTools( outputDir, taxa );
+        new GlossaryPages(siteGenerator).renderPages();
 
+        this.renderTools(outputDir, taxa);
     }
 
-    static renderTools( outputDir, taxa ) {
-
+    /**
+     * @param {string} outputDir
+     * @param {Taxa} taxa
+     */
+    static renderTools(outputDir, taxa) {
         const names = [];
-        for ( const taxon of taxa.getTaxonList() ) {
+        for (const taxon of taxa.getTaxonList()) {
             const row = [];
-            row.push( taxon.getName() );
-            const cn = taxon.getCommonNames().join( ", " );
-            if ( cn ) {
-                row.push( cn );
+            row.push(taxon.getName());
+            const cn = taxon.getCommonNames().join(", ");
+            if (cn) {
+                row.push(cn);
             }
             const synonyms = [];
-            for ( const syn of taxon.getSynonyms() ) {
-                synonyms.push( syn );
+            for (const syn of taxon.getSynonyms()) {
+                synonyms.push(syn);
             }
-            if ( synonyms.length > 0 ) {
-                row[ 2 ] = synonyms;
+            if (synonyms.length > 0) {
+                row[2] = synonyms;
             }
-            names.push( row );
+            names.push(row);
         }
 
-        Files.write( outputDir + "/_includes/names.json", JSON.stringify( names ) );
-
+        Files.write(outputDir + "/_includes/names.json", JSON.stringify(names));
     }
-
-
 }
 
-export { BasePageRenderer };
+export { BasePageRenderer };

package/lib/dateutils.js

@@ -14,30 +14,50 @@ const MONTH_NAMES = [
 ];
 
 class DateUtils {
-
-    static getMonthName( monthNum ) {
-        return MONTH_NAMES[ monthNum - 1 ];
+    /**
+     * @param {number} monthNum Starting with 1 for January.
+     * @returns {string}
+     */
+    static getMonthName(monthNum) {
+        return MONTH_NAMES[monthNum - 1];
     }
 
-    static monthRangesOverlap( r1, r2 ) {
-
-        function contains( r1, r2 ) {
-            function inRange( v, r ) {
-                return v >= r[ 0 ] && v <= r[ 1 ];
+    /**
+     * @param {[number,number]} r1
+     * @param {[number,number]} r2
+     * @returns {boolean}
+     */
+    static monthRangesOverlap(r1, r2) {
+        /**
+         * @param {[number,number]} r1
+         * @param {[number,number]} r2
+         */
+        function contains(r1, r2) {
+            /**
+             * @param {number} v
+             * @param {[number,number]} r
+             */
+            function inRange(v, r) {
+                return v >= r[0] && v <= r[1];
             }
-            return inRange( r1[ 0 ], r2 ) || inRange( r1[ 1 ], r2 );
+            return inRange(r1[0], r2) || inRange(r1[1], r2);
         }
 
         // If ranges cross into next year, split them in 2.
-        if ( r1[ 0 ] > r1[ 1 ] ) {
-            return this.monthRangesOverlap( [ r1[ 0 ], 12 ], r2 ) || this.monthRangesOverlap( [ 1, r1[ 1 ] ], r2 );
+        if (r1[0] > r1[1]) {
+            return (
+                this.monthRangesOverlap([r1[0], 12], r2) ||
+                this.monthRangesOverlap([1, r1[1]], r2)
+            );
         }
-        if ( r2[ 0 ] > r2[ 1 ] ) {
-            return this.monthRangesOverlap( r1, [ r2[ 0 ], 12 ] ) || this.monthRangesOverlap( r1, [ 1, r2[ 1 ] ] );
+        if (r2[0] > r2[1]) {
+            return (
+                this.monthRangesOverlap(r1, [r2[0], 12]) ||
+                this.monthRangesOverlap(r1, [1, r2[1]])
+            );
         }
-        return contains( r1, r2 ) || contains( r2, r1 );
+        return contains(r1, r2) || contains(r2, r1);
     }
-
 }
 
-export { DateUtils };
+export { DateUtils };

package/lib/ebook/pages/page_list_families.js

@@ -1,27 +1,33 @@
 import { EBookPage } from "../ebookpage.js";
 import { XHTML } from "../xhtml.js";
+// eslint-disable-next-line no-unused-vars
 import { Families } from "../../families.js";
 
 class PageListFamilies extends EBookPage {
+    #families;
 
-    constructor( outputDir ) {
-        super( outputDir + "/list_families.html", "All Families" );
+    /**
+     * @param {string} outputDir
+     * @param {Families} families
+     */
+    constructor(outputDir, families) {
+        super(outputDir + "/list_families.html", "All Families");
+        this.#families = families;
     }
 
     renderPageBody() {
-
-        const html = XHTML.textElement( "h1", this.getTitle() );
+        const html = XHTML.textElement("h1", this.getTitle());
 
         const links = [];
-        for ( const family of Families.getFamilies() ) {
-            if ( !family.getTaxa() ) {
+        for (const family of this.#families.getFamilies()) {
+            if (!family.getTaxa()) {
                 continue;
             }
-            links.push( XHTML.getLink( family.getFileName(), family.getName() ) );
+            links.push(XHTML.getLink(family.getFileName(), family.getName()));
         }
 
-        return html + XHTML.wrap( "ol", XHTML.arrayToLI( links ) );
+        return html + XHTML.wrap("ol", XHTML.arrayToLI(links));
     }
 }
 
-export { PageListFamilies };
+export { PageListFamilies };

package/lib/ebook/pages/taxonpage.js

@@ -4,88 +4,115 @@ import { EBookPage } from "../ebookpage.js";
 import { XHTML } from "../xhtml.js";
 import { Markdown } from "../../markdown.js";
 import { DateUtils } from "../../dateutils.js";
+// eslint-disable-next-line no-unused-vars
+import { Taxon } from "../../taxon.js";
 
 class TaxonPage extends EBookPage {
-
     #outputDir;
     #taxon;
     #photos;
 
-    constructor( outputDir, taxon, photos ) {
-        super( outputDir + "/" + taxon.getFileName(), taxon.getName() );
+    /**
+     *
+     * @param {string} outputDir
+     * @param {Taxon} taxon
+     * @param {*} photos
+     */
+    constructor(outputDir, taxon, photos) {
+        super(outputDir + "/" + taxon.getFileName(), taxon.getName());
         this.#outputDir = outputDir;
         this.#taxon = taxon;
         this.#photos = photos;
     }
 
     renderPageBody() {
-
-        function renderBloomInfo( taxon ) {
+        /**
+         * @param {Taxon} taxon
+         */
+        function renderBloomInfo(taxon) {
             const colors = taxon.getFlowerColors();
             const monthStart = taxon.getBloomStart();
             const monthEnd = taxon.getBloomEnd();
-            if ( !colors && !monthStart ) {
+            if (!colors && !monthStart) {
                 return "";
             }
             let html = "";
-            if ( colors ) {
-                for ( const color of colors ) {
-                    html += XHTML.textElement( "img", "", { src: "./i/f-" + color + ".svg", class: "flr" } );
+            if (colors) {
+                for (const color of colors) {
+                    html += XHTML.textElement("img", "", {
+                        src: "./i/f-" + color + ".svg",
+                        class: "flr",
+                    });
                 }
             }
-            if ( monthStart ) {
-                html += XHTML.textElement( "div", DateUtils.getMonthName( monthStart ) + "-" + DateUtils.getMonthName( monthEnd ) );
-
+            if (monthStart && monthEnd) {
+                html += XHTML.textElement(
+                    "div",
+                    DateUtils.getMonthName(monthStart) +
+                        "-" +
+                        DateUtils.getMonthName(monthEnd)
+                );
             }
-            return XHTML.wrap( "div", html, { class: "flr" } );
+            return XHTML.wrap("div", html, { class: "section flr" });
         }
 
-
-        function renderCustomText( name ) {
+        /**
+         * @param {string} name
+         */
+        function renderCustomText(name) {
             // See if there is custom text.
-            const fileName = Config.getPackageDir() + "/data/text/" + name + ".md";
-            if ( !Files.exists( fileName ) ) {
+            const fileName =
+                Config.getPackageDir() + "/data/text/" + name + ".md";
+            if (!Files.exists(fileName)) {
                 return "";
             }
-            const text = Files.read( fileName );
-            return Markdown.strToHTML( text );
+            const text = Files.read(fileName);
+            return Markdown.strToHTML(text);
         }
 
         const name = this.#taxon.getName();
-        let html = XHTML.textElement( "h1", name );
+        let html = XHTML.textElement("h1", name);
 
         const family = this.#taxon.getFamily();
-        html += XHTML.wrap( "div", XHTML.getLink( family.getFileName(), family.getName() ) );
+        html += XHTML.wrap(
+            "div",
+            XHTML.getLink(family.getFileName(), family.getName()),
+            { class: "section" }
+        );
 
         const cn = this.#taxon.getCommonNames();
-        if ( cn && cn.length > 0 ) {
-            html += XHTML.textElement( "p", cn.join( ", " ) );
+        if (cn && cn.length > 0) {
+            html += XHTML.textElement("div", cn.join(", "), {
+                class: "section",
+            });
         }
 
-        html += renderBloomInfo( this.#taxon );
+        html += renderBloomInfo(this.#taxon);
 
-        html += renderCustomText( this.#taxon.getBaseFileName() );
+        html += renderCustomText(this.#taxon.getBaseFileName());
 
-        if ( this.#photos ) {
+        if (this.#photos) {
             let photoHTML = "";
-            for ( const photo of this.#photos ) {
+            for (const photo of this.#photos) {
                 const src = photo.getSrc();
-                const dimensions = sizeOf( this.#outputDir + "/" + src );
-                let img = XHTML.textElement( "img", "", { src: src, style: "max-width:" + dimensions.width + "px" } );
+                const dimensions = sizeOf(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 );
+                if (caption) {
+                    img += XHTML.textElement("figcaption", caption);
                 }
-                photoHTML += XHTML.wrap( "figure", img );
+                photoHTML += XHTML.wrap("figure", img);
             }
-            if ( photoHTML ) {
-                html += XHTML.wrap( "div", photoHTML );
+            if (photoHTML) {
+                html += XHTML.wrap("div", photoHTML);
             }
         }
 
         return html;
     }
-
 }
 
-export { TaxonPage };
+export { TaxonPage };

package/lib/ebook/plantbook.js

@@ -1,4 +1,3 @@
-import { Families } from "@ca-plant-list/ca-plant-list";
 import { EBook } from "./ebook.js";
 import { EBookSiteGenerator } from "./ebooksitegenerator.js";
 import { GlossaryPages } from "./glossarypages.js";
@@ -12,89 +11,124 @@ import { TOCPage } from "./pages/tocpage.js";
 import { Taxa } from "../taxa.js";
 
 class PlantBook extends EBook {
-
     #taxa;
     #glossary;
     #images;
 
-    constructor( outputDir, config, taxa ) {
-
+    /**
+     *
+     * @param {string} outputDir
+     * @param {*} config
+     * @param {Taxa} taxa
+     */
+    constructor(outputDir, config, taxa) {
         super(
             outputDir,
-            config.getConfigValue( "ebook", "filename" ),
-            config.getConfigValue( "ebook", "pub_id" ),
-            config.getConfigValue( "ebook", "title" )
+            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 );
-
+        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( contentDir );
+        await this.#images.createImages();
 
-        console.log( "creating taxon pages" );
+        console.log("creating taxon pages");
         const taxonList = this.#taxa.getTaxonList();
-        for ( const taxon of taxonList ) {
+        for (const taxon of taxonList) {
             const name = taxon.getName();
-            new TaxonPage( contentDir, taxon, this.#images.getTaxonImages( name ) ).create();
+            new TaxonPage(
+                contentDir,
+                taxon,
+                this.#images.getTaxonImages(name)
+            ).create();
         }
 
         // Create lists.
-        for ( const colorName of Taxa.getFlowerColorNames() ) {
-            new PageListFlowerColor( contentDir, this.#taxa.getFlowerColor( colorName ) ).create();
+        for (const colorName of Taxa.getFlowerColorNames()) {
+            new PageListFlowerColor(
+                contentDir,
+                this.#taxa.getFlowerColor(colorName)
+            ).create();
         }
 
-        PageListFlowers.createPages( contentDir, this.#taxa );
+        PageListFlowers.createPages(contentDir, this.#taxa);
 
-        new PageListFamilies( contentDir ).create();
-        for ( const family of Families.getFamilies() ) {
+        new PageListFamilies(contentDir, this.#taxa.getFamilies()).create();
+        for (const family of this.#taxa.getFamilies().getFamilies()) {
             const taxa = family.getTaxa();
-            if ( !taxa ) {
+            if (!taxa) {
                 continue;
             }
             const name = family.getName();
-            new PageListSpecies( contentDir, taxa, name + ".html", name ).create();
+            new PageListSpecies(
+                contentDir,
+                taxa,
+                name + ".html",
+                name
+            ).create();
         }
-        new PageListSpecies( contentDir, taxonList, "list_species.html", "All Species" ).create();
+        new PageListSpecies(
+            contentDir,
+            taxonList,
+            "list_species.html",
+            "All Species"
+        ).create();
 
         this.#glossary.renderPages();
 
-        new TOCPage( contentDir ).create();
+        new TOCPage(contentDir).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 colorName of Taxa.getFlowerColorNames() ) {
-            const color = this.#taxa.getFlowerColor( colorName );
-            xml += "<item id=\"l" + color.getColorName() + "\" href=\"" + color.getFileName() + "\" media-type=\"application/xhtml+xml\" />";
+        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 colorName of Taxa.getFlowerColorNames()) {
+            const color = this.#taxa.getFlowerColor(colorName);
+            xml +=
+                '<item id="l' +
+                color.getColorName() +
+                '" href="' +
+                color.getFileName() +
+                '" media-type="application/xhtml+xml" />';
         }
 
         // Add family pages.
-        for ( const family of Families.getFamilies() ) {
+        for (const family of this.#taxa.getFamilies().getFamilies()) {
             const taxa = family.getTaxa();
-            if ( !taxa ) {
+            if (!taxa) {
                 continue;
             }
-            xml += "<item id=\"fam" + family.getName() + "\" href=\"" + family.getFileName() + "\" media-type=\"application/xhtml+xml\" />";
+            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\" />";
+        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();
@@ -108,27 +142,27 @@ class PlantBook extends EBook {
         let xml = "";
 
         // Add lists.
-        for ( const colorName of Taxa.getFlowerColorNames() ) {
-            const color = this.#taxa.getFlowerColor( colorName );
-            xml += "<itemref idref=\"l" + color.getColorName() + "\"/>";
+        for (const colorName of Taxa.getFlowerColorNames()) {
+            const color = this.#taxa.getFlowerColor(colorName);
+            xml += '<itemref idref="l' + color.getColorName() + '"/>';
         }
         xml += PageListFlowers.getSpineEntries();
 
-        xml += "<itemref idref=\"lfamilies\"/>";
-        xml += "<itemref idref=\"lspecies\"/>";
+        xml += '<itemref idref="lfamilies"/>';
+        xml += '<itemref idref="lspecies"/>';
 
         // Add families.
-        for ( const family of Families.getFamilies() ) {
+        for (const family of this.#taxa.getFamilies().getFamilies()) {
             const taxa = family.getTaxa();
-            if ( !taxa ) {
+            if (!taxa) {
                 continue;
             }
-            xml += "<itemref idref=\"fam" + family.getName() + "\"/>";
+            xml += '<itemref idref="fam' + family.getName() + '"/>';
         }
 
         // Add taxa.
-        for ( let index = 0; index < this.#taxa.getTaxonList().length; index++ ) {
-            xml += "<itemref idref=\"t" + index + "\"/>";
+        for (let index = 0; index < this.#taxa.getTaxonList().length; index++) {
+            xml += '<itemref idref="t' + index + '"/>';
         }
 
         xml += this.#glossary.getSpineEntries();
@@ -137,4 +171,4 @@ class PlantBook extends EBook {
     }
 }
 
-export { PlantBook };
+export { PlantBook };

package/lib/errorlog.js

@@ -2,30 +2,35 @@ import * as fs from "node:fs";
 import * as path from "node:path";
 
 class ErrorLog {
-
     #fileName;
     #echo;
+    /** @type string[] */
     #errors = [];
 
-    constructor( fileName, echo = false ) {
+    /**
+     * @param {string} fileName
+     * @param {boolean} echo
+     */
+    constructor(fileName, echo = false) {
         this.#fileName = fileName;
         this.#echo = echo;
     }
 
-    log( ...args ) {
-        if ( this.#echo ) {
-            console.log( args.join() );
+    /**
+     * @param  {...string} args
+     */
+    log(...args) {
+        if (this.#echo) {
+            console.log(args.join());
         }
-        this.#errors.push( args.join( "\t" ) );
+        this.#errors.push(args.join("\t"));
     }
 
     write() {
         // Make sure directory exists.
-        fs.mkdirSync( path.dirname( this.#fileName ), { recursive: true } );
-
-        fs.writeFileSync( this.#fileName, this.#errors.join( "\n" ) );
+        fs.mkdirSync(path.dirname(this.#fileName), { recursive: true });
+        fs.writeFileSync(this.#fileName, this.#errors.join("\n"));
     }
-
 }
 
-export { ErrorLog };
+export { ErrorLog };