fs-jetpack - npm Package Compare versions

Comparing version 3.2.0 to 4.0.0

CHANGELOG.md

@@ -0,1 +1,4 @@
+# 4.0.0 (2020-10-22)
+- Package published to npm registry now contains only the essential files (e.g. no tests as shipped), to make the smallest footprint possible
+
 # 3.2.0 (2020-10-15)
@@ -2,0 +5,0 @@ - Ability to create temporary directories with `tmpDir()` method

package.json

 {
   "name": "fs-jetpack",
   "description": "Better file system API",
-  "version": "3.2.0",
+  "version": "4.0.0",
   "author": "Jakub Szwacz <[e-mail]>",
@@ -24,3 +24,3 @@ "dependencies": {
     "pretty-bytes": "^5.1.0",
-    "release-assist": "^1.0.1",
+    "release-assist": "^2.0.0",
     "ts-node": "^7.0.0",
@@ -38,2 +38,7 @@ "typescript": "^2.9.2"
   "main": "main.js",
+  "files": [
+    "lib",
+    "index.d.ts",
+    "types.d.ts"
+  ],
   "types": "index.d.ts",
@@ -40,0 +45,0 @@ "homepage": "https://github.com/szwacz/fs-jetpack",

README.md

@@ -12,3 +12,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)
 [Sync & Async](#sync--async)  
-[Usage with TypeScript](#usage-with-typescript)
+[Usage with TypeScript](#usage-with-typescript)  
+[Upgrading to New Version](#upgrading-to-new-version)
 
@@ -37,3 +38,3 @@ **API:**
 
-# Installation
+## Installation
 ```
@@ -43,3 +44,3 @@ npm install fs-jetpack
 
-## Usage
+### Usage
 ```javascript
@@ -49,3 +50,3 @@ const jetpack = require('fs-jetpack');
 
-# Sync & Async
+## Sync & Async
 
@@ -72,3 +73,3 @@ API has the same set of synchronous and asynchronous methods. All async methods are promise based (no callbacks).
 
-# Usage with TypeScript
+## Usage with TypeScript
 
@@ -85,2 +86,6 @@ 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`.
 
+## Upgrading to New Version
+
+This API is considered stable and all breaking changes to it are done as completely last resort. It also uses "better safe than sorry" approach to bumping major version number. So in 99.9% of cases you can upgrade to latest version with no worries, because all major version bumps are due to some edge case behaviour changes.
+
 # API
@@ -87,0 +92,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

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

Improved metrics

Number of lines in readme file

586

increased by0.86%

Worsened metrics

Total package byte prevSize

130103

decreased by-57.26%

Number of package files

31

decreased by-53.03%

Lines of code

2922

decreased by-66.76%

No dependency changes