npm - @ca-plant-list/ca-plant-list - Versions diffs - 0.0.0 - Mend

@ca-plant-list/ca-plant-list 0.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (24) hide show

package/README.md +1 -0
package/build-site.js +19 -0
package/data/families.json +199 -0
package/data/genera.json +5562 -0
package/jekyll/_layouts/html.html +49 -0
package/jekyll/assets/css/main.css +64 -0
package/jekyll/assets/js/common_name_search.js +87 -0
package/jekyll/common_name_search.html +18 -0
package/jekyll/index.md +3 -0
package/jekyll/index_lists.md +7 -0
package/lib/config.js +31 -0
package/lib/csv.js +41 -0
package/lib/dataloader.js +19 -0
package/lib/errorlog.js +17 -0
package/lib/families.js +129 -0
package/lib/genera.js +55 -0
package/lib/html.js +54 -0
package/lib/htmlpage.js +18 -0
package/lib/jepson.js +18 -0
package/lib/pagerenderer.js +120 -0
package/lib/pagetaxon.js +154 -0
package/lib/taxa.js +86 -0
package/lib/taxon.js +116 -0
package/package.json +16 -0

package/jekyll/_layouts/html.html ADDED Viewed

@@ -0,0 +1,49 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.2.0/dist/css/bootstrap.min.css" rel="stylesheet"
+        integrity="sha384-gH2yIJqKdNHPEq0n4Mqa/HGKIhSkIHeL5AyhkYV8i59U5AR6csBvApHHNl/vI1Bx" crossorigin="anonymous">
+    <title>{{page.title}}</title>
+    <link href="{{site.baseurl}}/assets/css/main.css" rel="stylesheet">
+</head>
+<body>
+    <nav class="navbar navbar-expand-md">
+        <div class="container-xxl px-5">
+            <button id="hamburger" class="navbar-toggler" type="button" data-bs-toggle="collapse"
+                data-bs-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false"
+                aria-label="Toggle navigation">
+                <span class="navbar-toggler-icon"></span>
+            </button>
+            <a class="navbar-brand" href="{{'/' | relative_url}}">{{site.navbar-name}}</a>
+            <div class="collapse navbar-collapse" id="navbarSupportedContent">
+                <ul class="navbar-nav me-auto mb-lg-0">
+                    <li class="nav-item">
+                        <a class="nav-link" href="{{site.baseurl}}/index_lists.html">Plant Lists</a>
+                    </li>
+                    <li class="nav-item">
+                        <a class="nav-link" href="{{site.baseurl}}/common_name_search.html">Common Name Search</a>
+                    </li>
+                </ul>
+            </div>
+        </div>
+    </nav>
+    <div class="container-xxl px-5">
+        {{content}}
+    </div>
+    <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.2.0/dist/js/bootstrap.bundle.min.js"
+        integrity="sha384-A3rJD856KowSb7dwlZdYEkO39Gagi7vIsF0jrRAoQmDKKtQBHUuLZ9AsSv4jD4Xa"
+        crossorigin="anonymous"></script>
+    {%if page.js%}
+    <script src="{{site.baseurl}}/assets/js/{{page.js}}" type="module"></script>{%endif%}
+</body>
+</html>

package/jekyll/assets/css/main.css ADDED Viewed

@@ -0,0 +1,64 @@
+/* Defaults */
+:root {
+    --bs-body-bg: #ECF87F;
+}
+.navbar-nav {
+    --bs-nav-link-hover-color: rgba(255, 255, 255, .5);
+}
+.navbar {
+    --bs-navbar-toggler-icon-bg: url("data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 30 30'%3e%3cpath stroke='white' stroke-linecap='round' stroke-miterlimit='10' stroke-width='2' d='M4 7h22M4 15h22M4 23h22'/%3e%3c/svg%3e");
+    --bs-navbar-color: white;
+    --bs-navbar-brand-hover-color: rgba(255, 255, 255, .5);
+    --bs-navbar-brand-color: white;
+    background-color: #3D550C;
+}
+td {
+    border: solid 1px;
+    vertical-align: top;
+}
+th {
+    vertical-align: bottom;
+}
+/* Lists */
+a.native {
+    font-weight: bold;
+    font-style: italic;
+}
+/* Taxon Page */
+.common-names {
+    font-size: larger;
+    font-weight: bold;
+}
+div.wrapper {
+    display: flex;
+    flex-wrap: wrap;
+    column-gap: 4rem;
+}
+div.section {
+    margin-bottom: .5rem;
+    ;
+}
+div.section h2 {
+    font-size: 1.25rem;
+}
+div.section ul {
+    margin: 0;
+    padding: 0;
+}
+div.section li {
+    display: block;
+}

