node-ray - npm Package Compare versions

Comparing version 1.4.0 to 1.4.1

CHANGELOG.md

@@ -7,2 +7,8 @@ # Changelog
 
+## 1.4.1 - 2021-02-07
+
+- change the output filenames to end with `.js`, instead of `.cjs` and `.mjs`
+
+- update readme
+
 ## 1.4.0 - 2021-02-07
@@ -12,2 +18,4 @@
 
+- add `dayjs` package
+
 - add `error()` method to display information about errors
@@ -14,0 +22,0 @@

package.json

 {
   "name": "node-ray",
-  "version": "1.4.0",
+  "version": "1.4.1",
   "description": "Debug NodeJS with Ray to fix problems faster",
@@ -15,15 +15,14 @@ "license": "MIT",
   },
-  "main": "./dist/index.cjs",
+  "main": "./dist/index.cjs.js",
   "exports": {
     ".": {
-      "import": "./dist/index.mjs",
-      "require": "./dist/index.cjs"
+      "import": "./dist/index.esm.js",
+      "require": "./dist/index.cjs.js"
     },
     "./web": {
-      "import": "./dist/web.mjs",
-      "require": "./dist/web.cjs"
+      "import": "./dist/web.esm.js",
+      "require": "./dist/web.cjs.js"
     },
     "./standalone": {
-      "import": "./dist/standalone.mjs",
-      "require": "./dist/standalone.cjs"
+      "require": "./dist/standalone.js"
     }
@@ -30,0 +29,0 @@ },

README.md

@@ -9,3 +9,3 @@ <p align="center">
 <p align="center">
-    <img src="https://shields.io/npm/v/node-ray" alt="npm version"> <img src="https://shields.io/github/license/permafrost-dev/node-ray" alt="license"> <img src="https://github.com/permafrost-dev/node-ray/workflows/Run%20Tests/badge.svg" alt="test status"> <img src="https://codecov.io/gh/permafrost-dev/node-ray/branch/main/graph/badge.svg?token=YW2BTKSNEO"/>
+    <img src="https://shields.io/npm/v/node-ray" alt="npm version"> <img src="https://img.shields.io/npm/dt/node-ray.svg" alt="npm downloads"> <img src="https://shields.io/github/license/permafrost-dev/node-ray" alt="license"> <img src="https://github.com/permafrost-dev/node-ray/workflows/Run%20Tests/badge.svg" alt="test status"> <img src="https://codecov.io/gh/permafrost-dev/node-ray/branch/main/graph/badge.svg?token=YW2BTKSNEO"/>
 </p>
@@ -99,2 +99,14 @@
 
+### Using with Laravel Mix
+
+To use `node-ray` with Laravel Mix, include the following in `resources/js/bootstrap.js`:
+
+```js
+const { ray } = require('node-ray/dist/web.cjs.js');
+
+window.ray = ray;
+```
+
+You may then compile as usual _(`npm run dev`)_, and access `ray()` normally within your scripts.
+
 ## Configuration
@@ -174,2 +186,8 @@
 
+## FAQ
+
+- Can `node-ray` be used with React? _yes, just be sure to import `node-ray/web`_
+
+- Can `node-ray` be used if I'm using webpack? _yes, just be sure to import `node-ray/web`_
+
 ## Development setup
@@ -194,4 +212,17 @@
 
+## Changelog
+
+Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
+
+## Security Vulnerabilities
+
+Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
+
+## Credits
+
+- [Patrick Organ](https://github.com/patinthehat)
+- [All Contributors](../../contributors)
+
 ## License
 
 The MIT License (MIT). Please see [License File](LICENSE) for more information.

rollup.config.js

@@ -28,3 +28,3 @@ import commonjs from '@rollup/plugin-commonjs';
         {
-            file: 'dist/index.min.cjs',
+            file: 'dist/index.min.cjs.js',
             format: 'cjs',
@@ -36,3 +36,3 @@ plugins: [versionInject, terser()],
         {
-            file: 'dist/index.min.mjs',
+            file: 'dist/index.esm.min.js',
             format: 'esm',
@@ -45,3 +45,3 @@ plugins: [versionInject, terser()],
         {
-            file: 'dist/index.cjs',
+            file: 'dist/index.cjs.js',
             format: 'cjs',
@@ -53,3 +53,3 @@ sourcemap: options.sourceMapsEnabled,
         {
-            file: 'dist/index.mjs',
+            file: 'dist/index.esm.js',
             format: 'esm',
@@ -56,0 +56,0 @@ sourcemap: options.sourceMapsEnabled,

rollup.web-config.js

@@ -23,3 +23,3 @@ import commonjs from '@rollup/plugin-commonjs';
         {
-            file: 'dist/web.min.cjs',
+            file: 'dist/web.cjs.min.js',
             format: 'cjs',
@@ -31,3 +31,3 @@ plugins: [versionInject, terser()],
         {
-            file: 'dist/web.min.mjs',
+            file: 'dist/web.esm.min.mjs',
             format: 'esm',
@@ -40,3 +40,3 @@ plugins: [versionInject, terser()],
         {
-            file: 'dist/web.cjs',
+            file: 'dist/web.cjs.js',
             format: 'cjs',
@@ -48,3 +48,3 @@ sourcemap: options.sourceMapsEnabled,
         {
-            file: 'dist/web.mjs',
+            file: 'dist/web.esm.js',
             format: 'esm',
@@ -51,0 +51,0 @@ sourcemap:  options.sourceMapsEnabled,

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

721730

increased by0.17%

Lines of code

14973

increased by0.03%

Number of lines in readme file

225

increased by15.98%

No dependency changes