feat: clean static method

Author: shellscape

.circleci/config.yml

@@ -35,7 +35,7 @@ jobs:
           command: npm install
       - run:
           name: Run unit tests.
-          command: npm run ci:coverage
+          command: sudo npm run ci:coverage
       - run:
           name: Submit coverage data to codecov.
           command: bash <(curl -s https://codecov.io/bash)

README.md

@@ -99,6 +99,24 @@ Default: `wpr`
 
 Sets the name of the disk/drive/mount point for the RAMdisk. e.g. A value of `batman` would result in a disk root of `/Volumes/batman` on MacOS and `/mnt/batman` on Linux variants.
 
+## API
+
+### `WebpackPluginRamdisk.cleanup(diskPath)`
+Parameters: `diskPath` ⇒ `String` The mounted path of the RAMdisk to unmount and remove
+
+`Static`. Provides a convenience method to unmount and remove a RAMdisk created with the plugin.
+
+To remove the RAMdisk that the plugin created, first obtain the `diskPath` from the plugin:
+
+```js
+const { WebpackPluginRamdisk } = require('webpack-plugin-ramdisk');
+const plugin = new WebpackPluginRamdisk(options)
+const { diskPath } = plugin;
+
+WebpackPluginRamdisk.cleanup(diskPath);
+```
+
+_**Use Caution** as specifying the wrong `diskPath` can have unintended consequences and cause a loss of data. The commands this method utilize can remove other drives as well._
 
 ### Linux Users
 

lib/index.js

@@ -12,7 +12,7 @@ const { join } = require('path');
 
 const chalk = require('chalk');
 
-const { init } = require('./ramdisk');
+const { cleanup, init } = require('./ramdisk');
 const { validate } = require('./validate');
 
 const defaults = {
@@ -53,6 +53,10 @@ class WebpackPluginRamdisk {
 
     info(chalk.blue(`⬡ ${key}:`), `Build being written to ${outputPath}`);
   }
+
+  static cleanup(diskPath) {
+    return cleanup(diskPath);
+  }
 }
 
 module.exports = { defaults, WebpackPluginRamdisk };

lib/ramdisk.js

@@ -46,6 +46,12 @@ const mount = (options) => {
 };
 
 module.exports = {
+  cleanup(diskPath) {
+    const command =
+      process.platform === 'darwin' ? `hdiutil detach ${diskPath}` : `sudo umount ${diskPath}`;
+    return execa.commandSync(command);
+  },
+
   init(opts) {
     const root = getRoot(opts.name);
     const blocks = opts.bytes / opts.blockSize;

test/plugin.test.js

@@ -6,11 +6,7 @@ const execa = require('execa');
 
 const { WebpackPluginRamdisk } = require('../lib');
 
-const detatch = (diskPath) => {
-  const command =
-    process.platform === 'darwin' ? `hdiutil detach ${diskPath}` : `sudo umount ${diskPath}`;
-  execa.commandSync(command);
-};
+const detatch = WebpackPluginRamdisk.cleanup;
 
 const getSize = (diskPath) => {
   const { stdout } = execa.commandSync(`df -H ${diskPath}`);