jjpwrgem 0.5.5 → 0.6.0

package/.prettierignore

@@ -0,0 +1 @@
+package.json

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "jjpwrgem",
-  "version": "0.5.5",
+  "version": "0.6.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "jjpwrgem",
-      "version": "0.5.5",
+      "version": "0.6.0",
       "hasInstallScript": true,
       "license": "MIT",
       "dependencies": {

package/package.json

@@ -1,24 +1,26 @@
 {
   "name": "jjpwrgem",
-  "version": "0.5.5",
+  "version": "0.6.0",
+  "private": false,
   "description": "jjpwrgem json parser with really good error messages",
   "keywords": [
     "command-line-utilities",
-    "text-processing",
     "encoding",
-    "parser",
     "formatter",
     "json",
-    "linter"
+    "linter",
+    "parser",
+    "text-processing"
   ],
   "homepage": "https://github.com/20jasper/jjpwrgem",
   "license": "MIT",
   "author": "Jacob Asper <jacobasper191@gmail.com>",
-  "main": "",
+  "repository": "https://github.com/20jasper/jjpwrgem",
   "bin": {
     "jjp": "run-jjp.js"
   },
-  "repository": "https://github.com/20jasper/jjpwrgem",
+  "type": "",
+  "main": "",
   "scripts": {
     "postinstall": "node ./install.js"
   },
@@ -30,12 +32,12 @@
     "node": ">=14",
     "npm": ">=6"
   },
-  "private": false,
-  "type": "",
+  "artifactDownloadUrl": "https://github.com/20jasper/jjpwrgem/releases/download/jjpwrgem-v0.6.0",
   "glibcMinimum": {
     "major": 2,
     "series": 35
   },
+  "preferUnplugged": true,
   "supportedPlatforms": {
     "aarch64-apple-darwin": {
       "artifactName": "jjpwrgem-aarch64-apple-darwin.tar.xz",
@@ -86,7 +88,5 @@
       },
       "zipExt": ".zip"
     }
-  },
-  "artifactDownloadUrl": "https://github.com/20jasper/jjpwrgem/releases/download/jjpwrgem-v0.5.5",
-  "preferUnplugged": true
-}
+  }
+}

package/README.md

@@ -1,121 +0,0 @@
-<!-- GENERATED FILE - update the templates in the xtask -->
-
-# JJPWRGEM
-
-JJPWRGEM JSON Parser With Really Good Error Messages
-
-An RFC 8259 compliant JSON Parser and formatter!
-
-```
-$ echo -en "{\"coolKey\"}" | jjp check
-error: expected colon after key, found `}`
- --> stdin:1:11
-  |
-1 | {"coolKey"}
-  |  ---------^
-  |  |
-  |  expected due to `"coolKey"`
-  |
-help: insert colon and placeholder value
-  |
-1 | {"coolKey": "🐟🛹"}
-  |           ++++++++
-
-```
-
-![coverage: 87.3%](https://img.shields.io/badge/coverage-87.3%25-green)
-
-![A logo of an axolotl riding a skateboard](./logo.webp)
-
-## Table of contents
-
-- [Table of contents](#table-of-contents)
-- [Installation](#installation)
-- [Stability](#stability)
-- [FAQ](#faq)
-- [Motivations](#motivations)
-
-## Installation
-
-### Precompiled
-
-```bash
-mise use -g github:20jasper/jjpwrgem
-```
-
-See [releases](https://github.com/20jasper/JJPWRGEM/releases) for shell and powershell installation instructions and raw binaries
-
-Note: node adds ~60ms of overhead
-
-```bash
-npm install -g jjpwrgem
-```
-
-#### Requirements
-
-x86-64 binaries require a CPU with AVX2 support (Intel Haswell 2013+, AMD Ryzen 2017+). ARM binaries have no special requirements
-
-### From source
-
-```bash
-RUSTFLAGS="-C target-cpu=native" cargo install --path .
-```
-
-## Stability
-
-JJPWRGEM's CLI is pretty stable. Internal libraries are likely unstable
-
-## Indeterminate Handling
-
-How cases undefined by the spec are handled
-
-- numbers of any size or length are allowed
-  - the original precision will be maintained
-  - -0 is not equal to 0 and will persist
-- the last duplicate key is stored
-  - escaped and unescaped characters are considered not equal
-- parsing will fail if BOM is included
-- only utf8 encoding is supported
-- no limitations on nesting or length
-- extensions such as trailing commas or comments are not allowed
-- surrogates are not validated, eg a lone continuation byte is valid
-
-### Is it blazingly fast™?
-
-Axolotls can't walk so fast, so skateboards are pretty fast 🛹🐟
-
-Without caching, jjpwrgem can parse and pretty print a 1.7MB JSON file in around 11ms and the average package.json in 500 microseconds
-
-See the [benchmarks](/benches/BENCHMARKS.md)
-
-## FAQ
-
-### What does JJPWRGEM stand for?
-
-JJPWRGEM JSON Parser With Really Good Error Messages. I was inspired by GNU to make a recursive acronym
-
-### How do you pronounce JJPWRGEM?
-
-/ˈdʒeɪ dʒeɪ ˈpaʊər dʒɛm/ JAY-jay-POW-er-jem
-
-### But why is it called that?
-
-It sounds cool and the name isn't taken on any package managers
-
-### Why is the logo an axolotl riding a skateboard?
-
-It's cool
-
-### How long is an axolotl?
-
-According to the San Diego zoo, "[a]n axolotl can reach 12 inches in length, but on average grows to about 9 inches[^axolotlFact]"
-
-[^axolotlFact]: https://animals.sandiegozoo.org/animals/axolotl
-
-## Motivations
-
-I originally started this project to practice finite state machines, but got back into it when hearing about the internals of some formatters and compilers!
-
-I am heavily inspired by the Rust compiler's error messages. I love that unhelpful errors are considered bugs
-
-I checked out several JSON parsers and formatters, and none provided much context on _why_ a key was missing. Errors ranged from "expected closing on byte 10" to a snapshot of source code for that character, but none were up to my standards