package/jekyll/assets/js/common_name_search.js ADDED Viewed

@@ -0,0 +1,87 @@
+const MIN_LEN = 2;
+const MAX_RESULTS = 50;
+class Search {
+    static #debounceTimer;
+    static #debounce( func ) {
+        clearTimeout( this.#debounceTimer );
+        this.#debounceTimer = setTimeout( func, 500 );
+    }
+    static #doSearch() {
+        Search.#debounceTimer = undefined;
+        const value = document.getElementById( "common-name" ).value.toLowerCase();
+        const matches = [];
+        const shouldSearch = ( value.length >= MIN_LEN );
+        if ( shouldSearch ) {
+            // eslint-disable-next-line no-undef
+            for ( const key of Object.keys( COMMON_NAMES ) ) {
+                if ( key.includes( value ) ) {
+                    matches.push( key );
+                }
+            }
+        }
+        const eBody = document.createElement( "tbody" );
+        if ( matches.length <= MAX_RESULTS ) {
+            for ( const match of matches ) {
+                // eslint-disable-next-line no-undef
+                const data = COMMON_NAMES[ match ];
+                for ( const name of data.names ) {
+                    const tr = document.createElement( "tr" );
+                    const td1 = document.createElement( "td" );
+                    const td2 = document.createElement( "td" );
+                    const link = document.createElement( "a" );
+                    td1.textContent = data.cn;
+                    link.setAttribute( "href", "./" + name.replaceAll( ".", "" ).replaceAll( " ", "-" ) + ".html" );
+                    link.textContent = name;
+                    td2.appendChild( link );
+                    tr.appendChild( td1 );
+                    tr.appendChild( td2 );
+                    eBody.appendChild( tr );
+                }
+            }
+        }
+        // Delete current message
+        const eMessage = document.getElementById( "message" );
+        if ( eMessage.firstChild ) {
+            eMessage.removeChild( eMessage.firstChild );
+        }
+        if ( shouldSearch ) {
+            if ( matches.length === 0 ) {
+                eMessage.textContent = "Nothing found.";
+            }
+            if ( matches.length > MAX_RESULTS ) {
+                eMessage.textContent = "Too many results.";
+            }
+        }
+        // Delete current results
+        const eTable = document.getElementById( "results" );
+        if ( eTable.firstChild ) {
+            eTable.removeChild( eTable.firstChild );
+        }
+        eTable.appendChild( eBody );
+    }
+    static #handleChange() {
+        this.#debounce( Search.#doSearch );
+    }
+    static init() {
+        const eName = document.getElementById( "common-name" );
+        eName.focus();
+        eName.oninput = ( ev ) => { return this.#handleChange( ev ); };
+    }
+}
+Search.init();

package/jekyll/common_name_search.html ADDED Viewed

@@ -0,0 +1,18 @@
+---
+title: Common Name Search
+js: common_name_search.js
+---
+<h1>Search for Common Name</h1>
+<script>
+    const COMMON_NAMES = {% include common_names.json%};
+</script>
+<form>
+    <input type="text" id="common-name">
+</form>
+<div class="section" id="message"></div>
+<table id="results">
+</table>

package/jekyll/index.md ADDED Viewed

@@ -0,0 +1,3 @@
+---
+title: HOME PAGE
+---

package/jekyll/index_lists.md ADDED Viewed

@@ -0,0 +1,7 @@
+---
+title: Plant Lists
+---
+# Plant Lists
+Species:
+{%include plantlists.html%}

package/lib/config.js ADDED Viewed

@@ -0,0 +1,31 @@
+import * as fs from "node:fs";
+class Config {
+    static #config = {};
+    static getConfigValue( prefix, name, dflt ) {
+        const obj = this.#config[ prefix ];
+        if ( obj ) {
+            if ( Object.hasOwn( obj, name ) ) {
+                return obj[ name ];
+            }
+        }
+        return dflt;
+    }
+    static getLabel( name, dflt ) {
+        return this.getConfigValue( "labels", name, dflt );
+    }
+    static init( dir ) {
+        try {
+            this.#config = JSON.parse( fs.readFileSync( dir + "/config.json" ) );
+        } catch ( e ) {
+            console.log( e );
+        }
+    }
+}
+export { Config };

package/lib/csv.js ADDED Viewed

