check-disk-space 3.0.1 → 3.3.0

package/dist/{check-disk-space.cjs.js → check-disk-space.cjs}

@@ -4,6 +4,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var child_process = require('child_process');
 var fs = require('fs');
+var os = require('os');
 var path = require('path');
 
 class InvalidPathError extends Error {
@@ -40,6 +41,19 @@ function getFirstExistingParentPath(directoryPath, dependencies) {
     return parentDirectoryPath;
 }
 
+/**
+ * Tell if PowerShell 3 is available based on Windows version
+ *
+ * Note: 6.* is Windows 7
+ * Note: PowerShell 3 is natively available since Windows 8
+ *
+ * @param release - OS Release number
+ */
+function hasPowerShell3(release) {
+    const major = parseInt(release.split('.')[0], 10);
+    return major > 6;
+}
+
 /**
  * Check disk space
  *
@@ -48,11 +62,14 @@ function getFirstExistingParentPath(directoryPath, dependencies) {
  */
 function checkDiskSpace(directoryPath, dependencies = {
     platform: process.platform,
+    release: os.release(),
     fsExistsSync: fs.existsSync,
     pathNormalize: path.normalize,
     pathSep: path.sep,
     cpExecFile: child_process.execFile,
 }) {
+    // Note: This function contains other functions in order
+    //       to wrap them in a common context and make unit tests easier
     /**
      * Maps command output to a normalized object {diskPath, free, size}
      *
@@ -89,7 +106,7 @@ function checkDiskSpace(directoryPath, dependencies = {
             const [file, ...args] = cmd;
             /* istanbul ignore if */
             if (file === undefined) {
-                return Promise.reject('cmd must contain at least one item');
+                return Promise.reject(new Error('cmd must contain at least one item'));
             }
             dependencies.cpExecFile(file, args, (error, stdout) => {
                 if (error) {
@@ -115,7 +132,18 @@ function checkDiskSpace(directoryPath, dependencies = {
                 reject(new InvalidPathError(`The following path is invalid (should be X:\\...): ${directoryPath}`));
             });
         }
-        return check(['wmic', 'logicaldisk', 'get', 'size,freespace,caption'], driveData => {
+        const powershellCmd = [
+            'powershell',
+            'Get-CimInstance -ClassName Win32_LogicalDisk | Select-Object Caption, FreeSpace, Size',
+        ];
+        const wmicCmd = [
+            'wmic',
+            'logicaldisk',
+            'get',
+            'size,freespace,caption',
+        ];
+        const cmd = hasPowerShell3(dependencies.release) ? powershellCmd : wmicCmd;
+        return check(cmd, driveData => {
             // Only get the drive which match the path
             const driveLetter = driveData[0];
             return directoryPath.toUpperCase().startsWith(driveLetter.toUpperCase());
@@ -137,7 +165,12 @@ function checkDiskSpace(directoryPath, dependencies = {
             });
         }
         const pathToCheck = getFirstExistingParentPath(directoryPath, dependencies);
-        return check(['df', '-Pk', '--', pathToCheck], () => true, // We should only get one line, so we did not need to filter
+        return check([
+            'df',
+            '-Pk',
+            '--',
+            pathToCheck,
+        ], () => true, // We should only get one line, so we did not need to filter
         {
             diskPath: 5,
             free: 3,
@@ -153,5 +186,5 @@ function checkDiskSpace(directoryPath, dependencies = {
 
 exports.InvalidPathError = InvalidPathError;
 exports.NoMatchError = NoMatchError;
-exports.default = checkDiskSpace;
+exports["default"] = checkDiskSpace;
 exports.getFirstExistingParentPath = getFirstExistingParentPath;

package/dist/check-disk-space.d.ts

@@ -1,4 +1,4 @@
-import { ExecFileException, ChildProcess } from 'child_process';
+import { ChildProcess, ExecException } from 'child_process';
 import { existsSync } from 'fs';
 import { normalize, sep } from 'path';
 
@@ -12,8 +12,10 @@ declare class NoMatchError extends Error {
     constructor(message?: string);
 }
 
+declare type ExecFileException = ExecException & NodeJS.ErrnoException;
 declare type Dependencies = {
     platform: NodeJS.Platform;
+    release: string;
     fsExistsSync: typeof existsSync;
     pathNormalize: typeof normalize;
     pathSep: typeof sep;
@@ -45,5 +47,4 @@ declare type DiskSpace = {
  */
 declare function checkDiskSpace(directoryPath: string, dependencies?: Dependencies): Promise<DiskSpace>;
 
-export default checkDiskSpace;
-export { Dependencies, DiskSpace, InvalidPathError, NoMatchError, getFirstExistingParentPath };
+export { Dependencies, DiskSpace, InvalidPathError, NoMatchError, checkDiskSpace as default, getFirstExistingParentPath };

package/dist/{check-disk-space.es.js → check-disk-space.mjs}

@@ -1,5 +1,6 @@
 import { execFile } from 'child_process';
 import { existsSync } from 'fs';
+import { release } from 'os';
 import { normalize, sep } from 'path';
 
 class InvalidPathError extends Error {
@@ -36,6 +37,19 @@ function getFirstExistingParentPath(directoryPath, dependencies) {
     return parentDirectoryPath;
 }
 
+/**
+ * Tell if PowerShell 3 is available based on Windows version
+ *
+ * Note: 6.* is Windows 7
+ * Note: PowerShell 3 is natively available since Windows 8
+ *
+ * @param release - OS Release number
+ */
+function hasPowerShell3(release) {
+    const major = parseInt(release.split('.')[0], 10);
+    return major > 6;
+}
+
 /**
  * Check disk space
  *
@@ -44,11 +58,14 @@ function getFirstExistingParentPath(directoryPath, dependencies) {
  */
 function checkDiskSpace(directoryPath, dependencies = {
     platform: process.platform,
+    release: release(),
     fsExistsSync: existsSync,
     pathNormalize: normalize,
     pathSep: sep,
     cpExecFile: execFile,
 }) {
+    // Note: This function contains other functions in order
+    //       to wrap them in a common context and make unit tests easier
     /**
      * Maps command output to a normalized object {diskPath, free, size}
      *
@@ -85,7 +102,7 @@ function checkDiskSpace(directoryPath, dependencies = {
             const [file, ...args] = cmd;
             /* istanbul ignore if */
             if (file === undefined) {
-                return Promise.reject('cmd must contain at least one item');
+                return Promise.reject(new Error('cmd must contain at least one item'));
             }
             dependencies.cpExecFile(file, args, (error, stdout) => {
                 if (error) {
@@ -111,7 +128,18 @@ function checkDiskSpace(directoryPath, dependencies = {
                 reject(new InvalidPathError(`The following path is invalid (should be X:\\...): ${directoryPath}`));
             });
         }
-        return check(['wmic', 'logicaldisk', 'get', 'size,freespace,caption'], driveData => {
+        const powershellCmd = [
+            'powershell',
+            'Get-CimInstance -ClassName Win32_LogicalDisk | Select-Object Caption, FreeSpace, Size',
+        ];
+        const wmicCmd = [
+            'wmic',
+            'logicaldisk',
+            'get',
+            'size,freespace,caption',
+        ];
+        const cmd = hasPowerShell3(dependencies.release) ? powershellCmd : wmicCmd;
+        return check(cmd, driveData => {
             // Only get the drive which match the path
             const driveLetter = driveData[0];
             return directoryPath.toUpperCase().startsWith(driveLetter.toUpperCase());
@@ -133,7 +161,12 @@ function checkDiskSpace(directoryPath, dependencies = {
             });
         }
         const pathToCheck = getFirstExistingParentPath(directoryPath, dependencies);
-        return check(['df', '-Pk', '--', pathToCheck], () => true, // We should only get one line, so we did not need to filter
+        return check([
+            'df',
+            '-Pk',
+            '--',
+            pathToCheck,
+        ], () => true, // We should only get one line, so we did not need to filter
         {
             diskPath: 5,
             free: 3,
@@ -147,5 +180,4 @@ function checkDiskSpace(directoryPath, dependencies = {
     return checkUnix(directoryPath);
 }
 
-export default checkDiskSpace;
-export { InvalidPathError, NoMatchError, getFirstExistingParentPath };
+export { InvalidPathError, NoMatchError, checkDiskSpace as default, getFirstExistingParentPath };

package/package.json

@@ -1,18 +1,17 @@
 {
   "name": "check-disk-space",
-  "version": "3.0.1",
+  "version": "3.3.0",
   "description": "Light multi-platform disk space checker without third party for Node.js",
   "files": [
-    "dist"
+    "dist",
+    "README.md"
   ],
-  "main": "./dist/check-disk-space.cjs.js",
-  "module": "./dist/check-disk-space.es.js",
+  "main": "./dist/check-disk-space.cjs",
+  "module": "./dist/check-disk-space.mjs",
   "types": "./dist/check-disk-space.d.ts",
   "exports": {
-    ".": {
-      "import": "./dist/check-disk-space.es.js",
-      "require": "./dist/check-disk-space.cjs.js"
-    }
+    "import": "./dist/check-disk-space.mjs",
+    "require": "./dist/check-disk-space.cjs"
   },
   "scripts": {
     "build:lib": "rollup --config",
@@ -43,26 +42,26 @@
     "node": ">=12"
   },
   "devDependencies": {
-    "@alex-d/eslint-config": "1.0.3",
-    "@istanbuljs/nyc-config-typescript": "^1.0.1",
-    "@rollup/plugin-typescript": "8.2.1",
-    "@types/node": "15.12.2",
-    "@typescript-eslint/eslint-plugin": "4.26.1",
-    "@typescript-eslint/parser": "4.26.1",
-    "ava": "3.15.0",
-    "eslint": "7.28.0",
-    "eslint-plugin-ava": "12.0.0",
-    "eslint-plugin-import": "2.23.4",
+    "@alex-d/eslint-config": "2.0.0",
+    "@istanbuljs/nyc-config-typescript": "1.0.2",
+    "@rollup/plugin-typescript": "8.3.1",
+    "@types/node": "12.20.46",
+    "@typescript-eslint/eslint-plugin": "5.13.0",
+    "@typescript-eslint/parser": "5.13.0",
+    "ava": "4.1.0",
+    "eslint": "8.10.0",
+    "eslint-plugin-ava": "13.2.0",
+    "eslint-plugin-import": "2.25.4",
     "eslint-plugin-simple-import-sort": "7.0.0",
     "npm-run-all": "4.1.5",
-    "nyc": "^15.1.0",
-    "rollup": "2.51.2",
-    "rollup-plugin-dts": "3.0.2",
-    "source-map-support": "^0.5.19",
-    "ts-node": "^10.0.0",
-    "tsconfig-paths": "^3.9.0",
-    "tslib": "^2.3.0",
-    "typescript": "4.3.2"
+    "nyc": "15.1.0",
+    "rollup": "2.69.2",
+    "rollup-plugin-dts": "4.2.0",
+    "source-map-support": "0.5.21",
+    "ts-node": "10.7.0",
+    "tsconfig-paths": "3.13.0",
+    "tslib": "2.3.1",
+    "typescript": "4.6.2"
   },
   "repository": {
     "type": "git",