@ca-plant-list/ca-plant-list 0.1.9 → 0.1.11

package/jekyll/assets/js/name_search.js

@@ -1,3 +1,5 @@
+import { Utils } from "./utils.js";
+
 const MIN_LEN = 2;
 const MAX_RESULTS = 50;
 
@@ -75,9 +77,7 @@ class Search {
                 const name = match[ 0 ];
                 const syn = match[ 2 ];
                 const td1 = document.createElement( "td" );
-                const link = document.createElement( "a" );
-                link.setAttribute( "href", "./" + name.replaceAll( ".", "" ).replaceAll( " ", "-" ) + ".html" );
-                link.textContent = name;
+                const link = Utils.domTaxonLink( name );
                 td1.appendChild( link );
                 if ( syn ) {
                     td1.appendChild( document.createTextNode( " (" + syn + ")" ) );

package/jekyll/assets/js/utils.js

@@ -0,0 +1,26 @@
+class Utils {
+
+    static domElement( name, attributes = {}, content ) {
+        const e = document.createElement( name );
+        for ( const [ k, v ] of Object.entries( attributes ) ) {
+            e.setAttribute( k, v );
+        }
+        if ( content ) {
+            e.textContent = content;
+        }
+        return e;
+    }
+
+    static domLink( href, text, attributes = {} ) {
+        const e = this.domElement( "a", Object.assign( { href: href }, attributes ) );
+        e.textContent = text;
+        return e;
+    }
+
+    static domTaxonLink( name ) {
+        return this.domLink( "./" + name.replaceAll( ".", "" ).replaceAll( " ", "-" ) + ".html", name );
+    }
+
+}
+
+export { Utils };

package/lib/families.js

@@ -1,8 +1,8 @@
-import * as fs from "node:fs";
 import { HTMLPage } from "./htmlpage.js";
 import { HTML } from "./html.js";
 import { Jepson } from "./jepson.js";
 import { Taxa } from "./taxa.js";
+import { Files } from "./files.js";
 
 class Families {
 
@@ -13,7 +13,7 @@ class Families {
     }
 
     static init( dataDir ) {
-        this.#families = JSON.parse( fs.readFileSync( dataDir + "/families.json" ) );
+        this.#families = JSON.parse( Files.read( dataDir + "/families.json" ) );
         for ( const [ k, v ] of Object.entries( this.#families ) ) {
             this.#families[ k ] = new Family( k, { id: v } );
         }

package/lib/files.js

@@ -25,6 +25,10 @@ class Files {
         fs.writeFileSync( targetFileName, Buffer.from( buffer ) );
     }
 
+    static mkdir( path ) {
+        fs.mkdirSync( path, { recursive: true } );
+    }
+
     static read( path ) {
         return fs.readFileSync( path, "utf8" );
     }

package/lib/html.js

@@ -38,7 +38,7 @@ export class HTML {
     static #getElement( elName, text, attributes, escape ) {
         let html = "<" + elName;
         html += this.renderAttributes( attributes );
-        if ( escape ) {
+        if ( escape && ( typeof text === "string" ) ) {
             text = this.escapeText( text );
         }
         html += ">" + text + "</" + elName + ">";
@@ -57,6 +57,11 @@ export class HTML {
         return html + ">" + this.escapeText( linkText ) + "</a >";
     }
 
+    static getToolTip( text, tooltip ) {
+        const func = text.charAt( 0 ) === "<" ? HTML.wrap : HTML.textElement;
+        return func( "span", text + " ⓘ", { title: tooltip } );
+    }
+
     static renderAttribute( n, v ) {
         return " " + n + "=\"" + this.escapeAttribute( v ) + "\"";
     }
@@ -70,11 +75,11 @@ export class HTML {
     }
 
     static textElement( elName, text, attributes = {} ) {
-        return this.#getElement( elName, text, attributes, true );
+        return HTML.#getElement( elName, text, attributes, true );
     }
 
     static wrap( elName, text, attributes = {} ) {
-        return this.#getElement( elName, text, attributes, false );
+        return HTML.#getElement( elName, text, attributes, false );
     }
 
 }

package/lib/index.d.ts

@@ -2,6 +2,7 @@ export class Files {
     static createFileFromStream(fileName: any, inStream: any): Promise<any>;
     static exists(path: any): boolean;
     static fetch(url: any, targetFileName: any): Promise<void>;
+    static mkdir(path: any): void;
     static read(path: any): string;
     static write(path: any, data: any): void;
     static zipFileExtract(zipFilePath: any, fileNameToUnzip: any, targetFilePath: any): Promise<void>;
@@ -21,6 +22,7 @@ export class HTML {
     static getElement(elName: any, text: any, attributes?: {}, options?: number): string;
     static "__#2@#getElement"(elName: any, text: any, attributes: any, escape: any): string;
     static getLink(href: any, linkText: any, attributes?: {}, options?: number): string;
+    static getToolTip(text: any, tooltip: any): string;
     static renderAttribute(n: any, v: any): string;
     static renderAttributes(attributes: any): string;
     static textElement(elName: any, text: any, attributes?: {}): string;
@@ -29,4 +31,5 @@ export class HTML {
 export class Jekyll {
     static hasInclude(baseDir: any, path: any): boolean;
     static include(path: any): string;
+    static writeInclude(baseDir: any, path: any, data: any): void;
 }

package/lib/index.js

@@ -4,10 +4,11 @@ import { CSV } from "./csv.js";
 import { DataLoader } from "./dataloader.js";
 import { ErrorLog } from "./errorlog.js";
 import { Exceptions } from "./exceptions.js";
+import { Families } from "./families.js";
 import { Files } from "./files.js";
 import { HTML, HTML_OPTIONS } from "./html.js";
 import { Jekyll } from "./jekyll.js";
 import { Taxa } from "./taxa.js";
 import { Taxon } from "./taxon.js";
 
-export { BasePageRenderer, Config, CSV, DataLoader, ErrorLog, Exceptions, Files, HTML, HTML_OPTIONS, Jekyll, Taxa, Taxon };
+export { BasePageRenderer, Config, CSV, DataLoader, ErrorLog, Exceptions, Families, Files, HTML, HTML_OPTIONS, Jekyll, Taxa, Taxon };

package/lib/jekyll.js

@@ -7,7 +7,12 @@ class Jekyll {
     }
 
     static include( path ) {
-        return "{%include " + path + "%}";
+        // This works for .md includes; should have conditional logic to detect other types.
+        return "{% capture my_include %}{% include " + path + " %}{% endcapture %}{{ my_include | markdownify }}";
+    }
+
+    static writeInclude( baseDir, path, data ) {
+        Files.write( baseDir + "/_includes/" + path, data );
     }
 
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ca-plant-list/ca-plant-list",
-    "version": "0.1.9",
+    "version": "0.1.11",
     "description": "Tools to create Jekyll files for a website listing plants in an area of California.",
     "license": "MIT",
     "repository": {