libxmljs - npm Package Compare versions

Comparing version 1.0.1 to 1.0.2

package.json

 {
   "name": "libxmljs",
-  "author": "Marco Rogers",
-  "contributors": [
-    "Jeff Smick"
-  ],
   "binary": {
@@ -15,3 +11,3 @@ "module_name": "xmljs",
   "description": "libxml bindings for v8 javascript engine",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "repository": {
@@ -31,7 +27,9 @@ "type": "git",
   "scripts": {
+    "init": "node scripts/init.js",
+    "init-submodules": "git submodule update --init --recursive",
     "configure": "cd vendor/libxml2.config && cmake configure ../libxml2 && cd ../..",
-    "install": "node-pre-gyp install --fallback-to-build --loglevel http",
-    "build": "node-gyp rebuild",
-    "build-debug": "node-gyp rebuild --debug",
-    "swig": "bash scripts/swig.sh && node scripts/swigfix.js",
+    "install": "node-pre-gyp install --loglevel http || (npm run init && npm run build)",
+    "build": "node-gyp rebuild -j max",
+    "build-debug": "node-gyp rebuild -j max --debug",
+    "swig": "npm run init && bash scripts/swig.sh && node scripts/swigfix.js",
     "tsgenerate": "node scripts/swig2ts.js",
@@ -49,3 +47,3 @@ "tsgenerate-debug": "lldb -- `which node` scripts/swig2ts.js",
     "bindings": "~1.3.0",
-    "nan": "~2.14.0"
+    "nan": "~2.17.0"
   },
@@ -52,0 +50,0 @@ "devDependencies": {

README.md

@@ -1,7 +0,18 @@
-# Libxmljs
+# libxmljs
 
+[![npm version](https://badge.fury.io/js/libxmljs.svg)](https://badge.fury.io/js/libxmljs)
 [![Test & Upload](https://github.com/libxmljs/libxmljs/actions/workflows/test-deploy.yml/badge.svg)](https://github.com/libxmljs/libxmljs/actions/workflows/test-deploy.yml)
 
-LibXML bindings for [node.js](http://nodejs.org/)
+`npm install libxmljs`
 
+NodeJS bindings for [libxml2](https://en.wikipedia.org/wiki/Libxml2) written in [Typescript](https://www.typescriptlang.org/)
+
+## Documentation
+
+[https://libxmljs.github.io/libxmljs/](https://libxmljs.github.io/libxmljs/)
+
+## Examples
+
+For more examples, check out the [test suite](https://github.com/libxmljs/libxmljs/tree/master/test).
+
 ```javascript
@@ -31,32 +42,41 @@ var libxmljs = require("libxmljs");
 
-## Docs
+## Package Scripts
 
-[https://libxmljs.github.io/libxmljs/](https://libxmljs.github.io/libxmljs/)
+`npm run init-submodules`
 
-## Support
+> Clones libxml2 source code to `vendor/libxml2`
 
--   Docs - [http://github.com/libxmljs/libxmljs/wiki](http://github.com/libxmljs/libxmljs/wiki)
--   Mailing list - [http://groups.google.com/group/libxmljs](http://groups.google.com/group/libxmljs)
+`npm run configure`
 
-## API and Examples
+> Generate new cmake config headers with cmake in vendor/libxml2.config.
+> Used when updating to a new libxml2 version.
 
-Check out the wiki [http://github.com/libxmljs/libxmljs/wiki](http://github.com/libxmljs/libxmljs/wiki).
+`npm run build`
 
-See the [examples](https://github.com/libxmljs/libxmljs/tree/master/examples) folder.
+> Build the C++ source code using node-gyp
 
-## Installation via [npm](https://npmjs.org)
+`npm run swig`
 
-```shell
-npm install libxmljs
-```
+> Generate a new `src/libxml2.cc` and `swig.xml` file by processing the native code using SWIG.
+> Used when making changes to native code or any of the SWIG interface files (src/*.i)
 
-## Contribute
+`npm run tsgenerate`
 
-Start by checking out the [open issues](https://github.com/libxmljs/libxmljs/issues?labels=&page=1&state=open).
-Specifically the [desired feature](https://github.com/libxmljs/libxmljs/issues?labels=desired+feature&page=1&state=open)
-ones.
+> Generates typescript definitons for native bindings exports.
+> Used when changes are made to native exports.
+> Auto-generates `constants.ts`, `functions.ts`, `types.ts`, and `variables.ts` within `lib/bindings/`
 
-### Requirements
+`npm run tsc`
 
-Make sure you have met the requirements for [node-gyp](https://github.com/TooTallNate/node-gyp#installation). You DO NOT
-need to manually install node-gyp; it comes bundled with node.
+> Compiles Typescript within `lib/` and outputs it to `dist/`
+> Use `npm run dev` to put Typescript compiler into watch mode.
+
+`npm run test`
+
+> Runs all tests in `test/` using nodeunit.
+> Use `npm run test -- -t TEST_NAME` to run a specific test.
+
+`npm run docs`
+
+> Generates `docs/` using Typedoc
+

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

Install scripts

Supply chain risk

Install scripts are run when the package is installed. The majority of malware in npm is hidden in install scripts.

Found 1 instance in 1 package

Shell access

Supply chain risk

This module accesses the system shell. Accessing the system shell increases the risk of executing arbitrary code.

Found 1 instance in 1 package

No contributors or author data

Maintenance

Package does not specify a list of contributors or an author in package.json.

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

Install scripts

Supply chain risk

Install scripts are run when the package is installed. The majority of malware in npm is hidden in install scripts.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

6350835

increased by0.19%

Lines of code

33114

increased by0.04%

Number of lines in readme file

82

increased by32.26%

Worsened metrics

Number of low maintenance alerts

1

increased byInfinity%

Number of low supply chain risk alerts

7

increased by16.67%

Number of medium supply chain risk alerts

2

increased by100%

Dependency changes

• + Addednan@2.17.0(transitive)

• - Removednan@2.14.2(transitive)

• Updatednan@~2.17.0