jjpwrgem 0.1.4 → 0.2.0

package/.gitignore

@@ -0,0 +1,2 @@
+/node_modules
+

package/CHANGELOG.md

@@ -7,8 +7,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.0](https://github.com/20jasper/JJPWRGEM/releases/tag/jjpwrgem-v0.2.0) - 2025-12-06
+
+### Added
+
+- subcommands - check and format with uglify flag
+
+
+## [0.1.5](https://github.com/20jasper/JJPWRGEM/releases/tag/jjpwrgem-v0.1.5) - 2025-12-05
+
+Test for publishing flow
+
+
 ## [0.1.4](https://github.com/20jasper/JJPWRGEM/releases/tag/jjpwrgem-v0.1.4) - 2025-12-05
 
-Initial release 
+### Feature
 - pretty format JSON
 - error messages on failure
+

package/npm-shrinkwrap.json

@@ -23,7 +23,7 @@
       "hasInstallScript": true,
       "license": "MIT",
       "name": "jjpwrgem",
-      "version": "0.1.4"
+      "version": "0.2.0"
     },
     "node_modules/@isaacs/balanced-match": {
       "engines": {
@@ -896,5 +896,5 @@
     }
   },
   "requires": true,
-  "version": "0.1.4"
+  "version": "0.2.0"
 }

package/package.json

@@ -1,5 +1,5 @@
 {
-  "artifactDownloadUrl": "https://github.com/20jasper/jjpwrgem/releases/download/jjpwrgem-v0.1.4",
+  "artifactDownloadUrl": "https://github.com/20jasper/jjpwrgem/releases/download/jjpwrgem-v0.2.0",
   "author": "Jacob Asper <jacobasper191@gmail.com>",
   "bin": {
     "jjp": "run-jjp.js"
@@ -93,7 +93,7 @@
       "zipExt": ".tar.xz"
     }
   },
-  "version": "0.1.4",
+  "version": "0.2.0",
   "volta": {
     "node": "18.14.1",
     "npm": "9.5.0"

package/readme.md

@@ -0,0 +1,98 @@
+# JJPWRGEM
+
+JJPWRGEM JSON Parser With Really Good Error Messages
+
+An RFC 8259 compliant JSON Parser!
+
+![A logo of an axolotl riding a skateboard](./logo.webp)
+
+```
+echo -en '{"coolKey"}' | jjp
+error: expected colon after key, found `}`
+  ╭▸ stdin:1:11
+  │
+1 │ {"coolKey"}
+  │  ┬────────━
+  │  │
+  │  expected due to `"coolKey"`
+  ╰╴
+help: insert colon and placeholder value
+  ╭╴
+1 │ {"coolKey": "🐟🛹"}
+  ╰╴          ++++++++
+```
+
+## Stability
+
+JJPWRGEM is in its infancy and extremely likely to have breaking changes (properly marked with semver of course!)
+
+## 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
+
+## 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
+
+### Is it blazingly fast™?
+
+Axolotls can't walk so fast, so relatively, yes
+
+### 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
+
+## Notes
+
+I went with annotate snippets over other libraries like codespan reporting since it better supports patches and workflows that don't require files, like reading from stdin
+
+## references
+
+### parsers/diagnostics
+
+https://rustc-dev-guide.rust-lang.org/diagnostics/error-codes.html
+
+https://github.com/rust-lang/rust/pull/27475
+
+OXC
+
+### Accessibility
+
+https://afixt.com/accessible-by-design-improving-command-line-interfaces-for-all-users/
+
+miette