chore: move rpi tool from ca-tools (#23)

ca-plants · Dec 24, 2024 · 78b69d0 · 78b69d0
1 parent 6858faf
commit 78b69d0
Show file tree

Hide file tree

Showing 9 changed files with 470 additions and 41 deletions.
diff --git a/lib/csv.js b/lib/csv.js
@@ -6,32 +6,6 @@ import { parse } from "csv-parse";
 import { stringify } from "csv-stringify/sync";
 
 class CSV {
-    /**
-     * @param {string} dir
-     * @param {string} fileName
-     */
-    static getMap(dir, fileName) {
-        /** @type {string[]} */
-        let headers = [];
-
-        /**
-         * @param {string[]} h
-         */
-        function setHeaders(h) {
-            headers = h;
-            return h;
-        }
-
-        const csv = this.parseFile(dir, fileName, setHeaders);
-        /** @type {Object<string,string[]>} */
-        const map = {};
-        for (const row of csv) {
-            map[row[headers[0]]] = row[headers[1]];
-        }
-
-        return map;
-    }
-
     /**
      * @param {string} fileName
      * @param {import("csv-parse").ColumnOption[]|boolean|function (string[]):string[]} columns
@@ -102,6 +76,7 @@ class CSV {
      * @param {string} fileName
      * @param {boolean|import("csv-parse").ColumnOption[]|function (string[]):string[]} [columns]
      * @param {string} [delimiter]
+     * @returns {Object<string,string>[]}
      */
     static readFile(fileName, columns = true, delimiter) {
         const content = fs.readFileSync(fileName);

diff --git a/lib/exceptions.js b/lib/exceptions.js
@@ -2,7 +2,7 @@ import { Config } from "./config.js";
 import { Files } from "./files.js";
 
 class Exceptions {
-    /** @type {Object<string,Object<string,Object<string,{}>>>} */
+    /** @type {Object<string,Object<string,Object<string,string>>>} */
     #exceptions = {};
 
     /**
@@ -39,6 +39,7 @@ class Exceptions {
      * @param {string} cat
      * @param {string} subcat
      * @param {string} [defaultValue]
+     * @returns {string|undefined}
      */
     getValue(name, cat, subcat, defaultValue) {
         const taxonData = this.#exceptions[name];

diff --git a/lib/program.js b/lib/program.js
@@ -1,6 +1,7 @@
 import { Command } from "commander";
 import { Files } from "./files.js";
 import { CSV } from "./csv.js";
+import path from "node:path";
 
 class Program {
     /**
@@ -14,7 +15,10 @@ class Program {
             console.log(includeFilePath + " not found; loading all taxa");
             return true;
         }
-        const includeCSV = CSV.parseFile(dataDir, includeFileName);
+
+        /** @type {TaxonData[]} */
+        // @ts-ignore
+        const includeCSV = CSV.readFile(path.join(dataDir, includeFileName));
         /** @type {Object<string,TaxonData>} */
         const include = {};
         for (const row of includeCSV) {
@@ -29,16 +33,16 @@ class Program {
             .option(
                 "-d, --datadir <dir>",
                 "The directory containing plant data.",
-                "./data"
+                "./data",
             )
             .option(
                 "-f, --show-flower-errors",
-                "Include missing flower color/flowering time in the error log when loading taxa."
+                "Include missing flower color/flowering time in the error log when loading taxa.",
             )
             .option(
                 "-o, --outputdir <dir>",
                 "The directory to which output should be written.",
-                "./output"
+                "./output",
             );
         return program;
     }

diff --git a/lib/taxa.js b/lib/taxa.js
@@ -95,6 +95,8 @@ class Taxa {
             this.#loadInatPhotos(dataDir);
         }
 
+        /** @type {SynonymData[]} */
+        // @ts-ignore
         const synCSV = CSV.parseFile(dataDir, "synonyms.csv");
         this.#loadSyns(synCSV, inclusionList);
         this.#loadSyns(extraSynonyms, inclusionList);
@@ -107,6 +109,7 @@ class Taxa {
         const photosFileName = "inattaxonphotos.csv";
         if (fs.existsSync(path.join(dataDir, photosFileName))) {
             /** @type {InatCsvPhoto[]} */
+            // @ts-ignore
             const csvPhotos = CSV.parseFile(dataDir, photosFileName);
             for (const csvPhoto of csvPhotos) {
                 const taxon = this.getTaxon(csvPhoto.name);

diff --git a/lib/tools/calflora.js b/lib/tools/calflora.js
@@ -9,6 +9,7 @@ const CALFLORA_URL_COUNTY =
 
 /**
  * @typedef {{
+ * Taxon:string,
  * "Native Status":string,
  * TJMTID:string
  * "Active in Calflora?":string
@@ -59,9 +60,13 @@ class Calflora {
             calfloraDataFileNameCounties,
         );
 
+        /** @type {CalfloraData[]} */
+        // @ts-ignore
         const csvActive = CSV.readFile(
             path.join(toolsDataPath, calfloraDataFileNameActive),
         );
+        /** @type {CalfloraData[]} */
+        // @ts-ignore
         const csvCounties = CSV.readFile(
             path.join(toolsDataPath, calfloraDataFileNameCounties),
         );