wikiploy 2.1.4 → 2.2.1

package/.vscode/extensions.json

@@ -2,6 +2,8 @@
 	"recommendations": [
 		"gsppvo.vscode-commandbar",
 		"hbenl.vscode-test-explorer",
-		"hbenl.vscode-mocha-test-adapter"
+		"hbenl.vscode-mocha-test-adapter",
+		"xdebug.php-debug",
+		"recca0120.vscode-phpunit"
 	]
 }

package/DEV.md

@@ -33,6 +33,14 @@ To view output of individual tests use the testing sidebar. Navigate to the test
 
 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.
 
+## PHP tests
+
+```powershell
+#composer update
+composer install
+composer test
+```
+
 ## Publishing
 
 Step 1. Check and update versions.

package/README.md

@@ -1,11 +1,30 @@
 Wikiploy
 ==========================
 
-Wikiploy is a one-click solution to deploy JS and CSS to Wikipedia.
+Wikiploy is a one-click solution to deploy JS and CSS to Wikipedia. It uses NodeJS version 14 or higher.
 
 After the initial setup, you can quickly build and deploy your user scripts and gadgets. Though this was designed to work with Wikipedia, you should be able to deploy to any [MediaWiki](https://www.mediawiki.org/)-based wiki. You can even deploy to multiple websites with just one click on your commandbar. Your only limitation is your access level to the wikis.
 
-See also:
+## Table of contents
+<!-- TOC depthfrom:2 updateonsave:false -->
+
+- [Table of contents](#table-of-contents)
+- [See also](#see-also)
+- [New capabilities](#new-capabilities)
+	- [setupSummary v2.1](#setupsummary-v21)
+		- [Parameters](#parameters)
+		- [Usage](#usage)
+	- [Lightweight Dependencies v2.0](#lightweight-dependencies-v20)
+	- [userPrompt v1.8](#userprompt-v18)
+	- [nowiki v1.7](#nowiki-v17)
+- [Using Wikiploy](#using-wikiploy)
+- [Botpass configuration](#botpass-configuration)
+- [Different wiki sites](#different-wiki-sites)
+- [External links](#external-links)
+
+<!-- /TOC -->
+
+## See also
 
 - [Wikiploy project template](https://github.com/Eccenux/wikiploy-rollout-example/releases) — quick start for you gadgets.
 - [README: building your project](https://github.com/Eccenux/Wikiploy/blob/main/README.building%20your%20project.md) — recommendation on how to build JS and CSS for your gadgets (includes unit testing setup).

package/assets/test.css

@@ -5,4 +5,4 @@
 .tavern {
 	display: block;
 }
-/*## Wikiploy v2.1.4 with MWN v2.0.2 ##*/
+/*## Wikiploy v2.2.0 with MWN v3.0.1 ##*/

package/assets/test.js

@@ -7,4 +7,4 @@
  */
 // test.js
 console.log('test');
-/*## Wikiploy v2.1.4 with MWN v2.0.2 ##*/
+/*## Wikiploy v2.2.0 with MWN v3.0.1 ##*/

package/check/UpdateChecker.php

@@ -1,4 +1,6 @@
 <?php
+namespace Wikiploy;
+
 /**
  * Check for updates.
  */
@@ -93,4 +95,43 @@ class UpdateChecker {
 		$content = preg_replace('@(/\*##).+(##\*/)@', $versionInfo, $content);
 		file_put_contents($path, $content);
 	}
+
+	/**
+	 * Update a script with version.
+	 *
+	 * @param string $path I/O path.
+	 */
+	public function updateScript($path, $vName, $version) {
+		$input = file_get_contents($path);
+		$content = self::updateScriptContent($input, $vName, $version);
+		file_put_contents($path, $content);
+	}
+	/**
+	 * Update input text with named version.
+	 * 
+	 * @param string $input Input.
+	 * @param string $vName Name of the version (added in marker).
+	 * @param string $version New version number.
+	 */
+	public static function updateScriptContent($input, $vName, $version):string {
+		// Example:
+		// /*version:vName:*/''/*:vName:version*/
+		$content = preg_replace_callback(
+			'@(/\*version:'.$vName.':\*/)(?:(\')[^\']*\'|(")[^"]*")(/\*:'.$vName.':version\*/)@',
+			function ($matches) use ($version) {
+				$qt = !empty($matches[2]) ? $matches[2] : $matches[3];
+				return $matches[1].$qt.$version.$qt.$matches[4];
+			},
+			$input
+		);
+		return $content;
+	}
 }
+
+// quick debug
+// $input = "const version = /*version:main:*/''/*:main:version*/;";
+// $expected = "const version = /*version:main:*/'3.0.0'/*:main:version*/;";
+// $result = UpdateChecker::updateScriptContent($input, 'main', '3.0.0');
+// echo "\n e: $expected";
+// echo "\n r: $result";
+

package/check/runner.php

@@ -1,4 +1,6 @@
 <?php
+namespace Wikiploy;
+
 /**
  * Simple executioner.
  *

package/check_up.php

@@ -1,4 +1,6 @@
 <?php
+namespace Wikiploy;
+
 /**
  * Automated check for updates.
  */
@@ -9,28 +11,35 @@ runner('git pull', -1);
 
 $options = getopt("", ["force"]);
 
-$versionChecker = new UpdateChecker();
+$upChecker = new UpdateChecker();
+
+// update package version
+$packageVersion = $upChecker->checkMain();
+$upChecker->updateScript("./src/WikiployLite.js", "main", $packageVersion);
+
 // check and update internals
-// $versionChecker->checkPackage("puppeteer");
-$versionChecker->checkPackage("mwn");
+// $upChecker->checkPackage("puppeteer");
+$upChecker->checkPackage("mwn");
 // save
-if (!isset($options['force']) && !$versionChecker->hasChanges) {
+if (!isset($options['force']) && !$upChecker->hasChanges) {
 	echo "\n[INFO] No updates for main deps.\n";
 } else {
-	$versionChecker->save();
+	$upChecker->save();
 
 	echo "\n[INFO] Bump version\n";
 	runner('npm run bump');
 
-	$packageVersion = $versionChecker->checkMain(); // check and update internals
+	$packageVersion = $upChecker->checkMain(); // check and update internals
 	echo "\n[INFO] New version: $packageVersion\n";
+	// re-update package version
+	$upChecker->updateScript("./src/WikiployLite.js", "main", $packageVersion);
 	// 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');
+	$upChecker->updateAsset('assets/test.css');
+	$upChecker->updateAsset('assets/test.js');
 
 	echo "\n[INFO] Update packages and locks\n";
 	runner('npm up');
 	echo "\n[INFO] Test\n";
 	runner('npm test', 3);
-}
+}

package/composer.json

@@ -0,0 +1,20 @@
+{
+	"name": "nux/wikiploy",
+	"type": "project",
+	"require-dev": {
+		"phpunit/phpunit": "^11.0"
+	},
+	"autoload": {
+		"psr-4": {
+			"Wikiploy\\": "check/"
+		}
+	},
+	"autoload-dev": {
+		"psr-4": {
+			"Wikiploy\\Tests\\": "test/"
+		}
+	},
+	"scripts": {
+		"test": "phpunit"
+	}
+}