wikiploy 1.3.1 → 1.3.3

package/.github/workflows/node.js.yml

@@ -0,0 +1,30 @@
+# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs
+
+name: Node tests
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [16.x, 18.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v3
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    - run: npm ci
+    - run: npm test

package/DEV.md

@@ -0,0 +1,49 @@
+Development
+==========================
+
+Wikiploy is a Node.js project and is configured to use VSCode for development.
+
+## Prepararion
+
+### Install Nodejs
+Obviously you'll need [Node.js](https://nodejs.org/en).
+Node 14+ should be fine for Wikiploy alone, but Puppeteer has certain expectations and 16+ is a better choice. In any case, I would recommend using the latest LTS version of Node.
+
+Note that you can use [NVM-windows](https://github.com/coreybutler/nvm-windows) if you need multiple Node.js versions installed on Windows.
+
+### Install modules
+Run first `npm i`.
+You might want to run `npm up` to update some scripts too.
+
+Recomended global modules/tools:
+```
+npm install -g eslint
+npm install -g mocha
+```
+You mostly need above if you will be using your shell (command line).
+
+## Running tests
+To run tests in your shell you can use npm: `npm test`. Or just run `mocha`.
+
+Better yet install [VSCode](https://code.visualstudio.com/download) and the recommended extenstions. It will make things easier (especially for debugging tests).
+
+In VSC, you should see a laboratory flask icon on the sidebar. From there, you can run individual tests or all at once.
+Note that you might need to reload the testing sidebar to see all tests, especially after adding new test files.
+To view output of individual tests use the testing sidebar. Navigate to the test and click on it.
+
+You can also run (and debug) each test case directly from a test file. You might need to press reload in the sidebar if you don't see buttons to run and debug tests.
+
+## Publishing
+
+Step. 1. Check.
+```
+npm test
+```
+Step. 2. Change version in the package.
+
+Step. 3. Final commands.
+```
+npm up
+npm test
+npm publish
+```

package/README.md

@@ -13,6 +13,7 @@ Rollout your JS, CSS etc from your git repository to as many MW wikis as you nee
 This is using [Puppeteer](https://pptr.dev/) to control [Chrome Canary](https://www.google.com/chrome/canary/) or similar. You just open Chrome with remote debug enabled and run a script. The idea is that you are logged in in Chrome and so all edits are still your edits. You can keep the Canary running in the background when you are changing and deploying more stuff.
 
 Wikiploy will also work with other Chromium based browser. [Instructions for enabling remote debug in MS Edge](https://learn.microsoft.com/en-us/microsoft-edge/devtools-protocol-chromium/).
+Note that to completely close Edge you might need use settings: Continue running in background when Microsoft Edge is closed (pl. *Kontynuuj działanie aplikacji i rozszerzeń w tle po zamknięciu przeglądarki Microsoft Edge*).
 
 ## Basic script and dst
 ```js

package/assets/test.css

@@ -2,4 +2,7 @@
 .yadda.yadda.yadda {
 	content: 'bla, bla, bla';
 }
-.something {}
+.something {
+	display: block;
+}
+/* puppeteer 20.7.x */

package/assets/test.js

@@ -1,3 +1,3 @@
 // test.js
 console.log('test');
-// edit
+// puppeteer 20.7.x

package/package.json

@@ -1,11 +1,11 @@
 {
 	"name": "wikiploy",
-	"version": "1.3.1",
+	"version": "1.3.3",
 	"description": "User scripts and gadgets deployment for MediaWiki (Wikipedia).",
 	"main": "src/index.js",
 	"type": "module",
 	"scripts": {
-		"test": "echo \"Error: no test specified\" && exit 1"
+		"test": "mocha"
 	},
 	"repository": {
 		"type": "git",
@@ -25,11 +25,11 @@
 	},
 	"homepage": "https://github.com/Eccenux/Wikiploy#readme",
 	"dependencies": {
-		"puppeteer": "^20.7.2"
+		"puppeteer": "20.7.x"
 	},
 	"devDependencies": {
-		"chai": "^4.3.7",
-		"mocha": "^10.2.0",
-		"eslint": "^8.43.0"
+		"chai": "4.x",
+		"mocha": "10.x",
+		"eslint": "8.x"
 	}
 }