wikiploy 1.9.0 → 2.0.1

package/DEV.md

@@ -38,18 +38,14 @@ You can also run (and debug) each test case directly from a test file. You might
 Step 1. Check and update versions.
 ```bash
 php ./check_up.php
+# npm up
+# npm test
 ```
 
-Step 2a. Test Puppeteer.
- - Open *Chrome Canary* in *debug* mode.
- - Run `ploy_test_full.js`.
-
-Step 2b. Test MWN:
+Step 2. Test MWN:
  - Run `ploy_test_lite.js`.
 
-Step 3. Final commands.
+Step 3. Publish.
 ```bash
-# npm up
-npm test
 npm publish
 ```

package/README.md

@@ -13,6 +13,20 @@ See also:
 
 ## New capabilities
 
+### Lightweight Dependencies (v2.0)
+
+We had a good run, but it's time to bid farewell to [Puppeteer](https://pptr.dev/) and free the puppets ;). Obviously, this might be a breaking change if you really need to use it. However, the Wikiploy API doesn't really change...
+
+The only change is that you need to provide bot configuration to Wikiploy (as already described for WikiployLite). It's not nothing, but you only need to follow few steps from the [Botpass configuration section](#botpass-configuration). You only need to do it once and then use in all your user scripts.
+
+`WikiployLite` is now synonymous with `Wikiploy`. You can use either of the class names.
+
+### userPrompt (v1.8)
+
+Use the `userPrompt` helper function to prompt for a summary in your Wikiploy script. This is only a helper. You can still set up a static summary, but a prompt helps to ensure you don't forget to change the summary.
+
+Note that when using `userPrompt` you have to use an interactive terminal. This might be a bit more tricky to set up but can still function as a one-click build from a commandbar (see [README: building your project](https://github.com/Eccenux/Wikiploy/blob/main/README.building%20your%20project.md)).
+
 ### nowiki (v1.7)
 
 The `nowiki` property is a new option in `DeployConfig` since Wikiploy v1.7. It is now recommended to use `nowiki: true` for all JS files.
@@ -28,33 +42,26 @@ JavaScript page is still a wiki page... Kind of. It can be added to a category o
 
 Don't add this option to CSS though. It won't work correctly.
 
-### userPrompt (v1.8)
-
-Use the `userPrompt` helper function to prompt for a summary in your Wikiploy script. This is only a helper. You can still set up a static summary, but a prompt helps to ensure you don't forget to change the summary.
-
-Note that when using `userPrompt` you have to use an interactive terminal. This might be a bit more tricky to set up but can still function as a one-click build from a commandbar (see [README: building your project](https://github.com/Eccenux/Wikiploy/blob/main/README.building%20your%20project.md)).
+## Using Wikiploy
 
-## Wikiploy types
-
-### Wikiploy full (deprecated)
-
-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*).
+Either use [Wikiploy project template](https://github.com/Eccenux/wikiploy-rollout-example/releases) or add Wikiploy to your project:
+```bash
+# npm install wikiploy --save-dev
+npm i wikiploy -D
+```
 
-### WikiployLite (recommended)
+The `Wikiploy` class can be used to help deploy scripts. It is using a bot API to do that, but don't worry, you don't need to be a bot ;).
 
-The `WikiployLite` class is using a bot API to deploy scripts. You can use standard `Wikiploy` and `WikiployLite` interchangeably. The `DeployConfig` is the same. WikiployLite is recommended as long as you can use it.
+You do need to setup a bot password though (on [[Special:BotPasswords]]). It's not as hard as it might seem as **you can do this on *any* Wikimedia wiki and it will work for *all* WMF wikis**. You don't need a bot account for this to work. You will just create an alias for your standard account and a special password just for your scripts.
 
-**WikiployLite** is less memory heavy as it doesn't use a browser (and doesn't use `Puppeteer`). You do need to setup a bot password though (on [[Special:BotPasswords]]). It's not as hard as it might seem as you can do this on any Wikimedia wiki and it will work for all WMF wikis. You don't need a bot account for this to work.
+## Botpass configuration
+A bot password is essentially a sub-account, designed to help keep your activities separated and secure. Setting up a sub-account is straightforward, and nearly anyone can do it.
 
-Botpass configuration:
-* Setup on e.g.: https://test.wikipedia.org/wiki/Special:BotPasswords
-* Rights you should setup (if you can): `assets\Bot passwords - Test Wikipedia.png`.
-* Example config file in: `assets\public--bot.config.mjs`.
+1. Begin by setting up your sub-account on this page: [test.wikipedia.org/wiki/Special:BotPasswords](https://test.wikipedia.org/wiki/Special:BotPasswords).
+2. Choose a name and specify the permissions for your sub-account. For instance, you should grant rights necessary for deploying gadgets (if applicable). You can refer to this example screenshot for setting up rights: [assets\Bot passwords - Test Wikipedia.png](https://github.com/Eccenux/Wikiploy/blob/main/assets/Bot%20passwords%20-%20Test%20Wikipedia.png).
+3. Next, create your `bot.config.mjs` file. An example configuration file can be found here: `assets\public--bot.config.mjs`.
 
-**Warning!** Never, ever publish your bot password. If you do spill your password, reset/remove the password ASAP (on Special:BotPasswords).
+**Warning!** Never, ever publish your bot password. If you do spill your password, reset/remove the password ASAP (on [Special:BotPasswords](https://test.wikipedia.org/wiki/Special:BotPasswords)).
 
 
 ## Different wiki sites

package/assets/test.css

@@ -5,4 +5,4 @@
 .tavern {
 	display: block;
 }
-/* puppeteer 22.0.0 xor mwn 2.0.2 */
+/*## Wikiploy v2.0.0 with MWN v2.0.2 ##*/

package/assets/test.js

@@ -7,4 +7,4 @@
  */
 // test.js
 console.log('test');
-/* puppeteer 22.0.0 xor mwn 2.0.2 */
+/*## Wikiploy v2.0.0 with MWN v2.0.2 ##*/

package/check/UpdateChecker.php

@@ -69,10 +69,28 @@ class UpdateChecker {
 		}
 	}
 
+	/**
+	 * Check current version.
+	 * 
+	 * Does a fresh read from JSON.
+	 *
+	 * @return $versionFromNpm Version in package.json.
+	 */
+	public function checkMain() {
+		$content = file_get_contents('package.json');
+		$this->package = json_decode($content, true);
+		return $this->package['version'];
+	}
+
+	/**
+	 * Update test assest with current versions.
+	 *
+	 * @param string $path Test asset path.
+	 */
 	public function updateAsset($path) {
 		$content = file_get_contents($path);
-		$versionInfo = "/* puppeteer {$this->versions['puppeteer']} xor mwn {$this->versions['mwn']} */";
-		$content = preg_replace('#/\* puppeteer [0-9.x]+ \w+ mwn [0-9.x]+ \*/#', $versionInfo, $content);
+		$versionInfo = "$1 Wikiploy v{$this->package['version']} with MWN v{$this->versions['mwn']} $2";
+		$content = preg_replace('@(/\*##).+(##\*/)@', $versionInfo, $content);
 		file_put_contents($path, $content);
 	}
 }

package/check_up.php

@@ -9,17 +9,24 @@ runner('git pull', -1);
 
 $versionChecker = new UpdateChecker();
 // check and update internals
-$versionChecker->checkPackage("puppeteer");
+// $versionChecker->checkPackage("puppeteer");
 $versionChecker->checkPackage("mwn");
 // save
-if ($versionChecker->hasChanges) {
+if (!$versionChecker->hasChanges) {
+	echo "\n[INFO] No updates for main deps.\n";
+} else {
 	$versionChecker->save();
+
+	echo "\n[INFO] Bump version\n";
+	runner('npm run bump');
+
+	$packageVersion = $versionChecker->checkMain(); // check and update internals
+	echo "\n[INFO] New version: $packageVersion\n";
 	// update test.js/css (puppeteer/mwn version)
+	echo "\n[INFO] Update version in assets\n";
 	$versionChecker->updateAsset('assets/test.css');
 	$versionChecker->updateAsset('assets/test.js');
 
-	echo "\n[INFO] Bump version\n";
-	runner('npm run bump');
 	echo "\n[INFO] Update packages and locks\n";
 	runner('npm up');
 	echo "\n[INFO] Test\n";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wikiploy",
-  "version": "1.9.0",
+  "version": "2.0.1",
   "description": "User scripts and gadgets deployment for MediaWiki (Wikipedia).",
   "main": "src/index.js",
   "type": "module",
@@ -26,8 +26,7 @@
   },
   "homepage": "https://github.com/Eccenux/Wikiploy#readme",
   "dependencies": {
-    "mwn": "2.0.x",
-    "puppeteer": "22.0.x"
+    "mwn": "2.0.x"
   },
   "devDependencies": {
     "bump-version": "0.5.0",

package/src/Wikiploy.js

@@ -21,6 +21,7 @@ function sleep(sleepMs) {
  * MediaWiki deployment automation.
  * Deploy scripts with a browser (puppetter).
  * 
+ * @deprecated Use `WikiployLite` instead. WikiployLite will replace Wikiploy.
  * @property _browser {Browser} Browser connection.
  */
 export default class Wikiploy extends WikiployBase {

package/src/WikiployLite.js

@@ -19,6 +19,14 @@ export default class WikiployLite extends WikiployBase {
 	constructor(botpass) {
 		super();
 
+		if (typeof botpass != 'object') {
+			console.error('Note! Use `botpass` to init config.')
+			botpass = {
+				username: '__not_provided__',
+				password: '__fake__',
+			};
+		}
+
 		/** [[Special:BotPasswords]] data. */
 		this.botpass = {
 			username: botpass.username,

package/src/index.js

@@ -1,9 +1,10 @@
 import DeployConfig from './DeployConfig.js';
-import Wikiploy from './Wikiploy.js';
 import WikiployLite from './WikiployLite.js';
 import * as verlib from './version.js';
 import { userPrompt } from './userPrompt.js';
 
+const Wikiploy = WikiployLite;
+
 export {
 	DeployConfig,
 	verlib,

package/src/ploy_test_full.js

@@ -1,6 +1,12 @@
 import DeployConfig from './DeployConfig.js';
 import Wikiploy from './Wikiploy.js';
 
+/**
+	Deprecated, do not use.
+
+	Legacy script that works with Puppeteer.
+*/
+
 const ployBot = new Wikiploy();
 // mock
 // ployBot.mock = true;

package/test/Wikiploy.test.js

@@ -1,8 +1,14 @@
 /* global describe, it */
 import { assert } from 'chai';
-import Wikiploy from '../src/Wikiploy.js';
+import { default as Wikiploy } from '../src/WikiployLite.js';
 import DeployConfig from '../src/DeployConfig.js';
 
+/** Fake bot auth. */
+const botpass = {
+	username: 'test',
+	password: 'mock',
+}
+
 describe('Wikiploy', function () {
 	
 	describe('summary', function () {
@@ -17,7 +23,7 @@ describe('Wikiploy', function () {
 		it('should use config string', function () {
 			let version = 'v1.1';
 			let expected = version + ' ' + tag;
-			const ployBot = new Wikiploy();
+			const ployBot = new Wikiploy(botpass);
 			const summary = prepareSummary(ployBot, {
 				src: 'test.js',
 				summary: version,
@@ -27,7 +33,7 @@ describe('Wikiploy', function () {
 		it('should use config function', function () {
 			let version = 'v1.2';
 			let expected = version + ' ' + tag;
-			const ployBot = new Wikiploy();
+			const ployBot = new Wikiploy(botpass);
 			const summary = prepareSummary(ployBot, {
 				src: 'test.js',
 				summary: () => version,
@@ -37,7 +43,7 @@ describe('Wikiploy', function () {
 		it('should use global function', function () {
 			let version = 'v1.3';
 			let expected = version + ' ' + tag;
-			const ployBot = new Wikiploy();
+			const ployBot = new Wikiploy(botpass);
 			ployBot.summary = () => version;
 			const summary = prepareSummary(ployBot, {
 				src: 'test.js',
@@ -47,7 +53,7 @@ describe('Wikiploy', function () {
 	});
 
 	describe('prepareFile', function () {
-		const ployBot = new Wikiploy();
+		const ployBot = new Wikiploy(botpass);
 		function prepareFile(contents, configDef) {
 			const config = new DeployConfig(configDef);
 			let result = ployBot.prepareFile(config, contents);