Feature/533/optional default providers

.github/workflows/ci.yaml

@@ -46,7 +46,7 @@ jobs:
           npm run coverage:merge
           npm run coverage:merge-report
       - name: Send results to SonarCloud
-        uses: SonarSource/sonarcloud-github-action@v1.6
+        uses: SonarSource/sonarcloud-github-action@v2.0.2
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

lib/constants.ts

@@ -0,0 +1,12 @@
+export const DISABLE_DEFAULT_PROVIDERS_ENV_VAR =
+  "NUT_JS_DISABLE_DEFAULT_PROVIDERS";
+export const DISABLE_DEFAULT_CLIPBOARD_PROVIDER_ENV_VAR =
+  "NUT_JS_DISABLE_DEFAULT_CLIPBOARD_PROVIDER";
+export const DISABLE_DEFAULT_KEYBOARD_PROVIDER_ENV_VAR =
+  "NUT_JS_DISABLE_DEFAULT_KEYBOARD_PROVIDER";
+export const DISABLE_DEFAULT_MOUSE_PROVIDER_ENV_VAR =
+  "NUT_JS_DISABLE_DEFAULT_MOUSE_PROVIDER";
+export const DISABLE_DEFAULT_SCREEN_PROVIDER_ENV_VAR =
+  "NUT_JS_DISABLE_DEFAULT_SCREEN_PROVIDER";
+export const DISABLE_DEFAULT_WINDOW_PROVIDER_ENV_VAR =
+  "NUT_JS_DISABLE_DEFAULT_WINDOW_PROVIDER";

lib/expect/jest.matcher.function.ts

@@ -10,6 +10,7 @@ declare global {
     interface Matchers<R> {
       toBeAt: (position: Point) => ReturnType<typeof toBeAt>;
       toBeIn: (region: Region) => ReturnType<typeof toBeIn>;
+      // @ts-ignore
       toShow: (
         needle: FindInput,
         confidence?: number

lib/keyboard.class.spec.ts

@@ -20,6 +20,9 @@ const providerRegistryMock = mockPartial<ProviderRegistry>({
       setKeyboardDelay: jest.fn(),
     });
   },
+  hasKeyboard(): boolean {
+    return true;
+  },
 });
 
 describe("Keyboard", () => {

lib/keyboard.class.ts

@@ -34,9 +34,11 @@ export class KeyboardClass {
    * @param providerRegistry
    */
   constructor(private providerRegistry: ProviderRegistry) {
-    this.providerRegistry
-      .getKeyboard()
-      .setKeyboardDelay(this.config.autoDelayMs);
+    if (this.providerRegistry.hasKeyboard()) {
+      this.providerRegistry
+        .getKeyboard()
+        .setKeyboardDelay(this.config.autoDelayMs);
+    }
   }
 
   /**

lib/mouse.class.spec.ts

@@ -19,6 +19,9 @@ const providerRegistryMock = mockPartial<ProviderRegistry>({
       setMouseDelay: jest.fn(),
     });
   },
+  hasMouse(): boolean {
+    return true;
+  },
 });
 
 describe("Mouse class", () => {

lib/mouse.class.ts

@@ -37,7 +37,9 @@ export class MouseClass {
    * @param providerRegistry
    */
   constructor(private providerRegistry: ProviderRegistry) {
-    this.providerRegistry.getMouse().setMouseDelay(0);
+    if (this.providerRegistry.hasMouse()) {
+      this.providerRegistry.getMouse().setMouseDelay(0);
+    }
   }
 
   /**