bahai-indexes - npm Package Compare versions

Comparing version 0.2.0 to 0.3.0

CHANGES.md

 # bahai-indexes CHANGES
 
+## 0.3.0
+
+- Breaking change; Require Node 12 (runs asynchronously)
+- Breaking change; Switch to ESM
+- Breaking change; Logs completion
+- Breaking change: Change parser and src file paths
+- Linting (ESLint): As per latest ash-nazg
+- Docs: Mention npm install and copyrights
+- Maintenance: Add `.editorconfig`
+- npm: Add script for `build`
+- npm: Update devDeps.
+
 ## 0.2.0
@@ -4,0 +16,0 @@

package.json

 {
   "name": "bahai-indexes",
-  "version": "0.2.0",
+  "type": "module",
+  "version": "0.3.0",
   "description": "Indexes to the Bahá'í Writings in JSON form",
-  "main": "src/iterator.js",
+  "main": "src/buildFlattenedJSONAndJS.js",
   "scripts": {
-    "eslint": "eslint .",
-    "parse": "node parsers/aqdas.js",
+    "eslint": "eslint --ext=js,md,html .",
+    "build": "node --experimental-modules src/buildFlattenedJSONAndJS.js",
+    "parse": "npm run parse-aqdas",
+    "parse-aqdas": "node --experimental-modules html-parsers/aqdas.js",
     "test": "npm run eslint && echo \"Error: no test specified\" && exit 1"
@@ -26,22 +29,27 @@ },
   "engines": {
-    "node": ">= 8"
+    "node": ">=12"
   },
   "devDependencies": {
-    "@mysticatea/eslint-plugin": "^9.0.1",
-    "eslint": "^5.16.0",
-    "eslint-config-ash-nazg": "^2.0.0",
-    "eslint-config-standard": "^12.0.0",
-    "eslint-plugin-compat": "^3.1.1",
-    "eslint-plugin-eslint-comments": "^3.1.1",
-    "eslint-plugin-import": "^2.17.1",
-    "eslint-plugin-jsdoc": "^4.8.3",
-    "eslint-plugin-markdown": "^1.0.0",
-    "eslint-plugin-no-use-extend-native": "^0.4.0",
-    "eslint-plugin-node": "^8.0.1",
-    "eslint-plugin-promise": "^4.1.1",
-    "eslint-plugin-standard": "^4.0.0",
-    "eslint-plugin-unicorn": "^8.0.2",
+    "@mysticatea/eslint-plugin": "^13.0.0",
+    "eslint": "^7.18.0",
+    "eslint-config-ash-nazg": "^24.0.0",
+    "eslint-config-standard": "^16.0.2",
+    "eslint-plugin-array-func": "^3.1.7",
+    "eslint-plugin-compat": "^3.9.0",
+    "eslint-plugin-eslint-comments": "^3.2.0",
+    "eslint-plugin-html": "^6.1.1",
+    "eslint-plugin-import": "^2.22.1",
+    "eslint-plugin-jsdoc": "^31.0.6",
+    "eslint-plugin-markdown": "^1.0.2",
+    "eslint-plugin-no-unsanitized": "^3.1.4",
+    "eslint-plugin-no-use-extend-native": "^0.5.0",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-promise": "^4.2.1",
+    "eslint-plugin-sonarjs": "^0.5.0",
+    "eslint-plugin-standard": "^4.1.0",
+    "eslint-plugin-unicorn": "^26.0.1",
     "handle-node": "^0.2.1",
-    "jsdom": "^14.0.0"
+    "jsdom": "^16.4.0",
+    "typescript": "^4.1.3"
   }
 }

README.md

@@ -6,2 +6,9 @@ # bahai-indexes
 
+```shell
+npm i bahai-indexes
+```
+
+Note that any copyright that applies for the original indexes follows its own
+copyright.
+
 **NOTE: This project only has an index for the following files at present!**
@@ -11,3 +18,5 @@
 
--  *Kitáb-i-Aqdas* (`aqdas`) - From <http://bahai-library.com/writings/bahaullah/aqdas/aqdas2/aqdas-allindex.html>
+-  *Kitáb-i-Aqdas* (`aqdas`) - From <http://bahai-library.com/writings/bahaullah/aqdas/aqdas2/aqdas-allindex.html>;
+    view within queries against the following (currently Chrome only:
+    <https://bahai-browser.org/#lang=en-US&work=aqdas>).
 
@@ -17,2 +26,11 @@ ## To-dos
 1. Add JSON Schema for each schema and any fixed rules into an abstract schema
-1. Add category mechanism
+1. Editing
+    1. Add category mechanism for adding categories (and categories for these
+        categories) to top-level index items (for a completely subject-based
+        sorting, as with
+        <http://bahai-library.com/hornby_lights_guidance#topicalcontents>).
+    1. Ability to mark-up any two entries as identical, e.g.,
+        "Hair, does not invalidate prayer" and
+        "Prayer, hair does not invalidate", so that could optionally avoid
+        showing duplicates (though admittedly not exactly duplicates based
+        on difference of emphasis)

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1856204

increased by0.21%

Lines of code

71765

increased by0.12%

Number of lines in readme file

34

increased by112.5%

Is type module

Yes

Worsened metrics

Dev dependency count

21

increased by31.25%

No dependency changes