electron-installer-snap - npm Package Compare versions

Comparing version 5.0.0 to 5.1.0

NEWS.md

@@ -5,4 +5,12 @@ # Electron Installer: Snap - Changes by Version
 
-[Unreleased]: https://github.com/electron-userland/electron-installer-snap/compare/v5.0.0...master
+[Unreleased]: https://github.com/electron-userland/electron-installer-snap/compare/v5.1.0...master
 
+## [5.1.0] - 2020-04-25
+
+[5.1.0]: https://github.com/electron-userland/electron-installer-snap/compare/v5.0.0...v5.1.0
+
+### Added
+
+* TypeScript definition (#72)
+
 ## [5.0.0] - 2020-01-21
@@ -9,0 +17,0 @@

package.json

 {
   "name": "electron-installer-snap",
-  "version": "5.0.0",
+  "version": "5.1.0",
   "description": "Build snapcraft packages for Electron applications",
@@ -8,2 +8,3 @@ "author": "Mark Lee",
   "main": "src/index.js",
+  "types": "src/index.d.ts",
   "bin": {
@@ -15,3 +16,4 @@ "electron-installer-snap": "src/cli.js"
     "resources",
-    "src"
+    "src",
+    "src/index.d.ts"
   ],
@@ -22,5 +24,9 @@ "scripts": {
     "coverage": "nyc ava",
-    "lint": "eslint .",
+    "docs:build": "node ci/build_docs.js",
+    "eslint:js": "eslint .",
+    "eslint:ts": "eslint --ext .ts --config .eslintrc.typescript.js .",
+    "lint": "npm run eslint:js && npm run eslint:ts && npm run tsd",
     "test": "npm run lint && ava",
-    "test:fast": "cross-env FAST_TESTS_ONLY=1 npm test"
+    "test:fast": "cross-env FAST_TESTS_ONLY=1 npm test",
+    "tsd": "tsd"
   },
@@ -36,5 +42,7 @@ "repository": "electron-userland/electron-installer-snap",
   "devDependencies": {
+    "@typescript-eslint/eslint-plugin": "^2.26.0",
+    "@typescript-eslint/parser": "^2.26.0",
     "ava": "^3.0.0",
     "codecov": "^3.1.0",
-    "cross-env": "^6.0.0",
+    "cross-env": "^7.0.0",
     "eslint": "^6.0.1",
@@ -47,9 +55,15 @@ "eslint-config-standard": "^14.0.0",
     "eslint-plugin-standard": "^4.0.0",
+    "husky": "^4.2.3",
+    "lint-staged": "^10.1.2",
     "nyc": "^15.0.0",
-    "sinon": "^8.0.4"
+    "sinon": "^9.0.0",
+    "tsd": "^0.11.0",
+    "typedoc": "^0.17.3",
+    "typescript": "^3.8.3"
   },
   "dependencies": {
+    "@malept/cross-spawn-promise": "^1.0.0",
     "debug": "^4.1.1",
-    "electron-installer-common": "^0.10.0",
-    "fs-extra": "^8.0.1",
+    "electron-installer-common": "^0.10.1",
+    "fs-extra": "^9.0.0",
     "js-yaml": "^3.10.0",
@@ -97,5 +111,24 @@ "lodash": "^4.17.15",
   },
+  "eslintIgnore": [
+    "typedoc"
+  ],
   "funding": {
     "url": "https://github.com/electron-userland/electron-installer-snap?sponsor=1"
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged"
+    }
+  },
+  "lint-staged": {
+    "*.js": [
+      "eslint . --fix"
+    ],
+    "*.ts": [
+      "npm run eslint:ts -- --fix"
+    ]
+  },
+  "tsd": {
+    "directory": "test"
   }
 }

README.md

@@ -45,4 +45,3 @@ # Electron Installer: Snap
 
-For the JavaScript API, please see the [API
-docs](https://github.com/electron-userland/electron-installer-snap/blob/master/docs/api.md).
+For the JavaScript API, please see the [API docs](https://electron-userland.github.io/electron-installer-snap/).
 
@@ -49,0 +48,0 @@ ## Thanks

src/snapcraft.js

@@ -19,3 +19,3 @@ 'use strict'
 const debug = require('debug')('electron-installer-snap:snapcraft')
-const { spawn } = require('electron-installer-common')
+const { spawn } = require('@malept/cross-spawn-promise')
 const which = require('which')
@@ -22,0 +22,0 @@

src/yaml.js

@@ -24,2 +24,3 @@ 'use strict'
 const semver = require('semver')
+const { spawn } = require('@malept/cross-spawn-promise')
 const which = require('which')
@@ -104,5 +105,5 @@ const yaml = require('js-yaml')
   async detectDistro (lsbRelease) {
-    const output = await common.spawn(lsbRelease, ['--short', '--id', '--release'])
+    const output = await spawn(lsbRelease, ['--short', '--id', '--release'])
     if (output) {
-      return output.toString().trim().split('\n')
+      return output.trim().split('\n')
     }
@@ -109,0 +110,0 @@

No alert changes

Improved metrics

Total package byte prevSize

373066

increased by2.19%

Number of package files

18

increased by5.88%

Lines of code

867

increased by34.21%

Worsened metrics

Dependency count

10

increased by11.11%

Dev dependency count

19

increased by58.33%

Number of lines in readme file

55

decreased by-1.79%

Dependency changes

• + Added@malept/cross-spawn-promise@^1.0.0

• - Removedfs-extra@8.1.0(transitive)

• - Removedjsonfile@4.0.0(transitive)

• - Removeduniversalify@0.1.2(transitive)

• Updatedelectron-installer-common@^0.10.1

• Updatedfs-extra@^9.0.0