☰

docs.gradle.org: permalink to actual version

Adds a permalink for Gradle documentation pages (including /current/) to the exact version to help create better links to docs.gradle.org

目前为 2023-07-12 提交的版本。查看 最新版本。

// ==UserScript==
// @name         docs.gradle.org: permalink to actual version
// @description  Adds a permalink for Gradle documentation pages (including /current/) to the exact version to help create better links to docs.gradle.org
// @version      2
// @match        https://docs.gradle.org/*
// @namespace    https://github.com/rybak
// @license      MIT
// @author       Andrei Rybak
// @icon         https://www.google.com/s2/favicons?sz=64&domain=gradle.org
// @grant        none
// ==/UserScript==

/*
 * Copyright (c) 2023 Andrei Rybak
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

(function() {
	'use strict';

	const LOG_PREFIX = '[docs.gradle.org permalink]:';

	function log(...toLog) {
		console.log(LOG_PREFIX, ...toLog);
	}

	function warn(...toLog) {
		console.warn(LOG_PREFIX, ...toLog);
	}

	function getLdJsonUrl() {
		const jsons = document.querySelectorAll('script[type="application/ld+json"]');
		for (let e of jsons) {
			const parsed = JSON.parse(e.textContent);
			if ('url' in parsed) {
				return parsed.url;
			}
		}
		return null;
	}

	function createPermalink(version) {
		const currentUrl = document.location.href;
		const permaUrl = currentUrl.includes('/current/') ? currentUrl.replace('docs.gradle.org/current/', 'docs.gradle.org/' + version + '/') : currentUrl;
		log('Permalink:', permaUrl);
		const a = document.createElement('a');
		a.href = permaUrl;
		a.text = '[permalink ' + version + ']';
		a.style.cssText += `
				margin-top: 1.2em;
    			margin-left: 1em;
    			display: block;
    			align-self: center;
    			height: 36px;`;
		return a;
	}

	// from https://stackoverflow.com/a/61511955/1083697 by Yong Wang
	function waitForElement(selector) {
		return new Promise(resolve => {
			if (document.querySelector(selector)) {
				return resolve(document.querySelector(selector));
			}
			const observer = new MutationObserver(mutations => {
				if (document.querySelector(selector)) {
					resolve(document.querySelector(selector));
					observer.disconnect();
				}
			});

			observer.observe(document.body, {
				childList: true,
				subtree: true
			});
		});
	}

	function addPermalink() {
		const versionElement = document.querySelector("#command_line_interface > div.layout > header > nav > div.site-header__navigation-header > div.site-header-version > ul > li > span > span");

		// siteDecorateVersion is a variable in Gradle's own JS
		if (versionElement || typeof siteDecorateVersion !== 'undefined') {
			// log("JSON:", getLdJsonUrl());

			if (typeof siteDecorateVersion !== 'undefined') {
				log("siteDecorateVersion", siteDecorateVersion);
			} else {
				warn("siteDecorateVersion is not defined");
			}

			const version = typeof siteDecorateVersion !== 'undefined' ? siteDecorateVersion : versionElement.innerHTML;
			const a = createPermalink(version);

			// element that contains either the version selector dropdown (in tutorial docs) or the version display `.site-header-version` (javadocs)
			waitForElement('nav .site-header__navigation-header').then(container => {
				container.append(a);
			});
		} else {
			log('Did not find version element and siteDecorateVersion is not defined. Trying again...');
			setTimeout(createPermalink, 500);
		}
	}

	addPermalink();
})();