fs-jetpack - npm Package Compare versions

Comparing version 2.0.0 to 2.1.0

CHANGELOG.md

@@ -0,1 +1,4 @@
+# 2.1.0 (2018-07-26)
+- From now on the library ships with TypeScript type definitions.
+
 # 2.0.0 (2018-07-10)
@@ -2,0 +5,0 @@ - **(breaking change)** removed `symlinks` config option of `find()` method. Now `find()` always follows symlinks.

package.json

 {
   "name": "fs-jetpack",
   "description": "Better file system API",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "author": "Jakub Szwacz <[e-mail]>",
@@ -10,2 +10,6 @@ "dependencies": {
   "devDependencies": {
+    "@types/chai": "^4.1.4",
+    "@types/fs-extra": "^5.0.4",
+    "@types/mocha": "^5.2.4",
+    "@types/node": "^10.5.2",
     "chai": "^4.1.2",
@@ -20,3 +24,5 @@ "codecov": "^3.0.2",
     "pretty-bytes": "^5.1.0",
-    "release-assist": "^1.0.1"
+    "release-assist": "^1.0.1",
+    "ts-node": "^7.0.0",
+    "typescript": "^2.9.2"
   },
@@ -27,6 +33,6 @@ "engines": {
   "scripts": {
-    "test": "mocha \"spec/**/*.spec.js\"",
-    "test-with-coverage": "istanbul cover _mocha -- 'spec/**/*.spec.js'",
+    "test": "mocha -r ts-node/register \"spec/**/*.spec.ts\"",
+    "test-with-coverage": "istanbul cover _mocha -- -r ts-node/register 'spec/**/*.spec.ts'",
     "lint-staged": "lint-staged",
-    "prettier": "prettier --write \"./**/*.js\"",
+    "prettier": "prettier --write \"./**/*.{js,ts}\"",
     "release-start": "release-assist --start",
@@ -36,2 +42,3 @@ "release-finish": "release-assist --finish"
   "main": "main.js",
+  "types": "index.d.ts",
   "homepage": "https://github.com/szwacz/fs-jetpack",
@@ -48,3 +55,3 @@ "repository": {
   "lint-staged": {
-    "*.js": [
+    "*.{js,ts}": [
       "prettier --write",
@@ -51,0 +58,0 @@ "git add"

README.md

@@ -11,3 +11,4 @@ fs-jetpack [![Build Status](https://travis-ci.org/szwacz/fs-jetpack.svg?branch=master)](https://travis-ci.org/szwacz/fs-jetpack) [![Build status](https://ci.appveyor.com/api/projects/status/er206e91fpuuqf58?svg=true)](https://ci.appveyor.com/project/szwacz/fs-jetpack) [![codecov](https://codecov.io/gh/szwacz/fs-jetpack/branch/master/graph/badge.svg)](https://codecov.io/gh/szwacz/fs-jetpack)
 [Installation](#installation)  
-[Sync & Async](#sync--async)
+[Sync & Async](#sync--async)  
+[Usage with TypeScript](#usage-with-typescript)
 
@@ -67,2 +68,14 @@ **API:**
 
+# Usage with TypeScript
+
+Starting from v2.1.0 fs-jetpack is TypeScript compatible. But for backwards compatibility purposes all types and interfaces are reachable through special path `fs-jetpack/types`.
+```typescript
+// Import fs-jetpack into TypeScript code (the jetpack typings will be loaded as well).
+import * as jetpack from "fs-jetpack";
+
+// Import one of jetpack's interface to cast it on a variable declaration.
+import { InspectResult } from "fs-jetpack/types";
+let result: InspectResult = jetpack.inspect("foo");
+```
+
 # API
@@ -69,0 +82,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

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

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

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

271526

increased by2.78%

Number of package files

64

increased by4.92%

Lines of code

7937

increased by2.45%

Number of lines in readme file

543

increased by2.45%

Number of low supply chain risk alerts

2

decreased by-91.3%

Worsened metrics

Dev dependency count

16

increased by60%

Number of medium supply chain risk alerts

2

increased by100%

No dependency changes