@retorquere/bibtex-parser 5.2.3 → 6.0.0

package/index.d.ts

@@ -120,7 +120,7 @@ export interface Bibliography {
      */
     entries: Entry[];
     /**
-     * `@comment`s found in the bibtex file. See also [[jabref.parse]]
+     * `@comment`s found in the bibtex file.
      */
     comments: string[];
     /**
@@ -264,3 +264,4 @@ export declare const promises: {
     parse(input: string, options?: ParserOptions): Promise<Bibliography>;
 };
 export * as chunker from './chunker';
+export * as jabref from './jabref';

package/index.js

@@ -1,12 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.chunker = exports.promises = exports.ast = exports.parse = exports.fields = void 0;
+exports.jabref = exports.chunker = exports.promises = exports.ast = exports.parse = exports.fields = void 0;
 const tslib_1 = require("tslib");
-const bibtex = tslib_1.__importStar(require("./grammar"));
-const chunker = tslib_1.__importStar(require("./chunker"));
+/* eslint-disable @typescript-eslint/no-unsafe-argument */
+const bibtex = (0, tslib_1.__importStar)(require("./grammar"));
+const chunker = (0, tslib_1.__importStar)(require("./chunker"));
 const jabref_1 = require("./jabref");
 const unicode2latex_1 = require("unicode2latex");
-const crossref_json_1 = tslib_1.__importDefault(require("./crossref.json"));
+const crossref_json_1 = (0, tslib_1.__importDefault)(require("./crossref.json"));
 class ParserError extends Error {
     constructor(message, node) {
         super(message); // 'Error' breaks prototype chain here
@@ -192,7 +193,7 @@ class Parser {
             options.sentenceCase = false;
             options.caseProtection = false;
         }
-        this.options = Object.assign({ caseProtection: 'as-needed', verbatimFields: [/^citeulike-linkout-[0-9]+$/, ...exports.fields.verbatim], verbatimCommands: ['url', 'href'], unnestFields: [...exports.fields.title, ...exports.fields.unnest, ...exports.fields.verbatim], unnestMode: 'unwrap', htmlFields: exports.fields.html, guessAlreadySentenceCased: true, applyCrossRef: options.applyCrossRef || typeof options.applyCrossRef === 'undefined', markup: {} }, options);
+        this.options = Object.assign({ caseProtection: 'as-needed', verbatimFields: [/^citeulike-linkout-[0-9]+$/, ...exports.fields.verbatim], verbatimCommands: ['url'], unnestFields: [...exports.fields.title, ...exports.fields.unnest, ...exports.fields.verbatim], unnestMode: 'unwrap', htmlFields: exports.fields.html, guessAlreadySentenceCased: true, applyCrossRef: options.applyCrossRef || typeof options.applyCrossRef === 'undefined', markup: {} }, options);
         const markup_defaults = {
             enquote: { open: '\u201c', close: '\u201d' },
             sub: { open: '<sub>', close: '</sub>' },
@@ -325,7 +326,7 @@ class Parser {
                 }
             }
         }
-        const { comments, jabref } = jabref_1.parse(this.comments);
+        const { comments, jabref } = (0, jabref_1.parse)(this.comments);
         return {
             errors: this.errors,
             entries: this.entries,
@@ -453,9 +454,7 @@ class Parser {
             return (kind === 'none');
         // expect 'n' text arguments
         if (typeof kind === 'number') {
-            if (node.arguments.required.length !== kind)
-                return false;
-            return node.arguments.required;
+            return node.arguments.required.length === kind ? node.arguments.required : false;
         }
         // return first argument if it's the only one
         if (node.arguments.required.length !== 1)
@@ -463,9 +462,15 @@ class Parser {
         // loose checking for text
         if (kind === 'text') {
             const first = node.arguments.required[0];
-            if (first.kind === 'Block' && first.value.length === 1) {
-                if (first.value[0].kind === 'Text')
-                    return first.value[0].value;
+            if (first.kind === 'Block') {
+                switch (first.value.length) {
+                    case 0:
+                        return '';
+                    case 1:
+                        if (first.value[0].kind === 'Text')
+                            return first.value[0].value;
+                        break;
+                }
             }
             // fall back to strict kind check
             kind = 'Text';
@@ -843,21 +848,21 @@ class Parser {
             case 'ocirc':
             case 'mbox':
                 if (arg = this.argument(node, 'text')) {
+                    if (node.command === 'mbox' && !arg)
+                        return this.text('\u200b');
                     unicode = unicode2latex_1.latex[`\\${node.command}{${arg}}`];
                     return this.text(unicode || (node.command === 'hspace' ? ' ' : arg));
                 }
                 else if (!node.arguments.required.length) {
-                    return this.text();
+                    return (node.command === 'mbox') ? this.text('\u200b') : this.text();
                 }
                 else if (arg = this.argument(node, 'Block')) {
                     return this.clean(arg);
                 }
                 break;
-            // just take the URL? Not the label?
             case 'href':
-                if (arg = this.argument(node, 2))
-                    return this.clean(arg[0]);
-                break;
+                node.arguments.required = node.arguments.required.map(a => this.clean(a));
+                return node;
             case 'url':
                 if (arg = this.argument(node, 'Text'))
                     return this.text(arg);
@@ -1046,7 +1051,12 @@ class Parser {
             case 'StringDeclaration':
                 break;
             default:
-                return this.error(new ParserError(`no converter for ${node.kind}: ${this.show(node)}`, node));
+                if (node.kind === 'RegularCommand' && node.command === 'href') {
+                    this.convert_href(node);
+                }
+                else {
+                    return this.error(new ParserError(`no converter for ${node.kind}: ${this.show(node)}`, node));
+                }
         }
     }
     splitOnce(s, sep, fromEnd = false) {
@@ -1327,9 +1337,23 @@ class Parser {
         }
     }
     convert_environment(node) {
-        this.field.text += { enumerate: '<ol>', itemize: '<ul>' }[node.env];
+        const [open, close] = {
+            enumerate: ['<ol>', '</ol>'],
+            itemize: ['<ul>', '</ul>'],
+            quotation: ['<blockquote>', '</blockquote>'],
+        }[node.env] || ['', ''];
+        if (!open)
+            this.error(new TeXError(`Unhandled \\${node.env}{...}`, node, this.chunk));
+        this.field.text += open;
         this.convert_block(Object.assign(Object.assign({}, node), { kind: 'Block', markup: {} }));
-        this.field.text += { enumerate: '</ol>', itemize: '</ul>' }[node.env];
+        this.field.text += close;
+    }
+    convert_href(node) {
+        this.field.text += '<a href="';
+        this.convert(node.arguments.required[0]);
+        this.field.text += '">';
+        this.convert(node.arguments.required[1]);
+        this.field.text += '</a>';
     }
     convert_block(node) {
         const start = this.field.text.length;
@@ -1413,5 +1437,6 @@ exports.promises = {
         return await parser.parseAsync(input);
     },
 };
-exports.chunker = tslib_1.__importStar(require("./chunker"));
+exports.chunker = (0, tslib_1.__importStar)(require("./chunker"));
+exports.jabref = (0, tslib_1.__importStar)(require("./jabref"));
 //# sourceMappingURL=index.js.map

package/jabref.js

@@ -53,7 +53,7 @@ function parse(comments) {
         return true;
     });
     if (decoded.groupsversion)
-        result.groupsversion = parseInt(decoded.groupsversion[0].trim()) || decoded.groupsversion[0];
+        result.groupsversion = parseInt(decoded.groupsversion[0].trim()) || decoded.groupsversion[0]; // eslint-disable-line @typescript-eslint/no-unsafe-argument
     if (decoded.fileDirectory)
         result.fileDirectory = decoded.fileDirectory[0];
     if (decoded.databaseType)

package/package.json

@@ -1,19 +1,19 @@
 {
   "name": "@retorquere/bibtex-parser",
-  "version": "5.2.3",
+  "version": "6.0.0",
   "description": "BibTeX parser",
   "main": "index.js",
   "scripts": {
     "check-env": "node -e 'console.log(process.env)' | grep npm",
     "lint": "eslint . --ext .ts --cache --cache-location .eslintcache/",
-    "prestart": "npm run lint && pegjs grammar.pegjs",
+    "prestart": "npm run lint && peggy grammar.peggy",
     "start": "tsc -d",
     "poststart": "npm run docs",
     "pretest": "npm start",
     "test": "node test/jest",
     "presnap": "npm start",
     "snap": "node test/jest --updateSnapshot",
-    "minitest": "pegjs grammar.pegjs && tsc -d && node i.js",
+    "minitest": "peggy grammar.peggy && tsc -d && node i.js",
     "list": "tar tvf $(npm pack)",
     "prepublishOnly": "npm start",
     "abbr": "./build/abbr.py",
@@ -21,7 +21,7 @@
     "postversion": "git push --follow-tags",
     "update-cases": "curl -s https://raw.githubusercontent.com/retorquere/zotero-better-bibtex/master/test/loaded.json | jq -r '.[] | select(test(\"\\\\.bib((la)?tex)?$\"))' | rsync -av --delete -m --files-from=- ../better-bibtex/test/fixtures/ test/better-bibtex/",
     "docs": "rm -rf docs && typedoc --name 'BibTeX parser' index.ts && touch docs/.nojekyll",
-    "prencu": "git submodule update --init --recursive --remote && git submodule foreach git reset --hard && git submodule foreach git checkout master && git submodule foreach git pull origin master",
+    "prencu": "git submodule update --init --recursive --remote && git submodule foreach git reset --hard && git submodule foreach git checkout master && git submodule foreach git pull origin master && git add abbrv.jabref.org",
     "ncu": "ncu -u && npm i && git add package.json package-lock.json && git commit -m ncu"
   },
   "repository": {
@@ -34,32 +34,31 @@
   "author": "Emiliano Heyns",
   "license": "ISC",
   "devDependencies": {
-    "@types/node": "^16.4.2",
-    "@typescript-eslint/eslint-plugin": "^4.28.4",
-    "@typescript-eslint/parser": "^4.28.4",
-    "command-line-args": "^5.1.3",
-    "csv": "^5.5.0",
+    "@types/node": "^16.11.10",
+    "@typescript-eslint/eslint-plugin": "^5.4.0",
+    "@typescript-eslint/parser": "^5.4.0",
+    "command-line-args": "^5.2.0",
+    "csv": "^6.0.4",
     "digital-tree": "^2.0.3",
     "ejs": "^3.1.6",
-    "eslint": "^7.31.0",
-    "eslint-plugin-import": "^2.23.4",
+    "eslint": "^8.3.0",
+    "eslint-plugin-import": "^2.25.3",
     "eslint-plugin-prefer-arrow": "^1.2.3",
-    "jest": "^27.0.6",
-    "jest-cli": "^27.0.6",
+    "jest": "^27.3.1",
+    "jest-cli": "^27.3.1",
     "jest-specific-snapshot": "^5.0.0",
-    "markdown": "^0.5.0",
     "mkdirp": "^1.0.4",
-    "node-fetch": "^2.6.1",
-    "pegjs": "^0.10.0",
+    "node-fetch": "^3.1.0",
+    "peggy": "^1.2.0",
     "slug": "^5.1.0",
-    "ts-node": "^10.1.0",
-    "tslib": "^2.3.0",
-    "typedoc": "^0.21.4",
-    "typescript": "^4.3.5"
+    "ts-node": "^10.4.0",
+    "tslib": "^2.3.1",
+    "typedoc": "^0.22.9",
+    "typescript": "^4.5.2"
   },
   "dependencies": {
-    "unicode2latex": "^2.1.35",
-    "xregexp": "^5.0.2"
+    "unicode2latex": "^2.1.36",
+    "xregexp": "^5.1.0"
   },
   "files": [
     "package.json",