@ca-plant-list/ca-plant-list 0.3.1 → 0.3.3

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/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 };

package/lib/exceptions.js

@@ -18,6 +18,8 @@ class Exceptions {
         const localExceptions = readConfig( dir + "/exceptions.json" );
         for ( const [ k, v ] of Object.entries( localExceptions ) ) {
             this.#exceptions[ k ] = v;
+            // Tag as a local exception so we can distinguish between global and local.
+            v.local = true;
         }
 
     }

package/lib/families.js

@@ -4,30 +4,38 @@ import { Jepson } from "./jepson.js";
 import { Taxa } from "./taxa.js";
 import { Files } from "./files.js";
 import { Config } from "./config.js";
+// eslint-disable-next-line no-unused-vars
+import { Taxon } from "./index.js";
 
 class Family {
-
     #name;
     #data;
 
-    constructor( name, data ) {
+    /**
+     * @param {string} name
+     * @param {*} data
+     */
+    constructor(name, data) {
         this.#name = name;
         this.#data = data;
     }
 
-    addTaxon( taxon ) {
-        if ( !this.#data.taxa ) {
+    /**
+     * @param {Taxon} taxon
+     */
+    addTaxon(taxon) {
+        if (!this.#data.taxa) {
             this.#data.taxa = [];
         }
-        this.#data.taxa.push( taxon );
-        Sections.addTaxon( this.getSectionName(), taxon );
+        this.#data.taxa.push(taxon);
+        Sections.addTaxon(this.getSectionName(), taxon);
     }
 
     getBaseFileName() {
         return this.getName();
     }
 
-    getFileName( ext = "html" ) {
+    getFileName(ext = "html") {
         return this.getBaseFileName() + "." + ext;
     }
 
@@ -46,163 +54,193 @@ class Family {
     getTaxa() {
         return this.#data.taxa;
     }
-
 }
 
 class Families {
-
     static #families;
 
     static {
-
         const dataDir = Config.getPackageDir() + "/data";
 
-        this.#families = JSON.parse( Files.read( dataDir + "/families.json" ) );
-        for ( const [ k, v ] of Object.entries( this.#families ) ) {
-            this.#families[ k ] = new Family( k, v );
+        this.#families = JSON.parse(Files.read(dataDir + "/families.json"));
+        for (const [k, v] of Object.entries(this.#families)) {
+            this.#families[k] = new Family(k, v);
         }
-
     }
 
     static getFamilies() {
-        return Object.values( this.#families ).sort( ( a, b ) => a.getName().localeCompare( b.getName() ) );
+        return Object.values(this.#families).sort((a, b) =>
+            a.getName().localeCompare(b.getName())
+        );
     }
 
-    static getFamily( familyName ) {
-        return this.#families[ familyName ];
+    /**
+     * @param {string} familyName
+     */
+    static getFamily(familyName) {
+        return this.#families[familyName];
     }
 
-    static renderPages( outputDir, taxaColumns ) {
-        new PageFamilyList( outputDir, this.#families ).render( taxaColumns );
+    /**
+     * @param {string} outputDir
+     * @param {import("./index.js").TaxaCol[]} taxaColumns
+     */
+    static renderPages(outputDir, taxaColumns) {
+        new PageFamilyList(outputDir, this.#families).render(taxaColumns);
 
-        const names = Object.keys( this.#families );
-        for ( const name of names.sort() ) {
-            const family = this.#families[ name ];
-            if ( family.getTaxa() ) {
-                new PageFamily( outputDir, family ).render( taxaColumns );
+        const names = Object.keys(this.#families);
+        for (const name of names.sort()) {
+            const family = this.#families[name];
+            if (family.getTaxa()) {
+                new PageFamily(outputDir, family).render(taxaColumns);
             }
         }
     }
-
 }
 
 class PageFamilyList extends GenericPage {
-
     #families;
 
-    constructor( outputDir, families ) {
-        super( outputDir, "Families", "list_families" );
+    /**
+     * @param {string} outputDir
+     * @param {Object<string,Family>} families
+     */
+    constructor(outputDir, families) {
+        super(outputDir, "Families", "list_families");
         this.#families = families;
     }
 
-    render( taxaColumns ) {
-
+    /**
+     * @param {import("./index.js").TaxaCol[]} taxaColumns
+     */
+    render(taxaColumns) {
         let html = this.getDefaultIntro();
 
         const sections = Sections.getSections();
         const sectionLinks = [];
-        for ( const name of Object.keys( sections ).sort() ) {
-
-            const taxa = sections[ name ];
+        for (const name of Object.keys(sections).sort()) {
+            const taxa = sections[name];
 
             // Render the section page.
-            new PageSection( this.getOutputDir(), name, taxa ).render( taxaColumns );
+            new PageSection(this.getOutputDir(), name, taxa).render(
+                taxaColumns
+            );
 
             // Render the link.
             const href = "./" + name + ".html";
-            sectionLinks.push( HTML.getLink( href, name ) + " (" + taxa.length + ")" );
+            sectionLinks.push(
+                HTML.getLink(href, name) + " (" + taxa.length + ")"
+            );
         }
-        html += HTML.wrap( "ul", HTML.arrayToLI( sectionLinks ), { class: "listmenu" } );
+        html += HTML.wrap("ul", HTML.arrayToLI(sectionLinks), {
+            class: "listmenu",
+        });
 
         html += "<table>";
         html += "<thead>";
-        html += HTML.textElement( "th", "Family" );
-        html += HTML.textElement( "th", "Number of Species", { class: "right" } );
+        html += HTML.textElement("th", "Family");
+        html += HTML.textElement("th", "Number of Species", { class: "right" });
         html += "</thead>";
 
         html += "<tbody>";
-        const names = Object.keys( this.#families ).sort();
-        for ( const name of names ) {
-            const family = this.#families[ name ];
+        const names = Object.keys(this.#families).sort();
+        for (const name of names) {
+            const family = this.#families[name];
             const taxa = family.getTaxa();
-            if ( !taxa ) {
+            if (!taxa) {
                 continue;
             }
-            let cols = HTML.wrap( "td", HTML.getLink( "./" + family.getFileName(), family.getName() ) );
-            cols += HTML.wrap( "td", taxa.length, { class: "right" } );
-            html += HTML.wrap( "tr", cols );
+            let cols = HTML.wrap(
+                "td",
+                HTML.getLink("./" + family.getFileName(), family.getName())
+            );
+            cols += HTML.wrap("td", taxa.length, { class: "right" });
+            html += HTML.wrap("tr", cols);
         }
         html += "</tbody>";
 
         html += "</table>";
 
-        this.writeFile( html );
+        this.writeFile(html);
     }
 }
 
 class PageFamily extends GenericPage {
-
     #family;
 
-    constructor( outputDir, family ) {
-        super( outputDir, family.getName(), family.getBaseFileName() );
+    /**
+     * @param {string} outputDir
+     * @param {Family} family
+     */
+    constructor(outputDir, family) {
+        super(outputDir, family.getName(), family.getBaseFileName());
         this.#family = family;
     }
 
-    render( columns ) {
-
+    /**
+     *
+     * @param {import("./index.js").TaxaCol[]} columns
+     */
+    render(columns) {
         let html = this.getDefaultIntro();
 
         html += HTML.wrap(
             "div",
-            Jepson.getEFloraLink( this.#family.getJepsonID() ),
+            Jepson.getEFloraLink(this.#family.getJepsonID()),
             { class: "section" }
         );
 
-        html += Taxa.getHTMLTable( this.#family.getTaxa(), columns );
-
-        this.writeFile( html );
+        html += Taxa.getHTMLTable(this.#family.getTaxa(), columns);
 
+        this.writeFile(html);
     }
 }
 
 class PageSection extends GenericPage {
-
     #taxa;
 
-    constructor( outputDir, name, taxa ) {
-        super( outputDir, name, name );
+    /**
+     * @param {string} outputDir
+     * @param {string} name
+     * @param {Taxon[]} taxa
+     */
+    constructor(outputDir, name, taxa) {
+        super(outputDir, name, name);
         this.#taxa = taxa;
     }
 
-    render( columns ) {
-
+    /**
+     * @param {import("./index.js").TaxaCol[]} columns
+     */
+    render(columns) {
         let html = this.getDefaultIntro();
 
-        html += Taxa.getHTMLTable( this.#taxa, columns );
-
-        this.writeFile( html );
+        html += Taxa.getHTMLTable(this.#taxa, columns);
 
+        this.writeFile(html);
     }
 }
 
 class Sections {
-
+    /** @type {Object<string,Taxon[]} */
     static #sections = {};
 
-    static addTaxon( name, taxon ) {
-        let section = this.#sections[ name ];
-        if ( !section ) {
+    /**
+     * @param {string} name
+     * @param {Taxon} taxon
+     */
+    static addTaxon(name, taxon) {
+        let section = this.#sections[name];
+        if (!section) {
             section = [];
-            this.#sections[ name ] = section;
+            this.#sections[name] = section;
         }
-        section.push( taxon );
+        section.push(taxon);
     }
 
     static getSections() {
         return this.#sections;
     }
-
 }
 
-export { Families };
+export { Families };