mediawiki-projects-list 1.0.0 → 1.0.1

package/.github/workflows/npm.yml

@@ -0,0 +1,26 @@
+name: Publish to npm
+
+on:
+  push:
+    branches:    
+      - 'master'
+    paths:
+      - 'package.json'
+
+jobs:
+  publish-npm:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
+      - uses: actions/setup-node@v3
+        with:
+          registry-url: 'https://npm.pkg.github.com'
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}

package/README.md

@@ -1,28 +1,28 @@
-# List of MediaWiki projects
-
-```json
-{
-	"name": "wikipedia.org",
-	"regex": "((?:([a-z\\d-]{1,50})\\.)?(?:m\\.)?wikipedia\\.org)",
-	"articlePath": "/wiki/",
-	"scriptPath": "/w/",
-	"wikiFarm": "wikimedia",
-	"extensions": [
-		"CentralAuth"
-	]
-}
-```
-
-## How to check if a URL matches a wiki project
-
-* `name` - The hostname of the URL should match the `name`.
-* `regex` - Match the URL against the regex
-  * `$1` - Hostname and path between `https://` and `articlePath` or `scriptPath`
-  * `$n` - If the hostname contains multiple wikis, additional groups are used to uniquely identify them
-* `articlePath` - Article path of the project is `https://` + `$1` + `articlePath`
-* `scriptPath` - Script path of the project is `https://` + `$1` + `scriptPath`
-* `regexPaths` - If true, `articlePath` and `scriptPath` include group matches of `regex`
-* `wikiFarm` - Name of the wiki farm the project belongs to (`wikimedia`, `fandom`, `miraheze`, `wiki.gg`)
-* `extensions` - List of extensions providing useful API endpoints (`CentralAuth`, `Cargo`)
-* `urlSpaceReplacement` - Replacement for spaces in page names (default: `_`; wikihow.com: `-`)
+# List of MediaWiki projects
+
+```json
+{
+	"name": "wikipedia.org",
+	"regex": "((?:([a-z\\d-]{1,50})\\.)?(?:m\\.)?wikipedia\\.org)",
+	"articlePath": "/wiki/",
+	"scriptPath": "/w/",
+	"wikiFarm": "wikimedia",
+	"extensions": [
+		"CentralAuth"
+	]
+}
+```
+
+## How to check if a URL matches a wiki project
+
+* `name` - The hostname of the URL should match the `name`.
+* `regex` - Match the URL against the regex
+  * `$1` - Hostname and path between `https://` and `articlePath` or `scriptPath`
+  * `$n` - If the hostname contains multiple wikis, additional groups are used to uniquely identify them
+* `articlePath` - Article path of the project is `https://` + `$1` + `articlePath`
+* `scriptPath` - Script path of the project is `https://` + `$1` + `scriptPath`
+* `regexPaths` - If true, `articlePath` and `scriptPath` include group matches of `regex`
+* `wikiFarm` - Name of the wiki farm the project belongs to (`wikimedia`, `fandom`, `miraheze`, `wiki.gg`)
+* `extensions` - List of extensions providing useful API endpoints (`CentralAuth`, `Cargo`)
+* `urlSpaceReplacement` - Replacement for spaces in page names (default: `_`; wikihow.com: `-`)
 * `note` - Usage notes for the API of a specific project

package/index.js

