@ca-plant-list/ca-plant-list 0.2.5 → 0.2.7

package/lib/index.d.ts

@@ -12,7 +12,7 @@ export class Config {
 }
 export class CSV {
     static getMap(dir: any, fileName: any): {};
-    static "__#8@#getOptions"(fileName: any, columns: any, delimiter: any): {
+    static "__#9@#getOptions"(fileName: any, columns: any, delimiter: any): {
         relax_column_count_less: boolean;
     };
     static parseFile(dir: any, fileName: any, columns: boolean, delimiter: any): any;
@@ -28,19 +28,19 @@ export class DataLoader {
     static load(options: any): void;
 }
 export class ErrorLog {
-    static "__#7@#errors": any[];
+    static "__#8@#errors": any[];
     static log(...args: any[]): void;
     static write(fileName: any): void;
 }
 export class Exceptions {
-    static "__#17@#exceptions": {};
+    static "__#21@#exceptions": {};
     static getExceptions(): [string, any][];
     static getValue(name: any, cat: any, subcat: any, defaultValue: any): any;
     static hasException(name: any, cat: any, subcat: any): boolean;
     static init(dir: any): void;
 }
 export class Families {
-    static "__#11@#families": any;
+    static "__#12@#families": any;
     static getFamilies(): any[];
     static getFamily(familyName: any): any;
     static init(): void;
@@ -67,7 +67,7 @@ export class Files {
     static zipFileExtract(zipFilePath: any, fileNameToUnzip: any, targetFilePath: any): Promise<void>;
 }
 export class Genera {
-    static "__#4@#genera": any;
+    static "__#5@#genera": any;
     static addTaxon(taxon: any): void;
     static getGenus(genusName: any): Genus;
     static getFamily(genusName: any): any;
@@ -101,7 +101,7 @@ export class HTML {
      * @deprecated
      */
     static getElement(elName: any, text: any, attributes?: {}, options?: number): string;
-    static "__#3@#getElement"(elName: any, text: any, attributes: any, escape: any): string;
+    static "__#4@#getElement"(elName: any, text: any, attributes: any, escape: any): string;
     /**
      * Generate HTML for an &lt;a> element.
      * @param {string|undefined} href
@@ -143,6 +143,7 @@ import { TAXA_COLNAMES } from "./taxon.js";
 import { Taxon } from "./taxon.js";
 export { BasePageRenderer, Config, CSV, DataLoader, ErrorLog, Exceptions, Families, Files, HTML, Jekyll, PlantBook, Taxa, TAXA_COLNAMES, Taxon };
 export class Jekyll {
+    static getFrontMatter(atts: any): string;
     static hasInclude(baseDir: any, path: any): boolean;
     static include(path: any): string;
     static writeInclude(baseDir: any, path: any, data: any): void;
@@ -150,6 +151,11 @@ export class Jekyll {
 export class Jepson {
     static getEFloraLink(id: any): string;
 }
+export class Markdown {
+    static "__#2@#md": any;
+    static fileToHTML(filePath: any): any;
+    static strToHTML(str: any): any;
+}
 export class RarePlants {
     static getCESADescription(cesa: any): any;
     static getFESADescription(fesa: any): any;
@@ -158,9 +164,9 @@ export class RarePlants {
 }
 export const FLOWER_COLOR_NAMES: string[];
 export class Taxa {
-    static "__#10@#taxa": {};
-    static "__#10@#flower_colors": {};
-    static "__#10@#sortedTaxa": any;
+    static "__#11@#taxa": {};
+    static "__#11@#flower_colors": {};
+    static "__#11@#sortedTaxa": any;
     static getHTMLTable(taxa: any, columns?: {
         title: string;
         data: (t: any) => any;
@@ -169,8 +175,8 @@ export class Taxa {
     static getTaxa(): any;
     static getTaxon(name: any): any;
     static init(inclusionList: any, taxaMeta?: {}, taxonClass?: typeof Taxon, extraTaxa?: any[], extraSynonyms?: any[]): void;
-    static "__#10@#loadSyns"(synCSV: any, inclusionList: any): void;
-    static "__#10@#loadTaxa"(taxaCSV: any, inclusionList: any, taxaMeta: any, taxonClass: any): void;
+    static "__#11@#loadSyns"(synCSV: any, inclusionList: any): void;
+    static "__#11@#loadTaxa"(taxaCSV: any, inclusionList: any, taxaMeta: any, taxonClass: any): void;
 }
 export namespace TAXA_LIST_COLS {
     namespace CESA {
@@ -228,7 +234,7 @@ export class Taxon {
     getFileName(ext?: string): string;
     getFlowerColors(): any;
     getGenus(): {
-        "__#5@#data": any;
+        "__#6@#data": any;
         getTaxa(): any;
     };
     getGenusName(): any;

package/lib/jekyll.js

@@ -1,7 +1,18 @@
 import { Files } from "./files.js";
 
+const FRONT_DELIM = "---";
+
 class Jekyll {
 
+    static getFrontMatter( atts ) {
+        const lines = [ FRONT_DELIM ];
+        for ( const [ k, v ] of Object.entries( atts ) ) {
+            lines.push( k + ": \"" + v + "\"" );
+        }
+        lines.push( FRONT_DELIM );
+        return lines.join( "\n" ) + "\n";
+    }
+
     static hasInclude( baseDir, path ) {
         return Files.exists( baseDir + "/_includes/" + path );
     }

package/lib/markdown.js

@@ -0,0 +1,18 @@
+import markdownIt from "markdown-it";
+import { Files } from "@ca-plant-list/ca-plant-list";
+
+class Markdown {
+
+    static #md = new markdownIt( { xhtmlOut: true } );
+
+    static fileToHTML( filePath ) {
+        return this.strToHTML( Files.read( filePath ) );
+    }
+
+    static strToHTML( str ) {
+        return this.#md.render( str );
+    }
+
+}
+
+export { Markdown };

package/lib/pagerenderer.js

@@ -1,10 +1,9 @@
-import { HTML } from "./html.js";
+import { Files, HTML } from "@ca-plant-list/ca-plant-list";
 import { Taxa, TAXA_LIST_COLS } from "./taxa.js";
-import { PageTaxon } from "./pagetaxon.js";
+import { PageTaxon } from "./web/pagetaxon.js";
 import { Config } from "./config.js";
 import { RarePlants } from "./rareplants.js";
 import { BasePageRenderer } from "./basepagerenderer.js";
-import { Files } from "./files.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 ];

package/lib/plants/glossary.js

@@ -0,0 +1,52 @@
+import { Config, Files } from "@ca-plant-list/ca-plant-list";
+
+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 ) );
+        }
+
+    }
+
+    getEntries() {
+        return this.#srcEntries;
+    }
+
+}
+
+class GlossaryEntry {
+
+    #srcPath;
+    #fileName;
+    #term;
+
+    constructor( srcPath, fileName ) {
+        this.#srcPath = srcPath;
+        this.#fileName = fileName;
+        this.#term = fileName.split( "." )[ 0 ];
+    }
+
+    getHTMLFileName() {
+        return this.#term + ".html";
+    }
+
+    getMarkdown() {
+        return Files.read( this.#srcPath + "/" + this.#fileName );
+    }
+
+    getTermName() {
+        return this.#term;
+    }
+
+}
+
+export { Glossary };

package/lib/web/glossarypages.js

@@ -0,0 +1,52 @@
+import { Files, HTML } from "@ca-plant-list/ca-plant-list";
+import { Glossary } from "../plants/glossary.js";
+import { Jekyll } from "../jekyll.js";
+
+class GlossaryPages {
+
+    #outputDir;
+    #entryDir;
+    #glossary;
+
+    constructor( outputDir ) {
+        this.#outputDir = outputDir;
+        this.#entryDir = outputDir + "/g";
+        this.#glossary = new Glossary();
+    }
+
+    #generateEntryPage( entry ) {
+        const front = Jekyll.getFrontMatter( { title: entry.getTermName() } );
+        const markdown = entry.getMarkdown();
+        Files.write( this.#entryDir + "/" + entry.getTermName() + ".md", front + markdown );
+    }
+
+    #generateEntryPages() {
+        const entries = this.#glossary.getEntries();
+        for ( const entry of entries ) {
+            this.#generateEntryPage( entry );
+        }
+    }
+
+    #generateIncludeFile() {
+
+        const links = [];
+        const entries = this.#glossary.getEntries();
+        for ( const entry of entries ) {
+            links.push( HTML.getLink( "g/" + entry.getHTMLFileName(), entry.getTermName() ) );
+        }
+
+        Files.write( this.#outputDir + "/_includes/glossary.html", HTML.arrayToLI( links ), true );
+
+    }
+
+    renderPages() {
+        // Make sure output directory exists.
+        Files.mkdir( this.#entryDir );
+
+        this.#generateIncludeFile();
+        this.#generateEntryPages();
+    }
+
+}
+
+export { GlossaryPages };

package/lib/{pagetaxon.js → web/pagetaxon.js}

@@ -1,9 +1,9 @@
-import { HTML } from "./html.js";
-import { Jepson } from "./jepson.js";
-import { Config } from "./config.js";
-import { RarePlants } from "./rareplants.js";
-import { GenericPage } from "./genericpage.js";
-import { ExternalSites } from "./externalsites.js";
+import { HTML } from "@ca-plant-list/ca-plant-list";
+import { Jepson } from "../jepson.js";
+import { Config } from "../config.js";
+import { RarePlants } from "../rareplants.js";
+import { GenericPage } from "../genericpage.js";
+import { ExternalSites } from "../externalsites.js";
 
 class PageTaxon extends GenericPage {
 

package/package.json

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