Feature/437/prettier

.github/ISSUE_TEMPLATE/bug.md

@@ -8,6 +8,7 @@ about: Create a bug report to help us enhance our images
 **Short overview**
 
 **Issue occurs on**
+
 - [ ] Virtual machine
 - [ ] Docker container
 - [ ] Dev/Host system
@@ -17,4 +18,5 @@ about: Create a bug report to help us enhance our images
 **Steps to reproduce error**
 
 **Additional content**
-> Please provide any (mandatory) additional data to reproduce the error (Dockerfiles etc.)
+
+> Please provide any (mandatory) additional data to reproduce the error (Dockerfiles etc.)

.github/ISSUE_TEMPLATE/enhancement.md

@@ -10,4 +10,5 @@ about: Suggest a possible enhancement to the project
 **Detailed description**
 
 **Additional content**
+
 > Please provide any (mandatory) additional data for your enhancement

.github/ISSUE_TEMPLATE/feature.md

@@ -1,6 +1,6 @@
 ---
 name: Feature request
-about: Open a feature request 
+about: Open a feature request
 ---
 
 **Short overview**
@@ -10,4 +10,5 @@ about: Open a feature request
 **Detailed feature description**
 
 **Additional content**
-> Please provide any (mandatory) additional data for your desired feature
+
+> Please provide any (mandatory) additional data for your desired feature

.github/ISSUE_TEMPLATE/question.md

@@ -6,9 +6,9 @@ about: File a request to resolve open questions
 **Short summary**
 
 **Desired execution environment / tested on**
+
 - [ ] Virtual machine
 - [ ] Docker container
 - [ ] Dev/Host system
 
-
-**Detailed question**
+**Detailed question**

.github/PULL_REQUEST_TEMPLATE/bugfix.md

@@ -12,4 +12,4 @@ about: Request to merge a bugfix
 **Checklist**
 
 - [ ] My change requires a change to the documentation.
-- [ ] I have updated the documentation accordingly.
+- [ ] I have updated the documentation accordingly.

.github/PULL_REQUEST_TEMPLATE/enhancement.md

@@ -12,4 +12,4 @@ about: Request to merge an enhancement
 **Checklist**
 
 - [ ] My change requires a change to the documentation.
-- [ ] I have updated the documentation accordingly.
+- [ ] I have updated the documentation accordingly.

.github/PULL_REQUEST_TEMPLATE/feature.md

@@ -1,6 +1,6 @@
 ---
 name: Feature
-about: Request to merge a new feature 
+about: Request to merge a new feature
 ---
 
 **Short summary**
@@ -12,4 +12,4 @@ about: Request to merge a new feature
 **Checklist**
 
 - [ ] My change requires a change to the documentation.
-- [ ] I have updated the documentation accordingly.
+- [ ] I have updated the documentation accordingly.

.github/workflows/ci.yaml

@@ -1,17 +1,17 @@
 name: Run CI
 on:
-#  push:
-#    branches-ignore:
-#      - develop
-#      - release/**
-#    paths-ignore:
-#      - '**/*.md'
+  #  push:
+  #    branches-ignore:
+  #      - develop
+  #      - release/**
+  #    paths-ignore:
+  #      - '**/*.md'
   pull_request:
 
 jobs:
   sonar:
     runs-on: ubuntu-latest
-    if: '!contains(github.event.head_commit.message, ''skip ci'')'
+    if: "!contains(github.event.head_commit.message, 'skip ci')"
     steps:
       - name: Set up Git repository
         uses: actions/checkout@v2
@@ -56,8 +56,8 @@ jobs:
       - sonar
     strategy:
       matrix:
-        os: [ windows-latest, macos-latest ]
-        node: [ 16 ]
+        os: [windows-latest, macos-latest]
+        node: [16]
     runs-on: ${{matrix.os}}
     steps:
       - name: Set up Git repository

.github/workflows/snapshot_release.yaml

@@ -4,7 +4,7 @@ on:
     branches:
       - develop
     paths-ignore:
-      - '**/*.md'
+      - "**/*.md"
   repository_dispatch:
     types:
       - snapshot-release
@@ -13,8 +13,8 @@ jobs:
   test:
     strategy:
       matrix:
-        os: [ ubuntu-latest, windows-latest, macos-latest ]
-        node: [ 16 ]
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        node: [16]
     runs-on: ${{matrix.os}}
     steps:
       - name: Set up Git repository
@@ -48,7 +48,6 @@ jobs:
         with:
           run: npm --prefix e2e/electron-test cit
 
-
   deploy:
     needs:
       - test
@@ -60,7 +59,7 @@ jobs:
         uses: actions/setup-node@v2
         with:
           node-version: 16
-          registry-url: 'https://registry.npmjs.org'
+          registry-url: "https://registry.npmjs.org"
       - name: Install
         run: npm ci
       - name: Install @nut-tree/libnut@next
@@ -73,7 +72,7 @@ jobs:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
       - uses: actions/setup-node@v2
         with:
-          registry-url: 'https://npm.pkg.github.com'
+          registry-url: "https://npm.pkg.github.com"
       - name: Publish snapshot release to GPR
         run: npm run publish-next
         env:

.github/workflows/tagged_release.yaml

@@ -8,8 +8,8 @@ jobs:
   test:
     strategy:
       matrix:
-        os: [ ubuntu-latest, windows-latest, macos-latest ]
-        node: [ 16 ]
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        node: [16]
     runs-on: ${{matrix.os}}
     steps:
       - name: Set up Git repository
@@ -52,7 +52,7 @@ jobs:
         uses: actions/setup-node@v2
         with:
           node-version: 16