@@ -1,130 +1,130 @@
-const {properties: {wikiProjects: {items: {properties: wikiProjectSchema}}}} = require('./projects-schema.json');
-
-/**
- * A MediaWiki project
- * @typedef {object} WikiProject
- * @property {string} name - Hostname of the project
- * @property {string} regex - Regex to match the project url
- * @property {string} articlePath - Article path of the project
- * @property {string} scriptPath - Script path of the project
- * @property {object} [idString] - Only exists when the hostname contains multiple wikis: How to handle the id string
- * @property {string} idString.separator - Separator to join or split the id string on
- * @property {"asc"|"desc"} idString.direction - Order in which the project regex additional group matches should be chained to gain the id string
- * @property {string} idString.regex - Regex to match the id string
- * @property {string[]} idString.scriptPaths - How to turn the group matches of the id string regex into an URL to the script path, index based on group matches
- * @property {boolean} regexPaths - Whether the paths include matches of the regex
- * @property {?("wikimedia"|"fandom"|"miraheze"|"wiki.gg")} wikiFarm - Wiki farm of the project
- * @property {("CentralAuth"|"Cargo")[]} extensions - List of extensions providing useful API endpoints
- * @property {string} urlSpaceReplacement - Replacement for spaces in the article URL
- * @property {?string} note - Note about the specific project
- */
-
-/**
- * @type {{
- *     inputToWikiProject: Map<string, ?{fullArticlePath: string, fullScriptPath: string, wikiProject: WikiProject}>,
- *     urlToIdString: Map<string, ?string>,
- *     idStringToUrl: Map<string, ?string>
- * }}
- */
-const functionCache = {
-	inputToWikiProject: new Map(),
-	urlToIdString: new Map(),
-	idStringToUrl: new Map()
-};
-
-/**
- * List of MediaWiki projects
- * @type {WikiProject[]}
- */
-const wikiProjects = require('./projects.json').wikiProjects.map( wikiProject => {
-	if ( wikiProject.idString ) {
-		wikiProject.idString.separator ??= wikiProjectSchema.idString.properties.separator.default;
-		wikiProject.idString.direction ??= wikiProjectSchema.idString.properties.direction.default;
-	}
-	wikiProject.regexPaths ??= wikiProjectSchema.regexPaths.default;
-	wikiProject.wikiFarm ??= wikiProjectSchema.wikiFarm.default;
-	wikiProject.extensions ??= wikiProjectSchema.extensions.default.slice();
-	wikiProject.urlSpaceReplacement ??= wikiProjectSchema.urlSpaceReplacement.default;
-	wikiProject.note ??= wikiProjectSchema.note.default;
-	return wikiProject;
-} );
-
-/**
- * 
- * @param {string} input 
- * @returns {?{fullArticlePath: string, fullScriptPath: string, wikiProject: WikiProject}}
- */
-function inputToWikiProject(input) {
-	if ( functionCache.inputToWikiProject.has(input) ) return structuredClone(functionCache.inputToWikiProject.get(input));
-	let result = null;
-	let wikiProject = wikiProjects.find( wikiProject => input.split('/').slice(0, 3).some( part => part.endsWith( wikiProject.name ) ) );
-	if ( wikiProject ) {
-		let articlePath = ( wikiProject.regexPaths ? '/' : wikiProject.articlePath );
-		let scriptPath = ( wikiProject.regexPaths ? '/' : wikiProject.scriptPath );
-		let regex = input.match( new RegExp( wikiProject.regex + `(?:${articlePath}|${scriptPath}|/?$)` ) );
-		if ( regex ) {
-			if ( wikiProject.regexPaths ) {
-				scriptPath = wikiProject.scriptPath.replace( /\$(\d)/g, (match, n) => regex[n] );
-				articlePath = wikiProject.articlePath.replace( /\$(\d)/g, (match, n) => regex[n] );
-			}
-			result = {
-				fullArticlePath: 'https://' + regex[1] + articlePath,
-				fullScriptPath: 'https://' + regex[1] + scriptPath,
-				wikiProject: wikiProject
-			};
-		}
-	}
-	functionCache.inputToWikiProject.set(input, result);
-	return structuredClone(result);
-}
-
-/**
- * 
- * @param {URL} url 
- * @returns {?string}
- */
-function urlToIdString(url) {
-	if ( functionCache.urlToIdString.has(url.href) ) return functionCache.urlToIdString.get(url.href);
-	let result = null;
-	let wikiProject = wikiProjects.find( wikiProject => wikiProject.idString && url.hostname.endsWith( wikiProject.name ) );
-	if ( wikiProject ) {
-		let regex = url.href.match( new RegExp( wikiProject.regex ) )?.slice(2);
-		if ( regex?.length ) {
-			if ( wikiProject.idString.direction === 'desc' ) regex.reverse();
-			result = regex.join(wikiProject.idString.separator);
-		}
-	}
-	functionCache.urlToIdString.set(url.href, result);
-	return result;
-}
-
-/**
- * 
- * @param {string} idString 
- * @param {string} projectName 
- * @returns {?URL}
- */
-function idStringToUrl(idString, projectName) {
-	let cacheKey = JSON.stringify([idString,projectName]);
-	if ( functionCache.idStringToUrl.has(cacheKey) ) {
-		let result = functionCache.idStringToUrl.get(cacheKey);
-		return ( result ? new URL(result) : result );
-	}
-	let result = null;
-	let wikiProject = wikiProjects.find( wikiProject => wikiProject.idString && wikiProject.name === projectName )?.idString;
-	if ( wikiProject ) {
-		let regex = idString.match( new RegExp( '^' + wikiProject.regex + '$' ) )?.[1].split(wikiProject.separator);
-		if ( regex && regex.length <= wikiProject.scriptPaths.length ) {
-			result = wikiProject.scriptPaths[regex.length - 1].replace( /\$(\d)/g, (match, n) => regex[n - 1] );
-		}
-	}
-	functionCache.idStringToUrl.set(cacheKey, result);
-	return ( result ? new URL(result) : result );
-}
-
-module.exports = {
-	wikiProjects,
-	inputToWikiProject,
-	urlToIdString,
-	idStringToUrl
+const {properties: {wikiProjects: {items: {properties: wikiProjectSchema}}}} = require('./projects-schema.json');
+
+/**
+ * A MediaWiki project
+ * @typedef {object} WikiProject
+ * @property {string} name - Hostname of the project
+ * @property {string} regex - Regex to match the project url
+ * @property {string} articlePath - Article path of the project
+ * @property {string} scriptPath - Script path of the project
+ * @property {object} [idString] - Only exists when the hostname contains multiple wikis: How to handle the id string
+ * @property {string} idString.separator - Separator to join or split the id string on
+ * @property {"asc"|"desc"} idString.direction - Order in which the project regex additional group matches should be chained to gain the id string
+ * @property {string} idString.regex - Regex to match the id string
+ * @property {string[]} idString.scriptPaths - How to turn the group matches of the id string regex into an URL to the script path, index based on group matches
+ * @property {boolean} regexPaths - Whether the paths include matches of the regex
+ * @property {?("wikimedia"|"fandom"|"miraheze"|"wiki.gg")} wikiFarm - Wiki farm of the project
+ * @property {("CentralAuth"|"Cargo")[]} extensions - List of extensions providing useful API endpoints
+ * @property {string} urlSpaceReplacement - Replacement for spaces in the article URL
+ * @property {?string} note - Note about the specific project
+ */
+
+/**
+ * @type {{
+ *     inputToWikiProject: Map<string, ?{fullArticlePath: string, fullScriptPath: string, wikiProject: WikiProject}>,
+ *     urlToIdString: Map<string, ?string>,
+ *     idStringToUrl: Map<string, ?string>
+ * }}
+ */
+const functionCache = {
+	inputToWikiProject: new Map(),
+	urlToIdString: new Map(),
+	idStringToUrl: new Map()
+};
+
+/**
+ * List of MediaWiki projects
+ * @type {WikiProject[]}
+ */
+const wikiProjects = require('./projects.json').wikiProjects.map( wikiProject => {
+	if ( wikiProject.idString ) {
+		wikiProject.idString.separator ??= wikiProjectSchema.idString.properties.separator.default;
+		wikiProject.idString.direction ??= wikiProjectSchema.idString.properties.direction.default;
+	}
+	wikiProject.regexPaths ??= wikiProjectSchema.regexPaths.default;
+	wikiProject.wikiFarm ??= wikiProjectSchema.wikiFarm.default;
+	wikiProject.extensions ??= wikiProjectSchema.extensions.default.slice();
+	wikiProject.urlSpaceReplacement ??= wikiProjectSchema.urlSpaceReplacement.default;
+	wikiProject.note ??= wikiProjectSchema.note.default;
+	return wikiProject;
+} );
+
+/**
+ * 
+ * @param {string} input 
+ * @returns {?{fullArticlePath: string, fullScriptPath: string, wikiProject: WikiProject}}
+ */
+function inputToWikiProject(input) {
+	if ( functionCache.inputToWikiProject.has(input) ) return structuredClone(functionCache.inputToWikiProject.get(input));
+	let result = null;
+	let wikiProject = wikiProjects.find( wikiProject => input.split('/').slice(0, 3).some( part => part.endsWith( wikiProject.name ) ) );
+	if ( wikiProject ) {
+		let articlePath = ( wikiProject.regexPaths ? '/' : wikiProject.articlePath );
+		let scriptPath = ( wikiProject.regexPaths ? '/' : wikiProject.scriptPath );
+		let regex = input.match( new RegExp( wikiProject.regex + `(?:${articlePath}|${scriptPath}|/?$)` ) );
+		if ( regex ) {
+			if ( wikiProject.regexPaths ) {
+				scriptPath = wikiProject.scriptPath.replace( /\$(\d)/g, (match, n) => regex[n] );
+				articlePath = wikiProject.articlePath.replace( /\$(\d)/g, (match, n) => regex[n] );
+			}
+			result = {
+				fullArticlePath: 'https://' + regex[1] + articlePath,
+				fullScriptPath: 'https://' + regex[1] + scriptPath,
+				wikiProject: wikiProject
+			};
+		}
+	}
+	functionCache.inputToWikiProject.set(input, result);
+	return structuredClone(result);
+}
+
+/**
+ * 
+ * @param {URL} url 
+ * @returns {?string}
+ */
+function urlToIdString(url) {
+	if ( functionCache.urlToIdString.has(url.href) ) return functionCache.urlToIdString.get(url.href);
+	let result = null;
+	let wikiProject = wikiProjects.find( wikiProject => wikiProject.idString && url.hostname.endsWith( wikiProject.name ) );
+	if ( wikiProject ) {
+		let regex = url.href.match( new RegExp( wikiProject.regex ) )?.slice(2);
+		if ( regex?.length ) {
+			if ( wikiProject.idString.direction === 'desc' ) regex.reverse();
+			result = regex.join(wikiProject.idString.separator);
+		}
+	}
+	functionCache.urlToIdString.set(url.href, result);
+	return result;
+}
+
+/**
+ * 
+ * @param {string} idString 
+ * @param {string} projectName 
+ * @returns {?URL}
+ */
+function idStringToUrl(idString, projectName) {
+	let cacheKey = JSON.stringify([idString,projectName]);
+	if ( functionCache.idStringToUrl.has(cacheKey) ) {
+		let result = functionCache.idStringToUrl.get(cacheKey);
+		return ( result ? new URL(result) : result );
+	}
+	let result = null;
+	let wikiProject = wikiProjects.find( wikiProject => wikiProject.idString && wikiProject.name === projectName )?.idString;
+	if ( wikiProject ) {
+		let regex = idString.match( new RegExp( '^' + wikiProject.regex + '$' ) )?.[1].split(wikiProject.separator);
+		if ( regex && regex.length <= wikiProject.scriptPaths.length ) {
+			result = wikiProject.scriptPaths[regex.length - 1].replace( /\$(\d)/g, (match, n) => regex[n - 1] );
+		}
+	}
+	functionCache.idStringToUrl.set(cacheKey, result);
+	return ( result ? new URL(result) : result );
+}
+
+module.exports = {
+	wikiProjects,
+	inputToWikiProject,
+	urlToIdString,
+	idStringToUrl
 };

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "mediawiki-projects-list",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "type": "commonjs",
   "description": "List of MediaWiki projects for use in discord-wiki-bot",
   "main": "index.js",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/Markus-Rost/mediawiki-projects-list.git"
+    "url": "https://github.com/Markus-Rost/mediawiki-projects-list.git"
   },
   "keywords": [
     "mediawiki"

package/projects-schema.json

@@ -1,130 +1,130 @@
-{
-	"$schema": "https://json-schema.org/draft-07/schema",
-	"$id": "./projects.json",
-	"type": "object",
-	"title": "List of MediaWiki projects",
-	"description": "List of MediaWiki projects for use in discord-wiki-bot",
-	"properties": {
-		"$schema": {
-			"type": "string",
-			"format": "path"
-		},
-		"wikiProjects": {
-			"type": "array",
-			"description": "List of MediaWiki projects",
-			"items": {
-				"type": "object",
-				"description": "A MediaWiki project",
-				"properties": {
-					"name": {
-						"type": "string",
-						"description": "Hostname of the project"
-					},
-					"regex": {
-						"type": "string",
-						"description": "Regex to match the project url"
-					},
-					"articlePath": {
-						"type": "string",
-						"description": "Article path of the project"
-					},
-					"scriptPath": {
-						"type": "string",
-						"description": "Script path of the project"
-					},
-					"idString": {
-						"type": "object",
-						"description": "Only exists when the hostname contains multiple wikis: How to handle the id string",
-						"properties": {
-							"separator": {
-								"type": "string",
-								"description": "Separator to join or split the id string on",
-								"default": "."
-							},
-							"direction": {
-								"type": "string",
-								"description": "Order in which the project regex additional group matches should be chained to gain the id string",
-								"enum": [
-									"asc",
-									"desc"
-								],
-								"default": "desc"
-							},
-							"regex": {
-								"type": "string",
-								"description": "Regex to match the id string"
-							},
-							"scriptPaths": {
-								"type": "array",
-								"description": "How to turn the group matches of the id string regex into an URL to the script path, index based on group matches",
-								"items": {
-									"type": "string",
-									"description": "Replacement for the id string regex match."
-								},
-								"contains": true,
-								"additionalItems": false
-							}
-						},
-						"required": [
-							"regex",
-							"scriptPaths"
-						],
-						"additionalProperties": false
-					},
-					"regexPaths": {
-						"type": "boolean",
-						"description": "Whether the paths include matches of the regex",
-						"default": false
-					},
-					"wikiFarm": {
-						"type": "string",
-						"description": "Wiki farm of the project",
-						"enum": [
-							"wikimedia",
-							"fandom",
-							"miraheze",
-							"wiki.gg"
-						],
-						"default": null
-					},
-					"extensions": {
-						"type": "array",
-						"description": "List of extensions providing useful API endpoints",
-						"items": {
-							"type": "string",
-							"description": "Name of an extension providing useful API endpoints",
-							"enum": [
-								"CentralAuth",
-								"Cargo"
-							]
-						},
-						"default": [],
-						"additionalItems": false
-					},
-					"urlSpaceReplacement": {
-						"type": "string",
-						"description": "Replacement for spaces in the article URL",
-						"default": "_"
-					},
-					"note": {
-						"type": "string",
-						"description": "Note about the specific project",
-						"default": null
-					}
-				},
-				"required": [
-					"name",
-					"regex",
-					"articlePath",
-					"scriptPath"
-				],
-				"additionalProperties": false
-			},
-			"additionalItems": false
-		}
-	},
-	"required": [
-		"wikiProjects"
-	],
-	"additionalProperties": false
+{
+	"$schema": "https://json-schema.org/draft-07/schema",
+	"$id": "./projects.json",
+	"type": "object",
+	"title": "List of MediaWiki projects",
+	"description": "List of MediaWiki projects for use in discord-wiki-bot",
+	"properties": {
+		"$schema": {
+			"type": "string",
+			"format": "path"
+		},
+		"wikiProjects": {
+			"type": "array",
+			"description": "List of MediaWiki projects",
+			"items": {
+				"type": "object",
+				"description": "A MediaWiki project",
+				"properties": {
+					"name": {
+						"type": "string",
+						"description": "Hostname of the project"
+					},
+					"regex": {
+						"type": "string",
+						"description": "Regex to match the project url"
+					},
+					"articlePath": {
+						"type": "string",
+						"description": "Article path of the project"
+					},
+					"scriptPath": {
+						"type": "string",
+						"description": "Script path of the project"
+					},
+					"idString": {
+						"type": "object",
+						"description": "Only exists when the hostname contains multiple wikis: How to handle the id string",
+						"properties": {
+							"separator": {
+								"type": "string",
+								"description": "Separator to join or split the id string on",
+								"default": "."
+							},
+							"direction": {
+								"type": "string",
+								"description": "Order in which the project regex additional group matches should be chained to gain the id string",
+								"enum": [
+									"asc",
+									"desc"
+								],
+								"default": "desc"
+							},
+							"regex": {
+								"type": "string",
+								"description": "Regex to match the id string"
+							},
+							"scriptPaths": {
+								"type": "array",
+								"description": "How to turn the group matches of the id string regex into an URL to the script path, index based on group matches",
+								"items": {
+									"type": "string",
+									"description": "Replacement for the id string regex match."
+								},
+								"contains": true,
+								"additionalItems": false
+							}
+						},
+						"required": [
+							"regex",
+							"scriptPaths"
+						],
+						"additionalProperties": false
+					},
+					"regexPaths": {
+						"type": "boolean",
+						"description": "Whether the paths include matches of the regex",
+						"default": false
+					},
+					"wikiFarm": {
+						"type": "string",
+						"description": "Wiki farm of the project",
+						"enum": [
+							"wikimedia",
+							"fandom",
+							"miraheze",
+							"wiki.gg"
+						],
+						"default": null
+					},
+					"extensions": {
+						"type": "array",
+						"description": "List of extensions providing useful API endpoints",
+						"items": {
+							"type": "string",
+							"description": "Name of an extension providing useful API endpoints",
+							"enum": [
+								"CentralAuth",
+								"Cargo"
+							]
+						},
+						"default": [],
+						"additionalItems": false
+					},
+					"urlSpaceReplacement": {
+						"type": "string",
+						"description": "Replacement for spaces in the article URL",
+						"default": "_"
+					},
+					"note": {
+						"type": "string",
+						"description": "Note about the specific project",
+						"default": null
+					}
+				},
+				"required": [
+					"name",
+					"regex",
+					"articlePath",
+					"scriptPath"
+				],
+				"additionalProperties": false
+			},
+			"additionalItems": false
+		}
+	},
+	"required": [
+		"wikiProjects"
+	],
+	"additionalProperties": false
 }