@@ -0,0 +1,41 @@
+import * as fs from "node:fs";
+import { parse } from "csv-parse/sync";
+import path from "node:path";
+class CSV {
+    static getMap( dir, fileName ) {
+        let headers;
+        function setHeaders( h ) {
+            headers = h;
+            return h;
+        }
+        const csv = this.parseFile( dir, fileName, setHeaders );
+        const map = {};
+        for ( const row of csv ) {
+            map[ row[ headers[ 0 ] ] ] = row[ headers[ 1 ] ];
+        }
+        return map;
+    }
+    static parseFile( dir, fileName, columns = true, delimiter ) {
+        const content = fs.readFileSync( dir + "/" + fileName );
+        const options = { relax_column_count_less: true };
+        options.columns = columns;
+        if ( path.extname( fileName ) === ".tsv" ) {
+            options.delimiter = "\t";
+            options.quote = false;
+        } else {
+            options.delimiter = delimiter ? delimiter : ",";
+        }
+        return parse( content, options );
+    }
+}
+export { CSV };

package/lib/dataloader.js ADDED Viewed

@@ -0,0 +1,19 @@
+import { Taxa } from "./taxa.js";
+import { Genera } from "./genera.js";
+import { Families } from "./families.js";
+class DataLoader {
+    static load( taxaDir, dataDir ) {
+        console.log( "loading data" );
+        Families.init( dataDir );
+        Genera.init( dataDir );
+        Taxa.init( taxaDir );
+    }
+}
+export { DataLoader };

package/lib/errorlog.js ADDED Viewed

