updates

- accept `driveLetter` option for mapping
- accept `persistent` option
- export debug namespace
- dependencies

Author: dangowans

.github/workflows/coverage.yml

@@ -10,17 +10,19 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node: [ 18, 20, 21 ]
+        node: [ 22, 24 ]
     env:
-      DEEPSOURCE_DSN: ${{ secrets.DEEPSOURCE_DSN }}
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+
     name: Node ${{ matrix.node }}
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
       - name: Setup Node
-        uses: actions/setup-node@v4
+        uses: actions/setup-node@v5
         with:
           node-version: ${{ matrix.node }}
+          cache: 'npm'
 
       - name: Install Package
         run: |
@@ -33,11 +35,9 @@ jobs:
       - name: Run Coverage Testing
         run: npm run coverage
 
-      - name: DeepSource
-        if: ${{ github.event_name != 'pull_request' && env.DEEPSOURCE_DSN != '' && matrix.node == 20 }}
+      - name: Codecov
+        if: ${{ (success() || failure()) && github.event_name != 'pull_request' && env.CODECOV_TOKEN != '' && matrix.node == 22 }}
         run: |
-          # Install deepsource CLI
-          curl https://deepsource.io/cli | sh
-    
-          # From the root directory, run the report coverage command
-          ./bin/deepsource report --analyzer test-coverage --key javascript --value-file ./coverage/lcov.info
+          curl -Os https://uploader.codecov.io/latest/linux/codecov
+          chmod +x codecov
+          ./codecov -t ${CODECOV_TOKEN}

README.md

