Fix examples to be copy-paste ready

ash0x0 · ash0x0 · commit 794c4d3f0dde · 2021-06-14T12:43:04.000+02:00
Update ignore files
Merge CI and publish actions
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -2,6 +2,7 @@ name: CI
 
 on:
   workflow_dispatch:
+  release:
   push:
   pull_request:
     branches: [master]
@@ -24,6 +25,8 @@ jobs:
       - name: Setup Node
         uses: actions/setup-node@v2
         with:
+          # Set registry to NPM instead of github packages for publication
+          registry-url: 'https://registry.npmjs.org'
           node-version: 14
 
       - name: Setup Linux Dependencies
@@ -34,8 +37,23 @@ jobs:
       - name: Install Packages
         run: npm i --ignore-scripts
 
+      # Build only if version tag is not present
       - name: Build
         run: npm run build -- --all --msvs_version=2019
-        if: startsWith(github.ref, 'refs/tags/') != true
+        if: startsWith(github.ref, 'refs/tags/v') != true
         env:
           ARCH: ${{ matrix.arch }}
+
+      # Build and publish if version tag is present
+      - name: Build & Publish Prebuilds
+        run: npm run build:ci -- --msvs_version=2019
+        if: startsWith(github.ref, 'refs/tags/v')
+        env:
+          ARCH: ${{ matrix.arch }}
+          GITHUB_ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Publish NPM Package
+        if: startsWith(github.ref, 'refs/tags/v') && startsWith(matrix.os, 'ubuntu')
+        run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NODE_AUTH_TOKEN }}
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
diff --git a/.gitignore b/.gitignore
@@ -1,19 +1,20 @@
-.env
 .idea
 .vscode
-*.DS_Store
-*.iml
-*.log
-binding.gyp
+.scratch
 build
 builds
 docs/.vuepress/dist
-examples/electron-example/.DS_Store
 logs
 node_modules
-npm-debug.log*
 prebuilds
+.env
+*.DS_Store
+*.iml
+*.log
+examples/**/.DS_Store
+npm-debug.log*
 stacktrace*
+binding.gyp
 uiohook.gyp
 
 libuiohook/nbproject/
diff --git a/.lintignore b/.lintignore
@@ -1,18 +1,19 @@
-.env
 .idea
 .vscode
-*.DS_Store
-*.iml
-*.log
-binding.gyp
+.scratch
 build
 builds
 docs/.vuepress/dist
-examples/electron-example/.DS_Store
 logs
 node_modules
-npm-debug.log*
 prebuilds
+libuiohook
+.env
+*.DS_Store
+*.iml
+*.log
+examples/electron-example/.DS_Store
+npm-debug.log*
 stacktrace*
+binding.gyp
 uiohook.gyp
-libuiohook
diff --git a/.npmignore b/.npmignore
@@ -1,17 +1,27 @@
-_config.yml
-.env
-.github/
-.travis.yml
+.idea/
 .vscode/
-appveyor.yml
+.scratch/
 build/
 builds/
+docs/.vuepress/dist/
+logs/
+node_modules/
+prebuilds/
+libuiohook/
+.github/
 CMakeFiles/
-deploy-docs.sh
 docs/
 examples/
-libuiohook/
-prebuilds/
 test/
+.env
+*.DS_Store
+*.iml
+*.log
+npm-debug.log*
+stacktrace*
 /binding.gyp
 /uiohook.gyp
