wikiploy 2.0.1 → 2.1.1

package/README.building your project.md

@@ -34,11 +34,9 @@ Your `package.json` (crucial part being `scripts`):
 		"chai": "4.x",
 		"eslint": "8.x",
 		"less": "4.x",
-		"mocha": "10.x"
+		"mocha": "10.x",
+		"wikiploy": "2.x"
 	},
-	"dependencies": {
-		"wikiploy": "1.x"
-	}
 }
 ```
 

package/README.md

@@ -7,12 +7,50 @@ After the initial setup, you can quickly build and deploy your user scripts and
 
 See also:
 
-- [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).
-- [Wikipedia:Wikiploy on pl.wiki](https://pl.wikipedia.org/wiki/Wikipedia:Wikiploy) for Polish description.
+- [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).
+- [Wikipedia:Wikiploy on pl.wiki](https://pl.wikipedia.org/wiki/Wikipedia:Wikiploy) — Polish description.
 - (more links on the bottom)
 
 ## New capabilities
 
+### setupSummary (v2.1)
+
+A helper function that can replace your usages of `userPrompt`. It prompts a user and then supplies
+The `setupSummary` function initializes a summary for a given bot. It requires a `Wikiploy` bot object and optionally takes a gadget version and a standard summary text.
+
+#### Parameters
+
+- `ployBot`: A `Wikiploy` bot object. This is required to setup the `summary()` function.
+- `version` (optional): The version of your gadget. Defaults to an empty string if not provided.
+- `standardSummary` (optional): A string that provides a standard summary aside from the version. Defaults to "changes from Github".
+
+For a prompt answer: "fixed bug #123", you would get: "v5.6.0: fixed bug #123" (`v${version}: ${summary}`).
+
+#### Usage
+
+Basic usage:
+```js
+// custom summary from a prompt
+await setupSummary(ployBot);
+```
+
+Version from package:
+```js
+(async () => {
+	// custom summary from a prompt
+	let version = await readVersion('package.json');
+	await setupSummary(ployBot, version);
+	
+	// [...]
+
+	await ployBot.deploy(configs);
+})().catch(err => {
+	console.error(err);
+	process.exit(1);
+});
+```
+
 ### 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...

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wikiploy",
-  "version": "2.0.1",
+  "version": "2.1.1",
   "description": "User scripts and gadgets deployment for MediaWiki (Wikipedia).",
   "main": "src/index.js",
   "type": "module",

package/src/index.js

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

package/src/userPrompt.js

@@ -1,6 +1,11 @@
 import readline from 'node:readline';
 import { stdin as input, stdout as output } from 'node:process';
 
+/**
+ * Prompt for summary.
+ * @param {String} prompt Prompt information to display.
+ * @returns 
+ */
 const userPrompt = (prompt) => {
 	const rl = readline.createInterface({ input, output });
 
@@ -13,4 +18,22 @@ const userPrompt = (prompt) => {
 	});
 };
 
-export { userPrompt };
+/**
+ * Read (prompt) and setup summary.
+ * @param {WikiployLite} ployBot Bot object (required to setup `summary()`).
+ * @param {Number} version Gadget version.
+ * @param {String} standardSummary Standard summary (aside from version).
+ */
+async function setupSummary(ployBot, version = '', standardSummary = 'changes from Github') {
+	let info = version.length ? `(empty for a standard summary prefixed with v${version})` : `(empty for a standard summary)`;
+	let summary = await userPrompt(`Summary of changes ${info}:`);
+	if (typeof summary !== 'string' || !summary.length) {
+		summary = standardSummary;
+	}
+	ployBot.summary = () => {
+		return version.length ? `v${version}: ${summary}` : summary;
+	};
+	console.log(`[INFO] summary: »${ployBot.summary()}«\n`);
+}
+
+export { userPrompt, setupSummary };