aiiinotate 0.10.0 → 0.10.2

package/README.md

@@ -180,7 +180,7 @@ npm run cli -- import <arguments>
 
 ## Test coverage
 
-aiiinotate is well tested: **over 90% test coverage** on all files ! 
+aiiinotate is well tested: **~90% test coverage** on all files ! 
 
 ```
 ℹ ----------------------------------------------------------------------------------------

package/cli/utils/io.js

@@ -64,9 +64,16 @@ function fileArrayValidate (fileArr) {
  * @returns {Promise<string[]>}
  */
 async function parseImportInputFile(file) {
+  // ensure input file exists
+  const [ fileAbs, ok ] = fileOk(file);
+  if (!ok) {
+    console.error(`could not read import file: ${file}. exiting...`);
+    process.exit(1);
+  }
+
   // read `file` split it by lines, remove empty lines
   const fileArr =
-    fileRead(file)
+    fileRead(fileAbs)
       .split("\n")
       .filter(l => !l.match(/^\s*$/g));
   return [ ...new Set(fileArrayValidate(fileArr)) ];

package/docs/cli.md

@@ -64,17 +64,20 @@ aiiinotate migrate revert-all
 
 ## `import`: import data
 
+The CLI can be used to import IIIF annotations or to index IIIF manifests in aiiinotate.
+
 ```bash
 # in prod
-aiiinotate import -i 2 -f <path/to/import/file.txt>
+aiiinotate import <manifests|annotations> -i 2 -f <path/to/import/file.txt>
 ```
 
 Where:
+- `<manifests|annotations>` is the kind of data to import: manifests or annotations
 - `-i` `--iiif-version` (`2|3`) is the IIIF Presentation API version of the data to import:
-    - if `-i 3`, we import IIIF presentation 3.x annotations
-    - if `-i 2`, we import IIIF presentation 2.x annotations
+    - if `-i 3`, we import IIIF presentation 3.x data
+    - if `-i 2`, we import IIIF presentation 2.x data
 - `-f --file` is a relative or absolute path the the import file. This import file:
-    - contains a list of paths to annotation lists or annotation pages
+    - contains a list of paths to annotation lists, annotation pages or manifests
     - with 1 path per line
     - paths can be relative or absolute