@@ -0,0 +1,17 @@
+import * as fs from "node:fs";
+class ErrorLog {
+    static #errors = [];
+    static log( ...args ) {
+        this.#errors.push( args.join( "\t" ) );
+    }
+    static write( fileName ) {
+        fs.writeFileSync( fileName, this.#errors.join( "\n" ) );
+    }
+}
+export { ErrorLog };

package/lib/families.js ADDED Viewed

@@ -0,0 +1,129 @@
+import * as fs from "node:fs";
+import { HTMLPage } from "./htmlpage.js";
+import { HTML, HTML_OPTIONS } from "./html.js";
+import { Jepson } from "./jepson.js";
+import { Taxa } from "./taxa.js";
+class Families {
+    static #families;
+    static getFamily( familyName ) {
+        return this.#families[ familyName ];
+    }
+    static init( dataDir ) {
+        this.#families = JSON.parse( fs.readFileSync( dataDir + "/families.json" ) );
+        for ( const [ k, v ] of Object.entries( this.#families ) ) {
+            this.#families[ k ] = new Family( k, { id: v } );
+        }
+    }
+    static renderPages( outputDir ) {
+        new PageFamilyList( Object.values( this.#families ) ).render( outputDir );
+        for ( const family of Object.values( this.#families ) ) {
+            if ( family.getTaxa() ) {
+                new PageFamily( family ).render( outputDir );
+            }
+        }
+    }
+}
+class PageFamilyList extends HTMLPage {
+    #families;
+    constructor( families ) {
+        super();
+        this.#families = families;
+    }
+    render( outputDir ) {
+        const title = "Families";
+        let html = this.getFrontMatter( title );
+        html += HTML.getElement( "h1", title );
+        html += "<ul>";
+        for ( const family of this.#families ) {
+            const taxa = family.getTaxa();
+            if ( taxa ) {
+                const link = HTML.getLink( "./" + family.getFileName(), family.getName() );
+                html += "<li>" + link + " (" + taxa.length + ")" + "</li>";
+            }
+        }
+        html += "</ul>";
+        this.writeFile( outputDir, "list_families.html", html );
+    }
+}
+class PageFamily extends HTMLPage {
+    #family;
+    constructor( family ) {
+        super();
+        this.#family = family;
+    }
+    render( outputDir ) {
+        let html = this.getFrontMatter( this.#family.getName() );
+        html += HTML.getElement( "h1", this.#family.getName() );
+        html += HTML.getElement(
+            "div",
+            Jepson.getEFloraLink( this.#family.getJepsonID() ),
+            { class: "section" },
+            HTML_OPTIONS.NO_ESCAPE
+        );
+        html += Taxa.getHTMLTable( this.#family.getTaxa() );
+        this.writeFile( outputDir, this.#family.getFileName(), html );
+    }
+}
+class Family {
+    #name;
+    #data;
+    constructor( name, data ) {
+        this.#name = name;
+        this.#data = data;
+    }
+    addTaxon( taxon ) {
+        if ( !this.#data.taxa ) {
+            this.#data.taxa = [];
+        }
+        this.#data.taxa.push( taxon );
+    }
+    getFileName( ext = "html" ) {
+        return this.getName() + "." + ext;
+    }
+    getJepsonID() {
+        return this.#data.id;
+    }
+    getName() {
+        return this.#name;
+    }
+    getTaxa() {
+        return this.#data.taxa;
+    }
+}
+export { Families };

package/lib/genera.js ADDED Viewed

@@ -0,0 +1,55 @@
+import * as fs from "node:fs";
+import { Families } from "./families.js";
+class Genera {
+    static #genera;
+    static addTaxon( taxon ) {
+        const genusName = taxon.getGenusName();
+        const genusData = this.#genera[ genusName ];
+        if ( genusData.taxa === undefined ) {
+            genusData.taxa = [];
+        }
+        genusData.taxa.push( taxon );
+        const family = this.getFamily( genusName );
+        if ( !family ) {
+            console.log( taxon.getName() + " genus/family not found" );
+            return;
+        }
+        family.addTaxon( taxon );
+    }
+    static getGenus( genusName ) {
+        return new Genus( this.#genera[ genusName ] );
+    }
+    static getFamily( genusName ) {
+        const genus = this.#genera[ genusName ];
+        if ( genus ) {
+            return Families.getFamily( genus.family );
+        }
+    }
+    static init( dataDir ) {
+        this.#genera = JSON.parse( fs.readFileSync( dataDir + "/genera.json" ) );
+    }
+}
+class Genus {
+    #data;
+    constructor( data ) {
+        this.#data = data;
+    }
+    getTaxa() {
+        return this.#data.taxa;
+    }
+}
+export { Genera };

package/lib/html.js ADDED Viewed

@@ -0,0 +1,54 @@
+const HTML_OPTIONS = {
+    OPEN_NEW: 1,
+    NO_ESCAPE: 2,
+};
+class HTML {
+    static arrayToLI( items ) {
+        return items.reduce( ( itemHTML, currVal ) => itemHTML + "<li>" + currVal + "</li>", "" );
+    }
+    static escapeAttribute( value ) {
+        return value.replaceAll( "\"", "&quot;" );
+    }
+    static escapeText( text ) {
+        return text.replaceAll( "&", "&amp;" ).replaceAll( "<", "&lt;" ).replaceAll( ">", "&gt;" );
+    }
+    static getElement( elName, text, attributes = {}, options = 0 ) {
+        let html = "<" + elName;
+        html += this.renderAttributes( attributes );
+        if ( !( options & HTML_OPTIONS.NO_ESCAPE ) ) {
+            text = this.escapeText( text );
+        }
+        html += ">" + text + "</" + elName + ">";
+        return html;
+    }
+    static getLink( href, linkText, attributes = {}, options = 0 ) {
+        let html = "<a href=\"" + this.escapeAttribute( href ) + "\"";
+        html += this.renderAttributes( attributes );
+        if ( options & HTML_OPTIONS.OPEN_NEW ) {
+            html += this.renderAttribute( "target", "_blank" );
+        }
+        return html + ">" + this.escapeText( linkText ) + "</a >";
+    }
+    static renderAttribute( n, v ) {
+        return " " + n + "=\"" + this.escapeAttribute( v ) + "\"";
+    }
+    static renderAttributes( attributes ) {
+        let html = "";
+        for ( const [ k, v ] of Object.entries( attributes ) ) {
+            html += this.renderAttribute( k, v );
+        }
+        return html;
+    }
+}
+export { HTML, HTML_OPTIONS };

package/lib/htmlpage.js ADDED Viewed

@@ -0,0 +1,18 @@
+import * as fs from "node:fs";
+class HTMLPage {
+    getFrontMatter( title, js ) {
+        return "---\n"
+            + "title: \"" + title + "\"\n"
+            + ( js ? ( "js: " + js + "\n" ) : "" )
+            + "---\n";
+    }
+    writeFile( outputDir, fileName, html ) {
+        fs.writeFileSync( outputDir + "/" + fileName, html );
+    }
+}
+export { HTMLPage };

package/lib/jepson.js ADDED Viewed

@@ -0,0 +1,18 @@
+import { HTML, HTML_OPTIONS } from "./html.js";
+class Jepson {
+    static getEFloraLink( id ) {
+        return HTML.getLink(
+            "https://ucjeps.berkeley.edu/eflora/eflora_display.php?tid=" + id,
+            "Jepson eFlora",
+            {},
+            HTML_OPTIONS.OPEN_NEW
+        );
+    }
+}
+export { Jepson };