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

package/lib/taxa.js

@@ -2,14 +2,15 @@ import { Config } from "./config.js";
 import { HTML } from "./html.js";
 import { CSV } from "./csv.js";
 import { RarePlants } from "./rareplants.js";
-import { 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" },
@@ -19,7 +20,7 @@ const FLOWER_COLORS = [
 ];
 
 /**
- * @type {Object.<string,import("./index.js").TaxaCol>}
+ * @type {Object<string,{title:string,data:function (Taxon):string}>}
  */
 const TAXA_LIST_COLS = {
     CESA: {
@@ -98,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,
@@ -162,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>";
@@ -259,7 +256,7 @@ class Taxa {
     }
 
     /**
-     * @param {import("./index.js").TaxonData[]} taxaCSV
+     * @param {TaxonData[]} taxaCSV
      * @param {Taxon} taxonClass
      * @param {boolean} showFlowerErrors
      */

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/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ca-plant-list/ca-plant-list",
-    "version": "0.3.6",
+    "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"

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";
 

package/scripts/build-site.js

@@ -2,54 +2,64 @@
 
 import * as child_process from "node:child_process";
 import * as path from "node:path";
-import { Files } from "@ca-plant-list/ca-plant-list";
 import { Config } from "../lib/config.js";
 import { PageRenderer } from "../lib/pagerenderer.js";
 import { CommandAndTaxaProcessor } from "../lib/commandandtaxaprocessor.js";
+import { Files } from "../lib/files.js";
 
 class JekyllRenderer {
-
     #srcDir = "./output";
     #destDir = "./public";
 
     async renderPages() {
-
-        function addConfigFile( configFiles, dir, name ) {
-            const fullPath = path.join( dir, name );
-            if ( Files.exists( fullPath ) ) {
-                configFiles.push( fullPath );
+        function addConfigFile(configFiles, dir, name) {
+            const fullPath = path.join(dir, name);
+            if (Files.exists(fullPath)) {
+                configFiles.push(fullPath);
             }
         }
 
         // Remove existing files.
-        Files.rmDir( this.#destDir );
+        Files.rmDir(this.#destDir);
 
-        const options = [ "--source", this.#srcDir, "--destination", this.#destDir ];
+        const options = [
+            "--source",
+            this.#srcDir,
+            "--destination",
+            this.#destDir,
+        ];
 
         // Find out what config files are available.
         const configFiles = [];
-        addConfigFile( configFiles, this.#srcDir, "_config.yml" );
-        addConfigFile( configFiles, this.#srcDir, "_config-local.yml" );
-        addConfigFile( configFiles, ".", "_config-dev.yml" );
-        options.push( "--config", "\"" + configFiles.join() + "\"" );
-
-        const result = child_process.execSync( "bundle exec jekyll build " + options.join( " " ) );
-        console.log( result.toString() );
+        addConfigFile(configFiles, this.#srcDir, "_config.yml");
+        addConfigFile(configFiles, this.#srcDir, "_config-local.yml");
+        addConfigFile(configFiles, ".", "_config-dev.yml");
+        options.push("--config", '"' + configFiles.join() + '"');
+
+        const result = child_process.execSync(
+            "bundle exec jekyll build " + options.join(" ")
+        );
+        console.log(result.toString());
     }
-
 }
 
-async function generateSite( taxaProcessor ) {
-
+async function generateSite(taxaProcessor) {
     const options = taxaProcessor.getOptions();
 
-    PageRenderer.render( options.outputdir, new Config( options.datadir ), taxaProcessor.getTaxa() );
+    PageRenderer.render(
+        options.outputdir,
+        new Config(options.datadir),
+        taxaProcessor.getTaxa()
+    );
 
-    console.log( "generating site" );
+    console.log("generating site");
     const r = new JekyllRenderer();
     await r.renderPages();
-
 }
 
-const gen = new CommandAndTaxaProcessor( "ca-plant-list", "A tool to generate a website with local plant data.", generateSite );
-await gen.process( generateSite );
+const gen = new CommandAndTaxaProcessor(
+    "ca-plant-list",
+    "A tool to generate a website with local plant data.",
+    generateSite
+);
+await gen.process(generateSite);

package/types/classes.d.ts

@@ -0,0 +1,26 @@
+declare class ErrorLog {
+    log(...args: string[]): void;
+}
+
+declare class Families {}
+
+declare class Genera {}
+
+declare class Taxon {
+    constructor(data: TaxonData, genera: Genera, meta: any);
+    getBloomEnd(): number;
+    getBloomStart(): number;
+    getCESA(): string;
+    getCommonNames(): string[];
+    getFESA(): string;
+    getFileName(): string;
+    getFlowerColors(): string[];
+    getHTMLLink(
+        href: boolean | string | undefined,
+        includeRPI: boolean
+    ): string;
+    getLifeCycle(): string;
+    getName(): string;
+    getRPIRankAndThreat(): string;
+    getRPIRankAndThreatTooltip(): string;
+}