@retorquere/bibtex-parser 8.0.7 → 8.0.8

package/README.md

@@ -8,4 +8,4 @@ While parsing, the parser will apply markup for commands such as `\textbf`, `\te
 
 BibTeX is a reference management program that makes it easy for users of TeX and LaTeX to generate bibliographies for books and journal articles. When possible, it is usually stylized in the TeX font the way TeX and LaTeX are. LaTeX was first created in 1985 by Leslie Lamport and Oren Patashnik.
 
-Documenation is available at [http://retorque.re/bibtex-parser/](http://retorque.re/bibtex-parser/).
+Documenation is available at [https://retorque.re/bibtex-parser/](https://retorque.re/bibtex-parser/).

package/index.d.ts

@@ -2,6 +2,7 @@ import { Node } from '@unified-latex/unified-latex-types';
 import * as bibtex from './verbatim';
 import * as JabRef from './jabref';
 export { JabRefMetadata } from './jabref';
+export { ParseError } from './verbatim';
 export { toSentenceCase } from './sentence-case';
 type CreatorFields = {
     author?: Creator[];
@@ -36,6 +37,10 @@ export type Entry = {
     type: string;
     key: string;
     fields: Fields;
+    crossref?: {
+        inherited: string[];
+        donated: [];
+    };
     input: string;
 };
 export interface Bibliography {

package/index.js

@@ -203,6 +203,9 @@ const FieldAction = {
         'year',
         'month',
     ],
+    noCrossRef: [
+        'file',
+    ],
 };
 const narguments = {
     advance: 1,
@@ -1052,24 +1055,41 @@ class BibTeXParser {
                 if (!order.includes(key))
                     order.push(key);
             }
+            const add = (obj, kind, field) => {
+                obj[kind] = [...(new Set([...obj[kind], field]))].sort();
+            };
             for (const key of order) {
                 const child = entries[key.toUpperCase()];
                 const parent = entries[(_a = child.fields.crossref) === null || _a === void 0 ? void 0 : _a.toUpperCase()];
                 if (!parent)
                     continue;
+                child.crossref = child.crossref || { donated: [], inherited: [] };
+                parent.crossref = parent.crossref || { donated: [], inherited: [] };
                 for (const mappings of [crossref_json_1.default[child.type], crossref_json_1.default['*']].filter(m => m)) {
                     for (const mapping of [mappings[parent.type], mappings['*']].filter(m => m)) {
                         for (const [childfield, parentfield] of Object.entries(mapping)) {
-                            if (!child.fields[childfield] && parent.fields[parentfield])
+                            if (!child.fields[childfield] && parent.fields[parentfield]) {
                                 child.fields[childfield] = parent.fields[parentfield];
+                                add(child.crossref, 'inherited', childfield);
+                                add(parent.crossref, 'donated', parentfield);
+                            }
                         }
                         for (const field of (fields_json_1.default[child.type] || [])) {
-                            if (!child.fields[field] && parent.fields[field])
+                            if (FieldAction.noCrossRef.includes(field))
+                                continue;
+                            if (!child.fields[field] && parent.fields[field]) {
                                 child.fields[field] = parent.fields[field];
+                                add(child.crossref, 'inherited', field);
+                                add(parent.crossref, 'donated', field);
+                            }
                         }
                     }
                 }
             }
+            for (const entry of this.bib.entries) {
+                if (entry.crossref && !entry.crossref.donated.length && !entry.crossref.inherited.length)
+                    delete entry.crossref;
+            }
         }
         const { comments, jabref } = JabRef.parse(base.comments);
         this.bib.comments = comments;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@retorquere/bibtex-parser",
-  "version": "8.0.7",
+  "version": "8.0.8",
   "description": "BibTeX parser",
   "main": "index.js",
   "typings": "./index.d.ts",
@@ -9,24 +9,21 @@
     "lint": "eslint . --ext .ts --cache --cache-location .eslintcache/",
     "prestart": "npm run lint",
     "start": "npm run tsc",
-    "tsc": "peggy grammar.peggy && tsc -d",
+    "tsc": "tsc -d",
     "pretest": "npm start",
     "test": "tap --timeout 0 --disable-coverage --allow-empty-coverage",
     "snap": "npm test --snapshot",
     "snap:big": "npm test --snapshot --big",
-    "minitest": "peggy grammar.peggy && ./build/crossref.py && tsc -d && node i.js",
+    "minitest": "./build/crossref.py && tsc -d && node i.js",
     "list": "tar tvf $(npm pack)",
     "prepublishOnly": "npm start",
     "abbr": "./build/abbr.py",
     "preversion": "./console.py r && npm run abbr && npm run test",
     "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/",
-    "x-docs": "rm -rf docs temp && typedoc --name 'BibTeX parser' index.ts && touch docs/.nojekyll",
     "predocs": "npm start",
-    "docs": "mkdir -p etc temp && npm run api-extractor && npm run api-documenter",
-    "ncu": "./build/submodules.py && ./build/crossref.py && ncu -u && npm i && git add package.json package-lock.json && npm audit fix && git commit -m ncu",
-    "api-documenter": "api-documenter markdown --input temp --output docs",
-    "api-extractor": "api-extractor run --local --verbose"
+    "docs": "typedoc",
+    "ncu": "./build/submodules.py && ./build/crossref.py && ncu -u && npm i && git add package.json package-lock.json && npm audit fix && git commit -m ncu"
   },
   "repository": {
     "type": "git",
@@ -38,8 +35,6 @@
   "author": "Emiliano Heyns",
   "license": "ISC",
   "devDependencies": {
-    "@microsoft/api-documenter": "^7.24.1",
-    "@microsoft/api-extractor": "^7.43.0",
     "@types/node": "^20.12.2",
     "@typescript-eslint/eslint-plugin": "^7.4.0",
     "@typescript-eslint/parser": "^7.4.0",
@@ -54,12 +49,12 @@
     "glob": "^10.3.12",
     "mkdirp": "^3.0.1",
     "node-fetch": "^3.3.2",
-    "peggy": "^4.0.2",
     "piscina": "^4.4.0",
     "slug": "^9.0.0",
     "tap": "^18.7.2",
     "ts-node": "^10.9.2",
     "tslib": "^2.6.2",
+    "typedoc": "^0.25.12",
     "typescript": "^5.4.3"
   },
   "dependencies": {