wikiploy 1.6.2 → 1.7.1

package/README.md

@@ -10,6 +10,16 @@ Wikiploy
 User scripts and gadgets deployment for wikis (Wikipedia or more generally MediaWiki based wiki).
 Rollout your JS, CSS etc from your git repository to as many MW wikis as you need.
 
+## New options
+
+### nowiki (v1.7)
+
+Note! It is recomended that you use `nowiki: true` for all JS files. The `nowiki` property is a new option in `DeployConfig` since Wikiploy v1.7.
+
+JavaScript page is still a wiki page... Kind of. It can be added to a category or link to other pages. To avoid this use the nowiki option.
+
+Don't add this option to CSS though. It won't work correctly.
+
 ### Wikiploy full
 
 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. 
@@ -63,6 +73,7 @@ ployBot.summary = () => {
 	configs.push(new DeployConfig({
 		src: 'test.js',
 		dst: '~/test-wikiploy--test.js',
+		nowiki: true,
 	}));
 	await ployBot.deploy(configs);
 })().catch(err => {

package/assets/test.css

@@ -5,4 +5,4 @@
 .tavern {
 	display: block;
 }
-/* puppeteer 21.3.8 xor mwn 2.0.1 */
+/* puppeteer 21.4.1 xor mwn 2.0.1 */

package/assets/test.js

@@ -2,7 +2,9 @@
  * Wikiploy example.
  * 
  * Deployed with love using Wikiploy: [[Wikipedia:Wikiploy]]
+ * 
+ * [[Category:Kopytko]]
  */
 // test.js
 console.log('test');
-/* puppeteer 21.3.8 xor mwn 2.0.1 */
+/* puppeteer 21.4.1 xor mwn 2.0.1 */

package/package.json

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

package/src/DeployConfig.js

@@ -21,6 +21,8 @@ export default class DeployConfig {
 		if (!this.site || typeof this.site != 'string') {
 			this.site = '';
 		}
+		/** Add nowiki tag around code (false by default). */
+		this.nowiki = options?.nowiki;
 		/**
 		 * Custom summary (per file).
 		 * 

package/src/Wikiploy.js

@@ -78,7 +78,7 @@ export default class Wikiploy extends WikiployBase {
 		let url = this.editUrl(config.dst, config);
 		await bot.goto(page, url);
 		// insert the content of the file into the edit field
-		const contents = await fs.readFile(config.src, 'utf8');
+		const contents = this.prepareFile(config, await fs.readFile(config.src, 'utf8'));
 		await bot.fillEdit(page, contents);
 		// edit description
 		const summary = this.prepareSummary(config);

package/src/WikiployBase .js

@@ -33,6 +33,24 @@ export default class WikiployBase {
 		return `${summary} • [[en:WP:Wikiploy|Wikiploy]]`;
 	}
 
+	/**
+	 * Prepare a text file for wiki.
+	 * 
+	 * @param {DeployConfig} config Config.
+	 * @param {String} contents Text file.
+	 * @returns {String} Edit summary.
+	 * @private
+	 */
+	prepareFile(config, contents) {
+		if (config.nowiki) {
+			// if (config.src.search(/\.js$/) > 0) {
+			// }
+			contents = '// <nowiki>\n' + contents + '\n// </nowiki>';
+		}
+		
+		return contents;
+	}
+
 	/** @private Get site for a config. */
 	getSite(config) {
 		let site = config.site.length ? config.site : this.site;

package/src/WikiployLite.js

@@ -79,7 +79,7 @@ export default class WikiployLite extends WikiployBase {
 		// page
 		const pageTitle = config.dst;
 		// content of the file
-		const contents = await fs.readFile(config.src, 'utf8');
+		const contents = this.prepareFile(config, await fs.readFile(config.src, 'utf8'));
 		// edit description
 		const summary = this.prepareSummary(config);
 

package/src/ploy_test_full.js

@@ -11,6 +11,7 @@ const ployBot = new Wikiploy();
 	configs.push(new DeployConfig({
 		src: 'assets/test.js',
 		dst: '~/test-jsbot--test.js',
+		nowiki: true,
 	}));
 	configs.push(new DeployConfig({
 		src: 'assets/test.css',
@@ -20,6 +21,7 @@ const ployBot = new Wikiploy();
 		src: 'assets/test.js',
 		dst: '~/test-jsbot--test.js',
 		site: 'en.wikipedia.org',
+		nowiki: true,
 	}));
 	configs.push(new DeployConfig({
 		src: 'assets/test.css',

package/src/ploy_test_lite.js

@@ -15,11 +15,13 @@ const ployBot = new WikiployLite(botpass);
 	configs.push(new DeployConfig({
 		src: 'assets/test.js',
 		dst: '~/test-wikiploylite--test.js',
+		nowiki: true,
 	}));
 	configs.push(new DeployConfig({
 		src: 'assets/test.js',
 		dst: '~/test-wikiploylite--test.js',
 		site: 'en.wikipedia.org',
+		nowiki: true,
 	}));
 	configs.push(new DeployConfig({
 		src: 'assets/test.css',

package/test/Wikiploy.test.js

@@ -45,4 +45,31 @@ describe('Wikiploy', function () {
 			assert.equal(summary, expected);
 		});
 	});
+
+	describe('prepareFile', function () {
+		const ployBot = new Wikiploy();
+		function prepareFile(contents, configDef) {
+			const config = new DeployConfig(configDef);
+			let result = ployBot.prepareFile(config, contents);
+			return result;
+		}
+
+		it('should default to no change', function () {
+			let file = 'abc def';
+			let expected = file;
+			const result = prepareFile(file, {
+				src: 'test.js',
+			});
+			assert.equal(result, expected);
+		});
+		it('should add nowiki to js', function () {
+			let file = 'abc def';
+			let expected = '// <nowiki>\nabc def\n// </nowiki>';
+			const result = prepareFile(file, {
+				src: 'test.js',
+				nowiki: true,
+			});
+			assert.equal(result, expected);
+		});
+	});
 });