wikiploy 1.2.2 → 1.3.2

package/.vscode/extensions.json

@@ -0,0 +1,6 @@
+{
+	"recommendations": [
+		"hbenl.vscode-test-explorer",
+		"hbenl.vscode-mocha-test-adapter"
+	]
+}

package/DEV.md

@@ -0,0 +1,49 @@
+Development
+==========================
+
+Wikiploy is a Node.js project and is configured to use VSCode for development.
+
+## Prepararion
+
+### Install Node
+Obviously you'll need [Node.JS](https://nodejs.org/en).
+Node 12+ should be fine, but I would probably recommend latest LTS version.
+
+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

@@ -10,13 +10,56 @@ Wikiploy
 User scripts and gadgets deployment for wikis (Wikipedia or more generally MediaWiki based wiki).
 Rollout your JS, CSS etc from your git repository to as many MW wikis as you need.
 
-This is using [Puppeteer](https://pptr.dev/) to control [Chrome Canary](https://www.google.com/chrome/canary/). You just open Chrome 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.
+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.
 
-## Early release notice
+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!** While the program should be working already, I still don't think it's ready for general use.
+## Basic script and dst
+```js
+import {DeployConfig, Wikiploy} from 'wikiploy';
+
+const ployBot = new Wikiploy();
+
+// custom summary
+ployBot.summary = () => {
+	return 'v2.7.0: adding new test mode';
+}
+
+// run asynchronusly to be able to wait for results
+(async () => {
+	const configs = [];
+	configs.push(new DeployConfig({
+		src: 'test.js',
+		dst: '~/test-wikiploy--test.js',
+	}));
+	await ployBot.deploy(configs);
+})().catch(err => {
+	console.error(err);
+	process.exit(1);
+});
+```
+
+Note that `~` will be `User:SomeName` so the user space of currenlty logged in user.
+You can omit `dst` and it will default to `dst: '~/${src}'`.
+
+More about this basic code and `dst` in the [Wikiploy rollout example](https://github.com/Eccenux/wikiploy-rollout-example/).
+
+## Different wiki sites
+Wikiploy defaults to deployments on `pl.wikipedia.org`.
+
+You can change the default like so:
+```js
+ployBot.site = "en.wikipedia.org"; 
+```
+
+You can also set a site for an indvidual `DeployConfig` like so:
+```js
+configs.push(new DeployConfig({
+	src: 'test.js',
+	site: "de.wikipedia.org",
+}));
+```
 
-I will definitely add more features and handle more use cases.
 
 ## External links
 * [Wikiploy rollout example (repo)](https://github.com/Eccenux/wikiploy-rollout-example/)

package/package.json

@@ -1,11 +1,11 @@
 {
 	"name": "wikiploy",
-	"version": "1.2.2",
+	"version": "1.3.2",
 	"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",
@@ -29,7 +29,7 @@
 	},
 	"devDependencies": {
 		"chai": "^4.3.7",
-		"mocha": "^10.2.0",		
+		"mocha": "^10.2.0",
 		"eslint": "^8.43.0"
 	}
 }

package/src/DeployConfig.js

@@ -21,6 +21,21 @@ export default class DeployConfig {
 		if (!this.site || typeof this.site != 'string') {
 			this.site = '';
 		}
+		/**
+		 * Custom summary (per file).
+		 * 
+		 * This can either be a string or a function.
+		 * 
+		 * Note that you can also set a global summary (for the whole wikiploy).
+		 * Empty summary will fallback to global summary rules.
+		 */
+		this.summary = options?.summary;
+		if (typeof this.summary === 'string' && this.summary.length) {
+			this.summary = () => options.summary;
+		}
+		if (typeof this.summary != 'function') {
+			this.summary = false;
+		}
 	}
 
 	/** Does this config require a user. */

package/src/Wikiploy.js

@@ -135,7 +135,21 @@ export default class Wikiploy {
 	 * @private
 	 */
 	prepareSummary(config) {
-		return '#Wikiploy' + ` ${config.src}`;
+		let summary = typeof config.summary === 'function' ? config.summary() : this.summary(config);
+		return `#Wikiploy ${summary}`;
+	}
+
+	/**
+	 * Custom summary.
+	 * 
+	 * This can be e.g. version number and short, text summary.
+	 * You can use config to add e.g. file name too (which is default).
+	 * 
+	 * @param {DeployConfig} config Deployment configuration object.
+	 * @returns {String} Summary added to saved edits.
+	 */
+	summary(config) {
+		return config.src;
 	}
 
 	/**

package/test/DeployConfig.test.js

@@ -75,4 +75,44 @@ describe('DeployConfig', function () {
 			assert.equal(result.dst, config.dst);
 		});
 	});
+
+	describe('summary', function () {
+		it('should use string', function () {
+			let expected = 'v1.1';
+			let config = {
+				src: 'test.js',
+				summary: expected,
+			};
+			let result = new DeployConfig(config);
+			console.log(result);
+			assert.equal(result.summary(), expected);
+		});
+		it('should use function', function () {
+			let expected = 'v1.1: test.js';
+			let config = {
+				src: 'test.js',
+				summary: function() { return `v1.1: ${this.src}`; },
+			};
+			let result = new DeployConfig(config);
+			console.log(result);
+			assert.equal(result.summary(), expected);
+		});
+		it('should default to false', function () {
+			let config = {
+				src: 'test.js',
+			};
+			let result = new DeployConfig(config);
+			console.log(result);
+			assert.equal(result.summary, false);
+		});
+		it('empty should be ignored', function () {
+			let config = {
+				src: 'test.js',
+				summary: '',
+			};
+			let result = new DeployConfig(config);
+			console.log(result);
+			assert.equal(result.summary, false);
+		});
+	});
 });

package/test/Wikiploy.test.js

@@ -0,0 +1,48 @@
+/* global describe, it */
+import { assert } from 'chai';
+import Wikiploy from '../src/Wikiploy.js';
+import DeployConfig from '../src/DeployConfig.js';
+
+describe('Wikiploy', function () {
+	
+	describe('summary', function () {
+		let tag = '#Wikiploy';
+		function prepareSummary(ployBot, configDef) {
+			const config = new DeployConfig(configDef);
+			console.log({config, summary:config.summary?config.summary():'NN'});
+			let summary = ployBot.prepareSummary(config);
+			return summary;
+		}
+
+		it('should use config string', function () {
+			let version = 'v1.1';
+			let expected = tag + ' ' + version;
+			const ployBot = new Wikiploy();
+			const summary = prepareSummary(ployBot, {
+				src: 'test.js',
+				summary: version,
+			});
+			assert.equal(summary, expected);
+		});
+		it('should use config function', function () {
+			let version = 'v1.2';
+			let expected = tag + ' ' + version;
+			const ployBot = new Wikiploy();
+			const summary = prepareSummary(ployBot, {
+				src: 'test.js',
+				summary: () => version,
+			});
+			assert.equal(summary, expected);
+		});
+		it('should use global function', function () {
+			let version = 'v1.3';
+			let expected = tag + ' ' + version;
+			const ployBot = new Wikiploy();
+			ployBot.summary = () => version;
+			const summary = prepareSummary(ployBot, {
+				src: 'test.js',
+			});
+			assert.equal(summary, expected);
+		});
+	});
+});