@@ -2,8 +2,6 @@
 
 [![npm (scoped)](https://img.shields.io/npm/v/%40cityssm/windows-unc-path-connect)](https://www.npmjs.com/package/@cityssm/windows-unc-path-connect)
 [![DeepSource](https://app.deepsource.com/gh/cityssm/node-windows-unc-path-connect.svg/?label=active+issues&show_trend=true&token=kMenIfdyEcHVDtebaPlgkjFy)](https://app.deepsource.com/gh/cityssm/node-windows-unc-path-connect/)
-[![Maintainability](https://api.codeclimate.com/v1/badges/0c0f2c336c22c3c889fa/maintainability)](https://codeclimate.com/github/cityssm/node-windows-unc-path-connect/maintainability)
-[![DeepSource](https://app.deepsource.com/gh/cityssm/node-windows-unc-path-connect.svg/?label=code+coverage&show_trend=false&token=kMenIfdyEcHVDtebaPlgkjFy)](https://app.deepsource.com/gh/cityssm/node-windows-unc-path-connect/)
 [![Coverage Testing](https://github.com/cityssm/node-windows-unc-path-connect/actions/workflows/coverage.yml/badge.svg)](https://github.com/cityssm/node-windows-unc-path-connect/actions/workflows/coverage.yml)
 
 Ensures a UNC path that requires a user name and password
@@ -33,8 +31,14 @@ const success = connectToUncPath(
     password: 'p@ss'
   },
   {
-    // Attempt to clean up connection on application shutdown
-    deleteOnExit: true
+    // Optionally attempt to clean up connection on application shutdown.
+    deleteOnExit: true,
+
+    // Optionally assign a drive letter.
+    driveLetter: 'M:',
+
+    // Optionally persist the connection after restart.
+    persistent: true
   }
 )
 

debug.config.d.ts

@@ -0,0 +1,2 @@
+export declare const DEBUG_NAMESPACE = "windows-unc-path-connect";
+export declare const DEBUG_ENABLE_NAMESPACES = "windows-unc-path-connect:*";

debug.config.js

@@ -0,0 +1,2 @@
+export const DEBUG_NAMESPACE = 'windows-unc-path-connect';
+export const DEBUG_ENABLE_NAMESPACES = `${DEBUG_NAMESPACE}:*`;

debug.config.ts

@@ -0,0 +1,3 @@
+export const DEBUG_NAMESPACE = 'windows-unc-path-connect'
+
+export const DEBUG_ENABLE_NAMESPACES = `${DEBUG_NAMESPACE}:*`

eslint.config.d.ts

@@ -1 +1 @@
-export { default } from 'eslint-config-cityssm';
+export { default } from 'eslint-config-cityssm/eslint.packageConfig.js';

eslint.config.js

@@ -1 +1 @@
-export { default } from 'eslint-config-cityssm';
+export { default } from 'eslint-config-cityssm/eslint.packageConfig.js';

eslint.config.ts

@@ -1 +1 @@
-export { default } from 'eslint-config-cityssm'
+export { default } from 'eslint-config-cityssm/eslint.packageConfig.js'

index.d.ts

@@ -1,5 +1,5 @@
-import type { ConnectOptions, UncPath, UncPathOptions } from './types.js';
+import type { ConnectOptions, UncPathOptions } from './types.js';
 export declare function connectToUncPath(uncPathOptions: UncPathOptions, connectOptions?: Partial<ConnectOptions>): boolean;
-export declare function disconnectUncPath(uncPath: UncPath): boolean;
-export type { UncPath, UncPathOptions, UncPathOptionsWithoutCredentials, UncPathOptionsWithCredentials, ConnectOptions } from './types.js';
-export { isWindows, uncPathIsSafe, uncPathOptionsAreSafe } from './validators.js';
+export declare function disconnectUncPath(uncPathOrDriveLetter: string): boolean;
+export type { ConnectOptions, UncPath, UncPathOptions, UncPathOptionsWithCredentials, UncPathOptionsWithoutCredentials } from './types.js';
+export { driveLetterIsSafe, isWindows, uncPathIsSafe, uncPathOptionsAreSafe } from './validators.js';

index.js

@@ -1,23 +1,35 @@
 import { execSync } from 'node:child_process';
 import Debug from 'debug';
 import exitHook from 'exit-hook';
-import { isWindows, uncPathIsSafe, uncPathOptionsAreSafe, uncPathOptionsHaveCredentials } from './validators.js';
-const debug = Debug('windows-unc-path-connect');
+import { DEBUG_NAMESPACE } from './debug.config.js';
+import { driveLetterIsSafe, isWindows, uncPathIsSafe, uncPathOptionsAreSafe, uncPathOptionsHaveCredentials } from './validators.js';
+const timeoutMilliseconds = 30_000;
+const debug = Debug(`${DEBUG_NAMESPACE}:index`);
 export function connectToUncPath(uncPathOptions, connectOptions) {
     if (!isWindows() || !uncPathOptionsAreSafe(uncPathOptions)) {
         return false;
     }
     debug(`Connecting to share: ${uncPathOptions.uncPath}`);
-    let command = `net use "${uncPathOptions.uncPath}"`;
+    const commandPieces = ['net use'];
+    if (connectOptions?.driveLetter) {
+        commandPieces.push(connectOptions.driveLetter);
+    }
+    commandPieces.push(`"${uncPathOptions.uncPath}"`);
+    if (connectOptions?.persistent) {
+        commandPieces.push('/persistent:yes');
+    }
     if (uncPathOptionsHaveCredentials(uncPathOptions)) {
-        command += ` /user:"${uncPathOptions.userName}" "${uncPathOptions.password}"`;
+        commandPieces.push(`/user:"${uncPathOptions.userName}" "${uncPathOptions.password}"`);
     }
     try {
-        const output = execSync(command, { stdio: 'pipe' });
+        const output = execSync(commandPieces.join(' '), {
+            stdio: 'pipe',
+            timeout: timeoutMilliseconds
+        });
         debug(output.toString().trim());
         if (connectOptions?.deleteOnExit ?? false) {
             exitHook(() => {
-                disconnectUncPath(uncPathOptions.uncPath);
+                disconnectUncPath(connectOptions?.driveLetter ?? uncPathOptions.uncPath);
             });
         }
         return output.includes('command completed successfully');
@@ -28,20 +40,30 @@ export function connectToUncPath(uncPathOptions, connectOptions) {
             .includes('Multiple connections to a server or shared resource');
     }
 }
-export function disconnectUncPath(uncPath) {
-    if (!isWindows() || !uncPathIsSafe(uncPath)) {
+export function disconnectUncPath(uncPathOrDriveLetter) {
+    if (!isWindows() ||
+        (!uncPathIsSafe(uncPathOrDriveLetter) &&
+            !driveLetterIsSafe(uncPathOrDriveLetter))) {
         return false;
     }
-    debug(`Disconnecting share: ${uncPath}`);
-    const command = `net use "${uncPath}" /delete`;
+    debug(`Disconnecting share: ${uncPathOrDriveLetter}`);
+    const command = `net use "${uncPathOrDriveLetter}" /delete`;
     try {
-        const output = execSync(command, { stdio: 'pipe' });
+        const output = execSync(command, {
+            stdio: 'pipe',
+            timeout: timeoutMilliseconds
+        });
         debug(output.toString().trim());
         return (output.includes('deleted successfully') ||
             output.includes('connection could not be found'));
     }
-    catch {
+    catch (error) {
+        const errorString = error.toString();
+        if (errorString.includes('network connection could not be found')) {
+            return true;
+        }
+        debug(errorString);
         return false;
     }
 }
-export { isWindows, uncPathIsSafe, uncPathOptionsAreSafe } from './validators.js';
+export { driveLetterIsSafe, isWindows, uncPathIsSafe, uncPathOptionsAreSafe } from './validators.js';