wikiploy 2.0.0 → 2.1.0

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,8 +7,9 @@ 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
@@ -21,6 +22,12 @@ The only change is that you need to provide bot configuration to Wikiploy (as al
 
 `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.
@@ -36,22 +43,22 @@ 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
 
+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
+```
+
 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 ;).
 
-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 stadnard account and special password just for your scripts.
+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.
 
 ## 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.
 
-1. Begin by setting up your sub-account on this page: [https://test.wikipedia.org/wiki/Special:BotPasswords](test.wikipedia.org/wiki/Special:BotPasswords).
+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`.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wikiploy",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "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 };