-          registry-url: 'https://registry.npmjs.org'
+          registry-url: "https://registry.npmjs.org"
       - name: Install
         run: npm ci
       - name: Run typedoc
@@ -69,8 +69,8 @@ jobs:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
       - uses: actions/setup-node@v2
         with:
-          registry-url: 'https://npm.pkg.github.com'
+          registry-url: "https://npm.pkg.github.com"
       - name: Publish tagged release to GPR
         run: npm publish
         env:
-          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx lint-staged

.prettierignore

@@ -0,0 +1,5 @@
+# Ignore artifacts:
+dist
+docs
+coverage
+node_modules

.prettierrc.json

@@ -0,0 +1 @@
+{}

CHANGELOG.md

@@ -3,25 +3,30 @@
 All notable changes to this project will be documented in this file.
 
 ## 2.3.0
+
 - Bugfix: Segmentation Fault when retrieving window title [(#377)](https://github.com/nut-tree/nut.js/issues/377)
 - Enhancement: Automatically check and request required permissions on macOS [(#377)](https://github.com/nut-tree/nut.js/issues/377)
 
 ## 2.2.1
+
 - Enhancement: Scale easing function result by base speed before applying [(#425)](https://github.com/nut-tree/nut.js/issues/425)
 - Maintenance: Resolve security vulnerabilities [(#422)](https://github.com/nut-tree/nut.js/issues/422)
 
 ## 2.2.0
+
 - Maintenance: Limit CI runs to PRs, not every push
 - Maintenance: Upgrade node version to 16 for all CI runs
 - Bugfix: Fix grave accent [(PR #414)](https://github.com/nut-tree/nut.js/pull/414)
 - Enhancement: Refine error messages on fetchFromUrl [(#415)](https://github.com/nut-tree/nut.js/issues/415)
 - Enhancement: Ship Windows runtime dependencies [(#365)](https://github.com/nut-tree/nut.js/issues/365)
 
 ## 2.1.1
+
 - Bugfix: Modifier keys are not properly released on macOS [(#264)](https://github.com/nut-tree/nut.js/issues/264)
 - Bugfix: Fix mouse clicks with modifiers on macOS [(#273)](https://github.com/nut-tree/nut.js/issues/273)
 
 ## 2.1.0
+
 - Bugfix: Keyboard methods `pressKey` and `releaseKey` ignore updated autoDelayMs [(#188)](https://github.com/nut-tree/nut.js/issues/188)
 - Enhancement: Add mappings for missing numpad keys [(#367)](https://github.com/nut-tree/nut.js/issues/367)
 - Enhancement: macOS double click [(#373)](https://github.com/nut-tree/nut.js/issues/373)
@@ -30,10 +35,12 @@ All notable changes to this project will be documented in this file.
 - Bugfix: Mouse methods `pressButton` and `releaseButton` should respect auto delay [(#403)](https://github.com/nut-tree/nut.js/issues/403)
 
 ## 2.0.1
+
 - Bugfix: Issue with `keyboard.type` in to Spotlight on MacOS [(#152)](https://github.com/nut-tree/nut.js/issues/152)
 - Enhancement: Numpad buttons don't work on Linux [(#360)](https://github.com/nut-tree/nut.js/issues/360)
 
 ## 2.0.0
+
 - Feature: Apple Silicon [(libnut#49)](https://github.com/nut-tree/libnut/issues/49)
 - Enhancement: Enable warning message for missing accessibility permissions on macOS [(#354)](https://github.com/nut-tree/nut.js/issues/354)
 - Enhancement: Add runtime typechecks for `screen.find` etc. [(#351)](https://github.com/nut-tree/nut.js/issues/351)
@@ -62,14 +69,16 @@ All notable changes to this project will be documented in this file.
 - Feature: Add methods to grab the current screen content as Buffer [(#278)](https://github.com/nut-tree/nut.js/issues/278)
 
 ## 1.7.0
+
 - Enhancement: Trigger snapshot releases [(#234)](https://github.com/nut-tree/nut.js/issues/234)
 - Feature: Cancel screen.waitFor if needed [(#241)](https://github.com/nut-tree/nut.js/issues/241)
 - Enhancement: Move docs into separate repo [(#244)](https://github.com/nut-tree/nut.js/issues/244)
 - Feature: Support for node 16 and Electron 13 [(#246)](https://github.com/nut-tree/nut.js/issues/246)
 
 ## 1.6.0
+
 - Feature: Create screenshot from region [(#154)](https://github.com/nut-tree/nut.js/issues/154)
-- Bugfix: Endless loop in timeout function for long-running actions returning undefined [(#205)](https://github.com/nut-tree/nut.js/issues/205) 
+- Bugfix: Endless loop in timeout function for long-running actions returning undefined [(#205)](https://github.com/nut-tree/nut.js/issues/205)
 - Maintenance: Use default exports for all provider classes [(#163)](https://github.com/nut-tree/nut.js/issues/163)
 - Enhancement: imprecise error message if image is too large [(#169)](https://github.com/nut-tree/nut.js/issues/169)
 - Bugfix: `waitFor` does not properly cancel [(#174)](https://github.com/nut-tree/nut.js/issues/174)

CODE_OF_CONDUCT.md

@@ -1,4 +1,5 @@
 # Code of Conduct
+
 All participants of nut.js are expected to abide by our Code of Conduct, both online and during in-person events that are hosted and/or associated with nut.js.
 
 ## Our Pledge
@@ -15,22 +16,22 @@ We do not engage with nor tolerate any kind of extremism, political propaganda a
 Examples of behavior that contributes to creating a positive environment
 include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
- advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
- address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
- professional setting
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
 
 ## Our Responsibilities