check-disk-space 1.3.0 → 2.1.0

package/.github/FUNDING.yml

@@ -0,0 +1,4 @@
+# These are supported funding model platforms
+
+github: [Alex-D]
+patreon: AlexandreDemode

package/.travis.yml

@@ -1,6 +1,6 @@
 sudo: false
 language: node_js
 node_js:
+  - '12'
+  - '10'
   - '8'
-  - '7'
-  - '6'

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017 Alexandre Demode
+Copyright (c) 2017-2019 Alexandre Demode
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/index.js

@@ -11,6 +11,7 @@ const InvalidPathError = function (message) {
   this.name = 'InvalidPathError'
   this.message = message || ''
 }
+
 util.inherits(InvalidPathError, Error)
 
 const NoMatchError = function (message) {
@@ -18,6 +19,7 @@ const NoMatchError = function (message) {
   this.name = 'NoMatchError'
   this.message = message || ''
 }
+
 util.inherits(NoMatchError, Error)
 
 /**
@@ -39,9 +41,11 @@ function mapOutput(stdout, filter, mapping, coefficient = 1) {
   if (filtered.length === 0) {
     throw new NoMatchError()
   }
+
   filtered = filtered[0]
 
   return {
+    diskPath: filtered[mapping.diskPath],
     free: parseInt(filtered[mapping.free], 10) * coefficient,
     size: parseInt(filtered[mapping.size], 10) * coefficient
   }
@@ -65,8 +69,8 @@ function check(cmd, filter, mapping, coefficient = 1) {
 
       try {
         resolve(mapOutput(stdout, filter, mapping, coefficient))
-      } catch (err) {
-        reject(err)
+      } catch (error2) {
+        reject(error2)
       }
     })
   })
@@ -86,13 +90,14 @@ function checkWin32(directoryPath) {
   }
 
   return check(
-    `wmic logicaldisk get size,freespace,caption`,
+    'wmic logicaldisk get size,freespace,caption',
     driveData => {
       // Only get the drive which match the path
       const driveLetter = driveData[0]
       return directoryPath.startsWith(driveLetter)
     },
     {
+      diskPath: 0,
       free: 1,
       size: 2
     }
@@ -113,9 +118,10 @@ function checkUnix(directoryPath) {
   }
 
   return check(
-    `df -Pk ${module.exports.getFirstExistingParentPath(directoryPath)}`,
+    `df -Pk "${module.exports.getFirstExistingParentPath(directoryPath)}"`,
     () => true, // We should only get one line, so we did not need to filter
     {
+      diskPath: 5,
       free: 3,
       size: 1
     },
@@ -129,8 +135,8 @@ module.exports = (process.platform === 'win32') ? checkWin32 : checkUnix
 /**
  * Get the first existing parent path
  *
- * @param directoryPath
- * @returns {*}
+ * @param {String} directoryPath - The file/folder path from where we want to know disk space
+ * @returns {String} - The first existing parent path
  */
 module.exports.getFirstExistingParentPath = directoryPath => {
   let parentDirectoryPath = directoryPath

package/package.json

@@ -1,14 +1,18 @@
 {
   "name": "check-disk-space",
-  "version": "1.3.0",
-  "description": "Light multiplartform disk space checker without third party for Node.js",
+  "version": "2.1.0",
+  "description": "Light multi-platform disk space checker without third party for Node.js",
   "main": "index.js",
+  "engines": {
+    "node": ">=8"
+  },
   "dependencies": {},
   "devDependencies": {
-    "ava": "0.22.0",
-    "eslint-plugin-ava": "^4.2.2",
-    "npm-run-all": "^4.1.1",
-    "xo": "^0.18.2"
+    "ava": "^2.0.0",
+    "eslint": "^5.16.0",
+    "eslint-plugin-ava": "^7.0.0",
+    "npm-run-all": "^4.1.5",
+    "xo": "^0.24.0"
   },
   "xo": {
     "space": true,
@@ -29,6 +33,7 @@
     "hdd",
     "free"
   ],
+  "types": "./typings/index.d.ts",
   "author": "Alex-D <contact@alex-d.fr> (http://alex-d.fr)",
   "license": "MIT",
   "bugs": {

package/test.js

@@ -15,6 +15,7 @@ const platformFixtures = {
           F:       834660716544  2000396742656
       `,
       result: {
+        diskPath: 'D:',
         free: 0,
         size: 699783168
       }
@@ -32,6 +33,7 @@ const platformFixtures = {
           L:
       `,
       result: {
+        diskPath: 'C:',
         free: 1286164480,
         size: 34359734272
       }
@@ -45,6 +47,7 @@ const platformFixtures = {
           D:       0             59494400
       `,
       result: {
+        diskPath: 'D:',
         free: 0,
         size: 59494400
       }
@@ -58,6 +61,7 @@ const platformFixtures = {
           D:       0             4001759232
       `,
       result: {
+        diskPath: 'C:',
         free: 159345410048,
         size: 171204145152
       }
@@ -72,6 +76,7 @@ const platformFixtures = {
           devtmpfs          447624       0    447624   0% /dev
       `,
       result: {
+        diskPath: '/dev',
         free: 447624 * 1024,
         size: 447624 * 1024
       }
@@ -84,6 +89,7 @@ const platformFixtures = {
           tmpfs                89884       8     89876       1% /run/user/1000
       `,
       result: {
+        diskPath: '/run/user/1000',
         free: 89876 * 1024,
         size: 89884 * 1024
       }
@@ -96,6 +102,7 @@ const platformFixtures = {
           /dev/sdc         240234168    188729228 39278628         83% /media/Games
       `,
       result: {
+        diskPath: '/media/Games',
         free: 39278628 * 1024,
         size: 240234168 * 1024
       }
@@ -110,6 +117,7 @@ const platformFixtures = {
           /dev/disk0s2    145961032 20678788 125026244    15%    /home
       `,
       result: {
+        diskPath: '/home',
         free: 125026244 * 1024,
         size: 145961032 * 1024
       }
@@ -119,7 +127,7 @@ const platformFixtures = {
 
 function mockCheckDiskSpace(platform, fixture) {
   // Clean some required paths
-  delete require.cache[require.resolve('./')]
+  delete require.cache[require.resolve('.')]
 
   // Forces the platform for test purposes
   Object.defineProperty(process, 'platform', {value: platform})
@@ -131,12 +139,12 @@ function mockCheckDiskSpace(platform, fixture) {
     })
   }
 
-  return require('./')
+  return require('.')
 }
 
 function mockGetFirstExistingParentPath(existingDirectoryPath) {
   // Clean some required paths
-  delete require.cache[require.resolve('./')]
+  delete require.cache[require.resolve('.')]
 
   // Forces the platform for test purposes
   Object.defineProperty(process, 'platform', {value: 'linux'})
@@ -144,7 +152,7 @@ function mockGetFirstExistingParentPath(existingDirectoryPath) {
   // Mock child_process.exec
   require('fs').existsSync = directoryPath => directoryPath === existingDirectoryPath
 
-  return require('./').getFirstExistingParentPath
+  return require('.').getFirstExistingParentPath
 }
 
 Object.keys(platformFixtures).forEach(platform => {
@@ -157,40 +165,40 @@ Object.keys(platformFixtures).forEach(platform => {
   })
 })
 
-test(`win32: path did not match any disk`, async t => {
+test('win32: path did not match any disk', async t => {
   const checkDiskSpace = mockCheckDiskSpace('win32', platformFixtures.win32[0])
-  const error = await t.throws(checkDiskSpace('Z:/shouldfail'))
+  const error = await t.throwsAsync(checkDiskSpace('Z:/shouldfail'))
   t.is(error.name, 'NoMatchError')
 })
 
-test(`win32: invalid path`, async t => {
+test('win32: invalid path', async t => {
   const checkDiskSpace = mockCheckDiskSpace('win32', platformFixtures.win32[0])
-  const error = await t.throws(checkDiskSpace('an invalid path'))
+  const error = await t.throwsAsync(checkDiskSpace('an invalid path'))
   t.is(error.name, 'InvalidPathError')
 })
 
-test(`unix: invalid path`, async t => {
+test('unix: invalid path', async t => {
   const checkDiskSpace = mockCheckDiskSpace('linux', platformFixtures.linux[0])
-  const error = await t.throws(checkDiskSpace('an invalid path'))
+  const error = await t.throwsAsync(checkDiskSpace('an invalid path'))
   t.is(error.name, 'InvalidPathError')
 })
 
-test(`exec has an error`, async t => {
+test('exec has an error', async t => {
   const fixture = JSON.parse(JSON.stringify(platformFixtures.win32[0]))
   fixture.execError = new Error('some error')
 
   const checkDiskSpace = mockCheckDiskSpace('win32', fixture)
-  const error = await t.throws(checkDiskSpace('C:/something'))
+  const error = await t.throwsAsync(checkDiskSpace('C:/something'))
   t.is(error.message, 'some error')
 })
 
-test(`unix: get first existing parent path`, t => {
+test('unix: get first existing parent path', t => {
   const parentPath = '/home/Lisa'
   const getFirstExistingParentPath = mockGetFirstExistingParentPath(parentPath)
   t.is(getFirstExistingParentPath('/home/Lisa/games/Ankama/Dofus'), parentPath)
 })
 
-test(`unix: get first parent can be the path itself`, t => {
+test('unix: get first parent can be the path itself', t => {
   const parentPath = '/home/Lisa'
   const getFirstExistingParentPath = mockGetFirstExistingParentPath(parentPath)
   t.is(getFirstExistingParentPath(parentPath), parentPath)

package/typings/index.d.ts

@@ -0,0 +1,77 @@
+declare module "check-disk-space" {
+  namespace checkDiskSpace {
+    /**
+     * The result of the disk space check
+     */
+    interface CheckDiskSpaceResult {
+      /**
+       * How much space is left
+       */
+      free: number;
+      /**
+       * The size of the path
+       */
+      size: number;
+    }
+
+    /**
+     * Error for invalid path
+     */
+    class InvalidPathError {
+      constructor(message: string);
+      /**
+       * The name of the error
+       */
+      name: "InvalidPathError";
+      /**
+       * The error message
+       */
+      message: string | "";
+    }
+
+    /**
+     * Error for path which do not match the actual file system
+     */
+    class NoMatchError {
+      constructor(message: any);
+      /**
+       * The name of the error
+       */
+      name: "NoMatchError";
+      /**
+       * The error message
+       */
+      message: string | "";
+    }
+
+    /**
+     * Get the first existing parent path
+     *
+     * @param {string} directoryPath The file/folder path from where we want to know disk space
+     * @returns {string} The first existing parent path
+     */
+    function getFirstExistingParentPath(directoryPath: string): string;
+  }
+
+  /**
+   * Build the check call for unix or win32
+   *
+   * @param {string} directoryPath The file/folder path from where we want to know disk space
+   * @return {Promise<CheckDiskSpaceResult>} The result of the check
+   *
+   * @example
+   * // On Windows
+   * const diskSpace = await checkDiskSpace('C:/blabla/bla');
+   * console.log(diskSpace); // { free: 12345678, size: 98756432 }
+   *
+   * @example
+   * const diskSpace = await checkDiskSpace('/mnt/mygames');
+   * console.log(diskSpace); // { free: 12345678, size: 98756432 }
+   *
+   * @throws {NoMatchError} In case the given path does not match with the actual file system
+   * @throws {InvalidPathError} In case the path is invalid
+   */
+  function checkDiskSpace(directoryPath: string): Promise<checkDiskSpace.CheckDiskSpaceResult>;
+
+  export = checkDiskSpace;
+}

package/typings/index.test.ts

@@ -0,0 +1,19 @@
+import * as checkDiskSpace from 'check-disk-space';
+
+(async () => {
+  try {
+    const diskSpace = await checkDiskSpace('/mnt/mygames');
+    diskSpace.free;
+    diskSpace.size;
+  } catch (err) {
+    if (err instanceof checkDiskSpace.InvalidPathError) {
+      console.error('Invalid Path Error');
+    } else if (err instanceof checkDiskSpace.NoMatchError) {
+      console.error('No Match Error');
+    } else {
+      console.error('Error');
+    }
+  }
+})();
+
+checkDiskSpace.getFirstExistingParentPath('/path');

package/.idea/check-disk-space.iml

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<module type="WEB_MODULE" version="4">
-  <component name="NewModuleRootManager">
-    <content url="file://$MODULE_DIR$" />
-    <orderEntry type="inheritedJdk" />
-    <orderEntry type="sourceFolder" forTests="false" />
-  </component>
-</module>

package/.idea/jsLibraryMappings.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="JavaScriptLibraryMappings">
-    <includedPredefinedLibrary name="Node.js Core" />
-  </component>
-</project>

package/.idea/jsLinters/eslint.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="EslintConfiguration">
-    <custom-configuration-file used="true" path="$PROJECT_DIR$/.eslintrc.yml" />
-  </component>
-</project>

package/.idea/misc.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="JavaScriptSettings">
-    <option name="languageLevel" value="ES6" />
-  </component>
-</project>

package/.idea/modules.xml

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectModuleManager">
-    <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/check-disk-space.iml" filepath="$PROJECT_DIR$/.idea/check-disk-space.iml" />
-    </modules>
-  </component>
-</project>

package/.idea/vcs.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="VcsDirectoryMappings">
-    <mapping directory="$PROJECT_DIR$" vcs="Git" />
-  </component>
-</project>