wikiploy 1.5.1 → 1.5.4

package/.vscode/commandbar.json

@@ -0,0 +1,25 @@
+// Requires `gsppvo.vscode-commandbar`.
+// Also: in settings (UI), `files.associations`, add `commandbar.json: jsonc` (json with comments).
+{
+	"skipTerminateQuickPick": true,
+	"skipSwitchToOutput": false,
+	"skipErrorMessage": true,
+	"commands": [
+		{
+			"text": "test",
+			"tooltip": "Run mocha tests.",
+			"color": "lightgreen",
+			"commandType": "script",
+			"command": "test",
+			"priority": 0
+		},
+		{
+			"text": "check_up",
+			"tooltip": "Check update of main deps.",
+			"color": "lightgreen",
+			"commandType": "exec",
+			"command": "php ./check_up.php",
+			"priority": 0
+		}
+	]
+}

package/.vscode/extensions.json

@@ -1,5 +1,6 @@
 {
 	"recommendations": [
+		"gsppvo.vscode-commandbar",
 		"hbenl.vscode-test-explorer",
 		"hbenl.vscode-mocha-test-adapter"
 	]

package/.vscode/launch.json

@@ -13,6 +13,24 @@
 			],
 			"program": "${workspaceFolder}\\${file}"
 		},
+		{
+			"name": "Run current PHP",
+			"type": "php",
+			"request": "launch",
+			"program": "${file}",
+			"cwd": "${fileDirname}",
+			"externalConsole": false,
+			"port": 9003
+		},
+		{
+			"name": "Run check_up",
+			"type": "php",
+			"request": "launch",
+			"program": "${workspaceFolder}\\check_up.php",
+			"cwd": "${workspaceFolder}",
+			"externalConsole": false,
+			"port": 9003
+		},
 		{
 			"type": "node",
 			"request": "launch",

package/DEV.md

@@ -35,24 +35,21 @@ You can also run (and debug) each test case directly from a test file. You might
 
 ## Publishing
 
-Step. 1. Check.
+Step 1. Check and update versions.
 ```bash
-git pull
-npm up
-npm test
+php ./check_up.php
 ```
-If updating Puppeteer, the also:
- - Change `assets/test.js` and/or css.
- - Run `src/ploy_test_full.js`.
-If updating MWN, the also:
- - Change `assets/test.js` and/or css.
- - Run `src/ploy_test_lite.js`.
 
-Step. 2. Change version in the package.
+Step 2a. Test Puppeteer.
+ - Open *Chrome Canary* in *debug* mode.
+ - Run `ploy_test_full.js`.
+
+Step 2b. Test MWN:
+ - Run `ploy_test_lite.js`.
 
-Step. 3. Final commands.
+Step 3. Final commands.
 ```bash
-npm up
+# npm up
 npm test
 npm publish
 ```

package/assets/test.css

@@ -5,4 +5,4 @@
 .tavern {
 	display: block;
 }
-/* puppeteer 21.1.x xor mwn 1.11.x */
+/* puppeteer 21.2.1 xor mwn 1.11.5 */

package/assets/test.js

@@ -5,4 +5,4 @@
  */
 // test.js
 console.log('test');
-/* puppeteer 21.1.x xor mwn 1.11.x */
+/* puppeteer 21.2.1 xor mwn 1.11.5 */

package/check/UpdateChecker.php

@@ -0,0 +1,78 @@
+<?php
+/**
+ * Check for updates.
+ */
+class UpdateChecker {
+	private $nodeLocks;
+	private $package;
+	private $cacheNpm;
+	public $hasChanges = false;
+	/** modified/checked versions */
+	public $versions = array();
+
+	public function __construct() {
+		// Read and decode package-lock.json
+		$content = file_get_contents('package-lock.json');
+		$this->nodeLocks = json_decode($content, true);
+		$content = file_get_contents('package.json');
+		$this->package = json_decode($content, true);
+
+	}
+
+	/** Get latest version from npm site (cached). */
+	private function getNpmVersion($package) {
+		if (empty($this->cacheNpm[$package])) {
+			$version = exec("npm view $package version");
+			$this->cacheNpm[$package] = trim($version);
+		}
+		return $this->cacheNpm[$package];
+	}
+
+	/**
+	 * Check package version.
+	 *
+	 * @param [type] $package
+	 * @return $versionFromNpm when updated.
+	 */
+	public function checkPackage($package) {
+		if (!isset($this->nodeLocks['packages']['node_modules/'.$package]['version'])) {
+			echo "[ERROR] Package $package not found in package-lock.json.\n";
+			// throw new Exception("Unexpected: All packages should be there");
+			return -1;
+		}
+
+		// Get version from package-lock.json
+		$versionFromLock = $this->nodeLocks['packages']['node_modules/'.$package]['version'];
+		$this->versions[$package] = $versionFromLock;
+
+		// Get version from npm site
+		$versionFromNpm = $this->getNpmVersion($package);
+
+		if ($versionFromLock === $versionFromNpm) {
+			echo "[INFO] Versions match for $package (no updates).\n";
+			return true;
+		} else {
+			echo "[INFO] Versions differ for $package: $versionFromLock -> $versionFromNpm\n";
+			$this->package['dependencies'][$package] = preg_replace("#[0-9]+$#", "x", $versionFromNpm);
+			$this->versions[$package] = $versionFromNpm;
+			$this->hasChanges = true;
+			return $versionFromNpm;
+		}
+	}
+
+	/** Update */
+	public function save() {
+		if ($this->hasChanges) {
+			echo "[INFO] Saving changes.\n";
+			$data = json_encode($this->package, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES);
+			file_put_contents('package.json', $data);
+		}
+	}
+
+	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);
+		file_put_contents($path, $content);
+	}
+}

