@iebh/reflib 2.3.4 → 2.4.0

package/README.md

@@ -1,4 +1,4 @@
-RefLib
+Reflib
 ======
 Reference library processing for Node.
 
@@ -24,12 +24,12 @@ Compatibility
 
 **Notes on different formats**:
 
-* Medline seems to implement a totally different [publication type system](https://www.nlm.nih.gov/mesh/pubtypes.html) than others. RefLib will attempt to guess the best match, storing the original type in the `medlineType` key. Should the citation library be exported _back_ to Medline / `.nbib` files this key will take precedence to avoid data loss
+* Medline seems to implement a totally different [publication type system](https://www.nlm.nih.gov/mesh/pubtypes.html) than others. Reflib will attempt to guess the best match, storing the original type in the `medlineType` key. Should the citation library be exported _back_ to Medline / `.nbib` files this key will take precedence to avoid data loss
 
 
 Reference Structure
 ===================
-RefLib creates a simple Plain-Old-JavaScript-Object (POJO) for each reference it parses, or writes to a file format when given a collection of the same.
+Reflib creates a simple Plain-Old-JavaScript-Object (POJO) for each reference it parses, or writes to a file format when given a collection of the same.
 
 Each reference has the following standardized fields, these are translated from whatever internal format each module uses - e.g. the `TY` RIS field is automatically translated to `title`.
 

package/lib/fields.js

@@ -1,5 +1,5 @@
 /**
-* Field definitions for RefLib citations
+* Field definitions for Reflib citations
 * @type {Object} An object lookup where each key represents a field within a citation
 * @property {string} type A TypeScript compatible type for that field
 * @property {array<string>} [value] Possible values if the type is restricted

package/lib/formats.js

@@ -1,6 +1,6 @@
 /**
 * Lookup table of various citation file formats
-* @type {array<Object>} A collection of RefLib supported file formats
+* @type {array<Object>} A collection of Reflib supported file formats
 * @property {string} title The long form title of the format
 * @property {string} titleShort Shorter title of the format
 * @property {string} input Input format required by parser

package/modules/endnoteXml.js

@@ -264,9 +264,9 @@ export function writeStream(stream, options) {
 
 
 /**
-* Utility function to take the raw XML output object and translate it into a RefLib object
+* Utility function to take the raw XML output object and translate it into a Reflib object
 * @param {Object} xRef Raw XML object to process
-* @returns {Object} The translated RefLib object output
+* @returns {Object} The translated Reflib object output
 */
 export function translateRawToRef(xRef) {
 	let recOut = {
@@ -317,8 +317,8 @@ export function xmlUnescape(str) {
 /**
 * Lookup tables for this module
 * @type {Object}
-* @property {array<Object>} fields Field translations between RefLib (`rl`) and the raw format (`raw`)
-* @property {array<Object>} types Field translations between RefLib (`rl`) and the raw format types as raw text (`rawText`) and numeric ID (`rawId`)
+* @property {array<Object>} fields Field translations between Reflib (`rl`) and the raw format (`raw`)
+* @property {array<Object>} types Field translations between Reflib (`rl`) and the raw format types as raw text (`rawText`) and numeric ID (`rawId`)
 */
 export let translations = {
 	// Field translations {{{

package/modules/json.js

@@ -15,7 +15,6 @@ export function readStream(stream) {
 
 		if (typeof stream.pipe === 'function') {
 			// On node.js
-			console.log('Parsing JSON with node.js library')
 			const nodeJSONStream = JSONStream.parse('*')
 			nodeJSONStream.on('data', ref => emitter.emit('ref', {
 					recNumber: recNumber++,

package/modules/medline.js

@@ -293,8 +293,8 @@ export function parseRef(refString, settings) {
 /**
 * Lookup tables for this module
 * @type {Object}
-* @property {array<Object>} fields Field translations between RefLib (`rl`) and the raw format (`raw`)
-* @property {array<Object>} types Field translations between RefLib (`rl`) and the raw format types as raw text (`rawText`) and numeric ID (`rawId`)
+* @property {array<Object>} fields Field translations between Reflib (`rl`) and the raw format (`raw`)
+* @property {array<Object>} types Field translations between Reflib (`rl`) and the raw format types as raw text (`rawText`) and numeric ID (`rawId`)
 * @property {boolean} isArray Whether the field should append to any existing `rl` field and be treated like an array of data
 * @property {number|boolean} [sort] Sort order when outputting, use boolean `false` to disable the field on output
 * @property {boolean} [outputSkip=false] Dont output this field at all

package/modules/ris.js

@@ -178,8 +178,8 @@ export function parseRef(refString, settings) {
 /**
 * Lookup tables for this module
 * @type {Object}
-* @property {array<Object>} fields Field translations between RefLib (`rl`) and the raw format (`raw`)
-* @property {array<Object>} types Field translations between RefLib (`rl`) and the raw format types as raw text (`rawText`) and numeric ID (`rawId`)
+* @property {array<Object>} fields Field translations between Reflib (`rl`) and the raw format (`raw`)
+* @property {array<Object>} types Field translations between Reflib (`rl`) and the raw format types as raw text (`rawText`) and numeric ID (`rawId`)
 * @property {boolean} isArray Whether the field should append to any existing `rl` field and be treated like an array of data
 * @property {number|boolean} [sort] Sort order when outputting, use boolean `false` to disable the field on output
 * @property {boolean} [outputRepeat=false] Whether to repeat the output field if multiple values are present, if disabled arrays are flattened into a string with newlines instead

package/modules/shims/WritableStream-browser.js

@@ -6,8 +6,8 @@ export class WritableStream {
 		this.emitter = Emitter();
 		this.parser = new CacxParser({
 			collect: false,
+			reAttrSegment: /(?<key>[a-zA-Z_:][-a-zA-Z0-9_:.]*)(?:\s*=\s*(?<escape>["'])(?<val>.*?)\k<escape>)?/ig,
 			onTagOpen: (node) => {
-				console.log(node.tag, node.attrs);
 				const name = node.tag;
 				const attrs = node.attrs || {};
 				this.emitter.emit('opentag', name, attrs);

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@iebh/reflib",
-  "version": "2.3.4",
+  "version": "2.4.0",
   "description": "Reference / Citation reference library utilities",
   "scripts": {
-    "lint": "eslint lib modules shared test",
+    "lint": "eslint .",
     "test": "mocha",
     "test:browser": "cd test/browser && npm run dev"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/IEBH/RefLib"
+    "url": "https://github.com/IEBH/Reflib"
   },
   "keywords": [
     "reflib",
@@ -23,9 +23,9 @@
   ],
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/IEBH/RefLib/issues"
+    "url": "https://github.com/IEBH/Reflib/issues"
   },
-  "homepage": "https://github.com/IEBH/RefLib",
+  "homepage": "https://github.com/IEBH/Reflib",
   "enginesStrict": true,
   "engines": {
     "node": "^12.20.0 || ^14.13.1 || >=16.0.0"
@@ -44,29 +44,18 @@
     "JSONStream": "./modules/shims/JSONStream-browser.js"
   },
   "devDependencies": {
-    "@momsfriendlydevco/eslint-config": "^1.0.9",
-    "chai": "^4.3.10",
-    "eslint": "^8.53.0",
-    "mocha": "^10.2.0",
+    "@momsfriendlydevco/eslint-config": "^2.0.3",
+    "chai": "^5.1.1",
+    "eslint": "^9.9.0",
+    "mocha": "^10.7.3",
     "mocha-logger": "^1.0.8",
     "temp": "^0.9.4",
     "vite-plugin-replace": "^0.1.1"
   },
   "dependencies": {
-    "@iebh/cacx": "^1.0.0",
-    "htmlparser2": "^9.0.0",
+    "@iebh/cacx": "^1.0.2",
+    "htmlparser2": "^9.1.0",
     "JSONStream": "^1.3.5",
     "mitt": "^3.0.1"
-  },
-  "eslintConfig": {
-    "extends": "@momsfriendlydevco",
-    "env": {
-      "browser": true,
-      "es2021": true,
-      "mocha": true
-    },
-    "parserOptions": {
-      "ecmaVersion": "latest"
-    }
   }
 }

package/.vscode/launch.json

@@ -1,38 +0,0 @@
-{
-  "version": "0.2.0",
-  "configurations": [
-    {
-      "type": "node",
-      "request": "launch",
-      "name": "Debug Vite Server",
-      "runtimeExecutable": "/home/connor/.nvm/versions/node/v20.12.2/bin/npm",
-      "runtimeArgs": ["run", "dev"],
-      "cwd": "${workspaceFolder}/test/browser",
-      "console": "integratedTerminal",
-      "env": {
-        "VITE_DEV_SERVER_URL": "http://localhost:3000"
-      }
-    },
-    {
-      "name": "Debug in Chrome",
-      "type": "chrome",
-      "request": "launch",
-      "url": "http://localhost:3000",
-      "webRoot": "${workspaceFolder}",
-      "sourceMaps": true,
-      "sourceMapPathOverrides": {
-        "/__vite-root/*": "${webRoot}/*",
-        "/@fs/*": "*",
-        "/@vite-root/*": "${webRoot}/*",
-        "/src/*": "${webRoot}/src/*",
-        "/modules/*": "${webRoot}/modules/*"
-      }
-    }
-  ],
-  "compounds": [
-    {
-      "name": "Debug Vite + Chrome",
-      "configurations": ["Debug Vite Server", "Debug in Chrome"]
-    }
-  ]
-}