+.lintignore
+.eslintrc.json
+.prettierrc.json
+_config.yml
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
 [![NPM version](https://img.shields.io/npm/v/iohook?color=%230088FF)](https://www.npmjs.com/package/iohook)
 [![Release date](https://img.shields.io/github/release-date/wilix-team/iohook?color=%230088FF)](https://github.com/wilix-team/iohook/releases/latest)
 [![GitHub Super-Linter](https://github.com/wilix-team/iohook/workflows/Lint%20Code%20Base/badge.svg)](https://github.com/marketplace/actions/super-linter)
-[![Publish](https://github.com/wilix-team/iohook/actions/workflows/publish.yml/badge.svg)](https://github.com/wilix-team/iohook/actions/workflows/publish.yml)
+[![CI](https://github.com/wilix-team/iohook/actions/workflows/ci.yml/badge.svg)](https://github.com/wilix-team/iohook/actions/workflows/ci.yml)
 [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?color=%23008880)](https://github.com/prettier/prettier)
 [![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/iohookjs/Lobby)
 [![Issues](https://img.shields.io/github/issues-raw/wilix-team/iohook)](https://github.com/wilix-team/iohook/issues)
diff --git a/examples/electron-main/main.js b/examples/electron-main/main.js
@@ -1,7 +1,7 @@
 'use strict';
 
 const { app } = require('electron');
-const ioHook = require('../../index');
+const ioHook = require('iohook');
 
 function eventHandler(event) {
   console.log(event);
diff --git a/examples/electron-main/package-lock.json b/examples/electron-main/package-lock.json
diff --git a/examples/electron-main/package.json b/examples/electron-main/package.json
@@ -4,12 +4,12 @@
   "description": "Show how to use this module with electron",
   "main": "main.js",
   "scripts": {
-    "start": "electron ./",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "start": "electron ."
   },
   "author": "Aloyan Dmitry",
   "license": "MIT",
   "dependencies": {
-    "electron": ">=11.1.0"
+    "electron": ">=11.1.0",
+    "iohook": "^0.9.2"
   }
 }
diff --git a/examples/electron-renderer/index.html b/examples/electron-renderer/index.html
@@ -11,7 +11,7 @@
             process.versions[type];
         }
 
-        const ioHook = require('../../index');
+        const ioHook = require('iohook');
         ioHook.start(true);
         ioHook.on('mouseclick', eventHandler);
         ioHook.on('keydown', eventHandler);
diff --git a/examples/electron-renderer/main.js b/examples/electron-renderer/main.js
@@ -1,12 +1,8 @@
 // Modules to control application life and create native browser window
-const { app, BrowserWindow, Menu } = require('electron');
+const { app, BrowserWindow } = require('electron');
 app.allowRendererProcessReuse = false;
-const path = require('path');
 
 function createWindow() {
-  //remove application menu on Windows
-  //if (process.platform == "win32") Menu.setApplicationMenu(null);
-
   // Create the browser window.
   const mainWindow = new BrowserWindow({
     width: 1000,
diff --git a/examples/electron-renderer/package-lock.json b/examples/electron-renderer/package-lock.json
diff --git a/examples/electron-renderer/package.json b/examples/electron-renderer/package.json
@@ -7,6 +7,7 @@
     "start": "electron ."
   },
   "devDependencies": {
-    "electron": ">=11.1.0"
+    "electron": ">=11.1.0",
+    "iohook": "^0.9.2"
   }
 }
diff --git a/examples/node/example.js b/examples/node/example.js
@@ -1,6 +1,6 @@
 'use strict';
 
-const ioHook = require('../index.js');
+const ioHook = require('iohook');
 
 ioHook.on('mousedown', function (msg) {
   console.log(msg);
diff --git a/examples/node/mouse-click-propagation.js b/examples/node/mouse-click-propagation.js
@@ -1,4 +1,4 @@
-const iohook = require('../index.js');
+const iohook = require('iohook');
 
 iohook.on('mouseup', (event) => console.log(event));
 
diff --git a/examples/node/package.json b/examples/node/package.json
@@ -0,0 +1,13 @@
+{
+  "name": "electron-quick-start",
+  "version": "1.0.0",
+  "description": "A minimal Electron application",
+  "main": "main.js",
+  "scripts": {
+    "start": "node example.js",
+    "start:propagation": "node mouse-click-propagation.js"
+  },
+  "devDependencies": {
+    "iohook": "^0.9.2"
+  }
+}

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@`
`11`	`11`	`process.versions[type];`
`12`	`12`	`}`
`13`	`13`
`14`		`- const ioHook = require('../../index');`
	`14`	`+ const ioHook = require('iohook');`
`15`	`15`	`ioHook.start(true);`
`16`	`16`	`ioHook.on('mouseclick', eventHandler);`
`17`	`17`	`ioHook.on('keydown', eventHandler);`