package/check/runner.php

@@ -0,0 +1,24 @@
+<?php
+/**
+ * Simple executioner.
+ *
+ * @param string $command
+ * @param integer $tail
+ * @return void
+ */
+function runner($command, $tail=10) {
+	exec($command, $output, $retval);
+	if ($retval !== 0) {
+		echo "[ERROR] Failed to run command ($command) (returned with status $retval)\n";
+	} else {
+		echo "[INFO] Command ($command) seems OK\n";
+	}
+	if ($tail > 0) {
+		$output = array_slice($output, -$tail);
+	}
+	foreach($output as $line) {
+		echo $line;
+		echo "\n";
+	}
+	echo "\n";
+}

package/check_up.php

@@ -0,0 +1,27 @@
+<?php
+/**
+ * Automated check for updates.
+ */
+require_once "./check/UpdateChecker.php";
+require_once "./check/runner.php";
+
+runner('git pull', -1);
+
+$versionChecker = new UpdateChecker();
+// check and update internals
+$versionChecker->checkPackage("puppeteer");
+$versionChecker->checkPackage("mwn");
+// save
+if ($versionChecker->hasChanges) {
+	$versionChecker->save();
+	// update test.js/css (puppeteer/mwn version)
+	$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";
+	runner('npm test', 3);
+}

package/package.json

@@ -1,36 +1,38 @@
 {
-	"name": "wikiploy",
-	"version": "1.5.1",
-	"description": "User scripts and gadgets deployment for MediaWiki (Wikipedia).",
-	"main": "src/index.js",
-	"type": "module",
-	"scripts": {
-		"test": "mocha"
-	},
-	"repository": {
-		"type": "git",
-		"url": "git+https://github.com/Eccenux/Wikiploy.git"
-	},
-	"keywords": [
-		"Mediawiki",
-		"Wikipedia",
-		"deploy",
-		"rollout",
-		"gadgets"
-	],
-	"author": "Maciej Nux Jaros",
-	"license": "MIT",
-	"bugs": {
-		"url": "https://github.com/Eccenux/Wikiploy/issues"
-	},
-	"homepage": "https://github.com/Eccenux/Wikiploy#readme",
-	"dependencies": {
-		"mwn": "1.11.x",
-		"puppeteer": "21.1.x"
-	},
-	"devDependencies": {
-		"chai": "4.x",
-		"eslint": "8.x",
-		"mocha": "10.x"
-	}
+  "name": "wikiploy",
+  "version": "1.5.4",
+  "description": "User scripts and gadgets deployment for MediaWiki (Wikipedia).",
+  "main": "src/index.js",
+  "type": "module",
+  "scripts": {
+    "bump": "bump patch",
+    "test": "mocha"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Eccenux/Wikiploy.git"
+  },
+  "keywords": [
+    "Mediawiki",
+    "Wikipedia",
+    "deploy",
+    "rollout",
+    "gadgets"
+  ],
+  "author": "Maciej Nux Jaros",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/Eccenux/Wikiploy/issues"
+  },
+  "homepage": "https://github.com/Eccenux/Wikiploy#readme",
+  "dependencies": {
+    "mwn": "1.11.x",
+    "puppeteer": "21.2.x"
+  },
+  "devDependencies": {
+    "bump-version": "0.5.0",
+    "chai": "4.x",
+    "eslint": "8.x",
+    "mocha": "10.x"
+  }
 }