bs-uchar - npm Package Compare versions

Comparing version 1.0.1 to 2.0.0-pre.0

bsconfig.json

 {
   "name": "bs-uchar",
-  "version": "1.0.1",
+  "version": "2.0.0-pre.0",
   "sources": [
@@ -5,0 +5,0 @@ "src"

package.json

 {
   "name": "bs-uchar",
-  "version": "1.0.1",
+  "version": "2.0.0-pre.0",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/ELLIOTTCABLE/uchar.git"
+    "url": "git+https://github.com/ELLIOTTCABLE/bs-uchar.git"
   },
   "files": [
     "bsconfig.json",
-    "src/.gitkeep"
+    "src"
   ],
@@ -27,11 +27,11 @@ "scripts": {
   "bugs": {
-    "url": "https://github.com/ELLIOTTCABLE/uchar/issues"
+    "url": "https://github.com/ELLIOTTCABLE/bs-uchar/issues"
   },
-  "homepage": "https://github.com/ELLIOTTCABLE/uchar#readme",
+  "homepage": "https://github.com/ELLIOTTCABLE/bs-uchar#readme",
   "devDependencies": {
-    "bs-platform": "^6.0.0-dev.1"
+    "bs-platform": "^5.0.1"
   },
   "peerDependencies": {
-    "bs-platform": ">=6.0.0-dev.1"
+    "bs-platform": ">=4.0.0"
   }
 }

README.md

 `bs-uchar`
 ----------
 This is the Uchar compatibility library from OCaml 4.03, backported to
-OCaml 4.02, and thus [BuckleScript][] (an OCaml-to-JavaScript compiler,
-forked from OCaml 4.02.3) and [Reason][] (an alternative OCaml syntax
-targeting that compiler.)
+OCaml 4.02, and thus [BuckleScript][] (an OCaml-to-JavaScript compiler)
+versions prior to 6.0.0 (which were forked from OCaml 4.02.3) and
+[Reason][] (an alternative OCaml syntax targeting that compiler.)
 
@@ -13,3 +13,5 @@ You can safely ignore the installation instructions below when compiling
 
-        npm install --save @elliottcable/bs-uchar
+   ```sh
+   npm install --save @elliottcable/bs-uchar
+   ```
 
@@ -19,12 +21,30 @@ 2. Manually add `bs-uchar` to your `bsconfig.json`'s
 
-        "bs-dependencies": [
-          ...
-          "@elliottcable/bs-uchar"
-        ],
+   ```diff
+    "bs-dependencies": [
+      ...
+   +  "bs-uchar"
+    ],
+   ```
 
-3. Use `Uchar.t`!
+3. *Unconditionally and globally `open UcharShim` in your program*, by
+   adding an `-open` to `bsc-flags` in your `bsconfig.json`:
 
+   ```diff
+    "bsc-flags": [
+       ...
+   +   "-open UcharShim"
+    ]
+   ```
+
+   (The `UcharShim` module has no contents when compiled on a version of
+   OCaml already containing a `Uchar` module; and you can safely simply
+   remove the `-open` flag when you wish to drop support for
+   BuckleScript v4 & v5.)
+
+4. Use `Uchar.t` in your program!
+
    [BuckleScript]: <https://bucklescript.github.io/>
    [Reason]: <https://reasonml.github.io/>
 
+
 #### Original README follows:
@@ -44,3 +64,3 @@
 
-Home page: https://ocaml.github.io/uchar/  
+Home page: https://ocaml.github.io/uchar/
 Contact: Daniel Bünzli `<daniel.buenzl [e-mail]>`
@@ -47,0 +67,0 @@

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

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

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

38582

increased by26.84%

Number of package files

8

increased by33.33%

Lines of code

134

increased by930.77%

Number of lines in readme file

90

increased by28.57%

Worsened metrics

Number of low quality alerts

2

increased by100%

No dependency changes