@ca-plant-list/ca-plant-list 0.3.5 → 0.3.7

package/lib/pagerenderer.js

@@ -1,71 +1,93 @@
-import { Files, Taxa, HTML } from "@ca-plant-list/ca-plant-list";
-import { TAXA_LIST_COLS } from "./taxa.js";
+import { Taxa, TAXA_LIST_COLS } from "./taxa.js";
 import { PageTaxon } from "./web/pagetaxon.js";
 import { RarePlants } from "./rareplants.js";
 import { BasePageRenderer } from "./basepagerenderer.js";
 import { GenericPage } from "./genericpage.js";
-
-const ENDANGERED_COLS = [ TAXA_LIST_COLS.SPECIES, TAXA_LIST_COLS.COMMON_NAME, TAXA_LIST_COLS.CESA, TAXA_LIST_COLS.FESA ];
-const RPI_COLUMNS = [ TAXA_LIST_COLS.SPECIES_BARE, TAXA_LIST_COLS.COMMON_NAME, TAXA_LIST_COLS.CNPS_RANK ];
+import { Files } from "./files.js";
+import { HTML } from "./html.js";
+
+const ENDANGERED_COLS = [
+    TAXA_LIST_COLS.SPECIES,
+    TAXA_LIST_COLS.COMMON_NAME,
+    TAXA_LIST_COLS.CESA,
+    TAXA_LIST_COLS.FESA,
+];
+const RPI_COLUMNS = [
+    TAXA_LIST_COLS.SPECIES_BARE,
+    TAXA_LIST_COLS.COMMON_NAME,
+    TAXA_LIST_COLS.CNPS_RANK,
+];
 
 class PageRenderer extends BasePageRenderer {
+    static render(outputDir, config, taxa) {
+        super.render(outputDir, taxa);
 
-    static render( outputDir, config, taxa ) {
-
-        super.render( outputDir, taxa );
-
-        this.renderLists( outputDir, config, taxa );
+        this.renderLists(outputDir, config, taxa);
 
         const taxonList = taxa.getTaxonList();
-        for ( const taxon of taxonList ) {
-            new PageTaxon( outputDir, config, taxon ).render();
+        for (const taxon of taxonList) {
+            new PageTaxon(outputDir, config, taxon).render();
         }
-
     }
 
-    static renderLists( outputDir, config, taxa ) {
-
-        function getListArray( listInfo, attributes = {}, columns ) {
-
+    static renderLists(outputDir, config, taxa) {
+        function getListArray(listInfo, attributes = {}, columns) {
             const listArray = [];
-            for ( const list of listInfo ) {
+            for (const list of listInfo) {
                 const listTaxa = [];
                 const calfloraTaxa = [];
                 const iNatTaxa = [];
-                for ( const taxon of taxa.getTaxonList() ) {
-                    if ( list.include( taxon ) ) {
-                        listTaxa.push( taxon );
-                        calfloraTaxa.push( taxon.getCalfloraName() );
-                        iNatTaxa.push( taxon.getINatName() );
+                for (const taxon of taxa.getTaxonList()) {
+                    if (list.include(taxon)) {
+                        listTaxa.push(taxon);
+                        calfloraTaxa.push(taxon.getCalfloraName());
+                        iNatTaxa.push(taxon.getINatName());
                     }
                 }
 
-                if ( listTaxa.length === 0 ) {
+                if (listTaxa.length === 0) {
                     continue;
                 }
 
-                Files.write( outputDir + "/calflora_" + list.filename + ".txt", calfloraTaxa.join( "\n" ) );
-                Files.write( outputDir + "/inat_" + list.filename + ".txt", iNatTaxa.join( "\n" ) );
+                Files.write(
+                    outputDir + "/calflora_" + list.filename + ".txt",
+                    calfloraTaxa.join("\n")
+                );
+                Files.write(
+                    outputDir + "/inat_" + list.filename + ".txt",
+                    iNatTaxa.join("\n")
+                );
 
                 const cols = columns ? columns : list.columns;
-                new PageTaxonList( outputDir, list.name, list.filename ).render( listTaxa, cols );
+                new PageTaxonList(outputDir, list.name, list.filename).render(
+                    listTaxa,
+                    cols
+                );
 
                 // Check for sublists.
-                const subListHTML = list.listInfo ? getListArray( list.listInfo, { class: "indent" }, cols ) : "";
-
-                listArray.push( HTML.getLink( "./" + list.filename + ".html", list.name ) + " (" + listTaxa.length + ")" + subListHTML );
+                const subListHTML = list.listInfo
+                    ? getListArray(list.listInfo, { class: "indent" }, cols)
+                    : "";
+
+                listArray.push(
+                    HTML.getLink("./" + list.filename + ".html", list.name) +
+                        " (" +
+                        listTaxa.length +
+                        ")" +
+                        subListHTML
+                );
             }
 
-            return renderList( listArray, attributes );
+            return renderList(listArray, attributes);
         }
 
-        function renderList( listsHTML, attributes = {} ) {
-            return HTML.wrap( "ul", HTML.arrayToLI( listsHTML ), attributes );
+        function renderList(listsHTML, attributes = {}) {
+            return HTML.wrap("ul", HTML.arrayToLI(listsHTML), attributes);
         }
 
-        function renderSection( title, listsHTML ) {
-            let html = "<div class=\"section\">";
-            html += HTML.textElement( "h2", title );
+        function renderSection(title, listsHTML) {
+            let html = '<div class="section">';
+            html += HTML.textElement("h2", title);
             html += listsHTML;
             html += "</div>";
             return html;
@@ -75,10 +97,22 @@ class PageRenderer extends BasePageRenderer {
             {
                 title: "All Species",
                 listInfo: [
-                    { name: config.getLabel( "native", "Native" ), filename: "list_native", include: ( t ) => t.isNative() },
-                    { name: config.getLabel( "introduced", "Introduced" ), filename: "list_introduced", include: ( t ) => !t.isNative() },
-                    { name: "All Plants", filename: "list_all", include: () => true },
-                ]
+                    {
+                        name: config.getLabel("native", "Native"),
+                        filename: "list_native",
+                        include: (t) => t.isNative(),
+                    },
+                    {
+                        name: config.getLabel("introduced", "Introduced"),
+                        filename: "list_introduced",
+                        include: (t) => !t.isNative(),
+                    },
+                    {
+                        name: "All Plants",
+                        filename: "list_all",
+                        include: () => true,
+                    },
+                ],
             },
             {
                 title: "Rare Plants",
@@ -86,101 +120,112 @@ class PageRenderer extends BasePageRenderer {
                     {
                         name: "CNPS Ranked Plants",
                         filename: "list_rpi",
-                        include: ( t ) => t.getRPIRank() !== undefined,
+                        include: (t) => t.getRPIRank() !== undefined,
                         columns: RPI_COLUMNS,
                         listInfo: [
                             {
-                                name: RarePlants.getRPIRankDescription( "1A" ),
+                                name: RarePlants.getRPIRankDescription("1A"),
                                 filename: "list_rpi_1a",
-                                include: ( t ) => t.getRPIRank() === "1A",
+                                include: (t) => t.getRPIRank() === "1A",
                             },
                             {
-                                name: RarePlants.getRPIRankDescription( "1B" ),
+                                name: RarePlants.getRPIRankDescription("1B"),
                                 filename: "list_rpi_1b",
-                                include: ( t ) => t.getRPIRank() === "1B",
+                                include: (t) => t.getRPIRank() === "1B",
                             },
                             {
-                                name: RarePlants.getRPIRankDescription( "2A" ),
+                                name: RarePlants.getRPIRankDescription("2A"),
                                 filename: "list_rpi_2a",
-                                include: ( t ) => t.getRPIRank() === "2A",
+                                include: (t) => t.getRPIRank() === "2A",
                             },
                             {
-                                name: RarePlants.getRPIRankDescription( "2B" ),
+                                name: RarePlants.getRPIRankDescription("2B"),
                                 filename: "list_rpi_2b",
-                                include: ( t ) => t.getRPIRank() === "2B",
+                                include: (t) => t.getRPIRank() === "2B",
                             },
                             {
-                                name: RarePlants.getRPIRankDescription( "3" ),
+                                name: RarePlants.getRPIRankDescription("3"),
                                 filename: "list_rpi_3",
-                                include: ( t ) => t.getRPIRank() === "3",
+                                include: (t) => t.getRPIRank() === "3",
                             },
                             {
-                                name: RarePlants.getRPIRankDescription( "4" ),
+                                name: RarePlants.getRPIRankDescription("4"),
                                 filename: "list_rpi_4",
-                                include: ( t ) => t.getRPIRank() === "4",
+                                include: (t) => t.getRPIRank() === "4",
                             },
-                        ]
+                        ],
                     },
                     {
                         name: "Endangered Species",
                         filename: "list_endangered",
-                        include: ( t ) => ( t.getCESA() || t.getFESA() ),
+                        include: (t) => t.getCESA() || t.getFESA(),
                         columns: ENDANGERED_COLS,
                     },
-                ]
+                ],
             },
         ];
 
-        let html = "<div class=\"wrapper\">";
-        for ( const section of sections ) {
+        let html = '<div class="wrapper">';
+        for (const section of sections) {
+            const listHTML = getListArray(
+                section.listInfo,
+                section.listInfo.columns
+            );
 
-            const listHTML = getListArray( section.listInfo, section.listInfo.columns );
-
-            if ( listHTML.length > 0 ) {
-                html += renderSection( section.title, listHTML );
+            if (listHTML.length > 0) {
+                html += renderSection(section.title, listHTML);
             }
-
         }
-        html += renderSection( "Taxonomy", renderList( [ HTML.getLink( "./list_families.html", "Plant Families" ) ] ) );
+        html += renderSection(
+            "Taxonomy",
+            renderList([HTML.getLink("./list_families.html", "Plant Families")])
+        );
 
         html += "</div>";
 
         // Write lists to includes directory so it can be inserted into pages.
-        Files.write( outputDir + "/_includes/plantlists.html", html );
-
+        Files.write(outputDir + "/_includes/plantlists.html", html);
     }
-
 }
 
 class PageTaxonList extends GenericPage {
-
-    constructor( outputDir, title, baseName ) {
-        super( outputDir, title, baseName );
+    constructor(outputDir, title, baseName) {
+        super(outputDir, title, baseName);
     }
 
-    render( taxa, columns ) {
-
+    render(taxa, columns) {
         let html = this.getDefaultIntro();
 
-        html += "<div class=\"wrapper\">";
+        html += '<div class="wrapper">';
 
-        html += "<div class=\"section\">";
-        html += Taxa.getHTMLTable( taxa, columns );
+        html += '<div class="section">';
+        html += Taxa.getHTMLTable(taxa, columns);
         html += "</div>";
 
-        html += "<div class=\"section\">";
-        html += HTML.textElement( "h2", "Download" );
+        html += '<div class="section">';
+        html += HTML.textElement("h2", "Download");
         html += "<ul>";
-        html += "<li>" + HTML.getLink( "./calflora_" + this.getBaseFileName() + ".txt", "Calflora List" ) + "</li>";
-        html += "<li>" + HTML.getLink( "./inat_" + this.getBaseFileName() + ".txt", "iNaturalist List" ) + "</li>";
+        html +=
+            "<li>" +
+            HTML.getLink(
+                "./calflora_" + this.getBaseFileName() + ".txt",
+                "Calflora List"
+            ) +
+            "</li>";
+        html +=
+            "<li>" +
+            HTML.getLink(
+                "./inat_" + this.getBaseFileName() + ".txt",
+                "iNaturalist List"
+            ) +
+            "</li>";
         html += "</ul>";
         html += "</div>";
 
         html += "</div>";
 
-        this.writeFile( html );
-
+        this.writeFile(html);
     }
 }
 
-export { PageRenderer };
+export { PageRenderer };

package/lib/plants/glossary.js

@@ -1,38 +1,34 @@
-import { Config, Files } from "@ca-plant-list/ca-plant-list";
+import { Config } from "../config.js";
+import { Files } from "../files.js";
 
 class Glossary {
-
     #srcPath;
     #srcEntries = [];
 
     constructor() {
-
         this.#srcPath = Config.getPackageDir() + "/data/glossary";
 
         // Find all entries in the glossary directory.
-        const entries = Files.getDirEntries( this.#srcPath ).sort();
-        for ( const entry of entries ) {
-            this.#srcEntries.push( new GlossaryEntry( this.#srcPath, entry ) );
+        const entries = Files.getDirEntries(this.#srcPath).sort();
+        for (const entry of entries) {
+            this.#srcEntries.push(new GlossaryEntry(this.#srcPath, entry));
         }
-
     }
 
     getEntries() {
         return this.#srcEntries;
     }
-
 }
 
 class GlossaryEntry {
-
     #srcPath;
     #fileName;
     #term;
 
-    constructor( srcPath, fileName ) {
+    constructor(srcPath, fileName) {
         this.#srcPath = srcPath;
         this.#fileName = fileName;
-        this.#term = fileName.split( "." )[ 0 ];
+        this.#term = fileName.split(".")[0];
     }
 
     getHTMLFileName() {
@@ -40,13 +36,12 @@ class GlossaryEntry {
     }
 
     getMarkdown() {
-        return Files.read( this.#srcPath + "/" + this.#fileName );
+        return Files.read(this.#srcPath + "/" + this.#fileName);
     }
 
     getTermName() {
         return this.#term;
     }
-
 }
 
-export { Glossary };
+export { Glossary };

package/lib/taxa.js

@@ -2,23 +2,25 @@ import { Config } from "./config.js";
 import { HTML } from "./html.js";
 import { CSV } from "./csv.js";
 import { RarePlants } from "./rareplants.js";
-import { ErrorLog, Families, Taxon } from "./index.js";
 import { Genera } from "./genera.js";
 import { TextUtils } from "./textutils.js";
+import { Taxon } from "./taxon.js";
+import { Families } from "./families.js";
 
 const FLOWER_COLORS = [
     { name: "white", color: "white" },
     { name: "red", color: "red" },
-    { name: "pink", color: "pink" },
+    { name: "pink", color: "#ff69b4" },
     { name: "orange", color: "orange" },
     { name: "yellow", color: "yellow" },
     { name: "blue", color: "blue" },
     { name: "purple", color: "purple" },
     { name: "green", color: "green" },
+    { name: "brown", color: "brown" },
 ];
 
 /**
- * @type {Object.<string,import("./index.js").TaxaCol>}
+ * @type {Object<string,{title:string,data:function (Taxon):string}>}
  */
 const TAXA_LIST_COLS = {
     CESA: {
@@ -97,14 +99,10 @@ class Taxa {
     #isSubset;
 
     /**
-     *
-     * @param {*} inclusionList
+     * @param {string[]|boolean} inclusionList
      * @param {ErrorLog} errorLog
-     * @param {*} showFlowerErrors
-     * @param {*} taxaMeta
-     * @param {*} taxonClass
-     * @param {*} extraTaxa
-     * @param {*} extraSynonyms
+     * @param {boolean} showFlowerErrors
+     * @param {Taxon} taxonClass
      */
     constructor(
         inclusionList,
@@ -161,7 +159,7 @@ class Taxa {
 
     /**
      * @param {Taxon[]} taxa
-     * @param {import("./index.js").TaxaCol[]} columns
+     * @param {TaxaCol} columns
      */
     static getHTMLTable(taxa, columns = DEFAULT_COLUMNS) {
         let html = "<table><thead>";
@@ -258,9 +256,7 @@ class Taxa {
     }
 
     /**
-     * @param {*} taxaCSV
-     * @param {*} inclusionList
-     * @param {*} taxaMeta
+     * @param {TaxonData[]} taxaCSV
      * @param {Taxon} taxonClass
      * @param {boolean} showFlowerErrors
      */
@@ -293,7 +289,10 @@ class Taxa {
                     const color = this.#flower_colors[colorName];
                     if (!color) {
                         throw new Error(
-                            'flower color "' + colorName + '" not found'
+                            'flower color "' +
+                                colorName +
+                                '" not found for ' +
+                                name
                         );
                     }
                     color.addTaxon(taxon);

package/lib/taxaloader.js

@@ -1,5 +1,7 @@
+import { CSV } from "./csv.js";
+import { Files } from "./files.js";
 import { GenericTaxaLoader } from "./generictaxaloader.js";
-import { CSV, Files, Taxa } from "./index.js";
+import { Taxa } from "./taxa.js";
 
 class TaxaLoader extends GenericTaxaLoader {
     /**

package/lib/taxon.js

@@ -1,7 +1,5 @@
-import { HTML } from "./index.js";
+import { HTML } from "./html.js";
 import { RarePlants } from "./rareplants.js";
-// eslint-disable-next-line no-unused-vars
-import { Genera } from "./genera.js";
 
 const TAXA_COLNAMES = {
     BLOOM_START: "bloom_start",
@@ -38,7 +36,7 @@ class Taxon {
     #synonyms = [];
 
     /**
-     * @param {import("./index.js").TaxonData} data
+     * @param {TaxonData} data
      * @param {Genera} genera
      */
     constructor(data, genera) {

package/lib/web/glossarypages.js

@@ -1,46 +1,60 @@
-import { Files, HTML } from "@ca-plant-list/ca-plant-list";
 import { Glossary } from "../plants/glossary.js";
 import { Markdown } from "../markdown.js";
+import { HTML } from "../html.js";
+import { Files } from "../files.js";
 
 const ENTRY_DIR = "g";
 
 class GlossaryPages {
-
     #siteGenerator;
     #glossary;
 
-    constructor( siteGenerator ) {
+    constructor(siteGenerator) {
         this.#siteGenerator = siteGenerator;
         this.#glossary = new Glossary();
     }
 
-    #generateEntryPage( entry ) {
+    #generateEntryPage(entry) {
         const title = entry.getTermName();
-        let html = HTML.textElement( "h1", title );
-        html += HTML.wrap( "div", Markdown.strToHTML( entry.getMarkdown() ), { class: "glossary" } );
-        this.#siteGenerator.writeTemplate( html, { title: title }, Files.join( ENTRY_DIR, title + ".html" ) );
+        let html = HTML.textElement("h1", title);
+        html += HTML.wrap("div", Markdown.strToHTML(entry.getMarkdown()), {
+            class: "glossary",
+        });
+        this.#siteGenerator.writeTemplate(
+            html,
+            { title: title },
+            Files.join(ENTRY_DIR, title + ".html")
+        );
     }
 
     #generateEntryPages() {
-
         // Make sure output directory exists.
-        this.#siteGenerator.mkdir( ENTRY_DIR );
+        this.#siteGenerator.mkdir(ENTRY_DIR);
 
         const entries = this.#glossary.getEntries();
-        for ( const entry of entries ) {
-            this.#generateEntryPage( entry );
+        for (const entry of entries) {
+            this.#generateEntryPage(entry);
         }
     }
 
     #generateIndexPage() {
         const links = [];
         const entries = this.#glossary.getEntries();
-        for ( const entry of entries ) {
-            links.push( HTML.getLink( Files.join( ENTRY_DIR, entry.getHTMLFileName() ), entry.getTermName() ) );
+        for (const entry of entries) {
+            links.push(
+                HTML.getLink(
+                    Files.join(ENTRY_DIR, entry.getHTMLFileName()),
+                    entry.getTermName()
+                )
+            );
         }
-        let html = HTML.wrap( "h1", "Glossary" );
-        html += HTML.wrap( "ol", HTML.arrayToLI( links ) );
-        this.#siteGenerator.writeTemplate( html, { title: "Glossary" }, "glossary.html" );
+        let html = HTML.wrap("h1", "Glossary");
+        html += HTML.wrap("ol", HTML.arrayToLI(links));
+        this.#siteGenerator.writeTemplate(
+            html,
+            { title: "Glossary" },
+            "glossary.html"
+        );
     }
 
     getGlossary() {
@@ -51,7 +65,6 @@ class GlossaryPages {
         this.#generateIndexPage();
         this.#generateEntryPages();
     }
-
 }
 
-export { GlossaryPages };
+export { GlossaryPages };

package/lib/web/pagetaxon.js

@@ -42,16 +42,6 @@ class PageTaxon extends GenericPage {
         if (rpiLink) {
             links.push(rpiLink);
         }
-        if (this.#taxon.isNative()) {
-            links.push(
-                HTML.getLink(
-                    ExternalSites.getCalscapeLink(this.#taxon.getName()),
-                    "Calscape",
-                    undefined,
-                    true
-                )
-            );
-        }
         return links;
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ca-plant-list/ca-plant-list",
-    "version": "0.3.5",
+    "version": "0.3.7",
     "description": "Tools to create Jekyll files for a website listing plants in an area of California.",
     "license": "MIT",
     "repository": {
@@ -12,7 +12,6 @@
     "exports": {
         ".": "./lib/index.js"
     },
-    "types": "./lib/index.d.ts",
     "bin": {
         "ca-plant-list": "scripts/build-site.js",
         "ca-plant-book": "scripts/build-ebook.js"
@@ -36,4 +35,4 @@
         "eslint": "^8.26.0",
         "typescript": "^5.3.3"
     }
-}
+}

package/scripts/build-ebook.js

@@ -1,8 +1,8 @@
 #!/usr/bin/env node
 
-import { PlantBook } from "@ca-plant-list/ca-plant-list";
 import { Config } from "../lib/config.js";
 import { Files } from "../lib/files.js";
+import { PlantBook } from "../lib/ebook/plantbook.js";
 import { TaxaProcessor } from "../lib/taxaprocessor.js";
 import { CommandProcessor } from "../lib/commandprocessor.js";