tiddlywiki 5.1.23 → 5.2.2

package/.eslintignore

@@ -1,15 +1,8 @@
-# Known minified files
+# Ignore "third party" code whose style we will not change.
 /boot/sjcl.js
+/core/modules/utils/base64-utf8/base64-utf8.module.js
 /core/modules/utils/base64-utf8/base64-utf8.module.min.js
 /core/modules/utils/diff-match-patch/diff_match_patch.js
-/plugins/tiddlywiki/async/files/async.min.v1.5.0.js
-/plugins/tiddlywiki/codemirror-autocomplete/files/addon/hint/anyword-hint.js
-/plugins/tiddlywiki/codemirror-autocomplete/files/addon/hint/css-hint.js
-/plugins/tiddlywiki/codemirror-autocomplete/files/addon/hint/html-hint.js
-/plugins/tiddlywiki/codemirror-autocomplete/files/addon/hint/javascript-hint.js
-/plugins/tiddlywiki/codemirror-autocomplete/files/addon/hint/show-hint.js
-/plugins/tiddlywiki/codemirror-autocomplete/files/addon/hint/xml-hint.js
-/plugins/tiddlywiki/codemirror-closebrackets/files/addon/edit/closebrackets.js
-/plugins/tiddlywiki/codemirror-closebrackets/files/addon/edit/matchbrackets.js
-/plugins/tiddlywiki/codemirror-closetag/files/addon/edit/closetag.js
-/plugins/tiddlywiki/codemirror-closetag/files/addon/fold/xml-fold.js
+/core/modules/utils/diff-match-patch/diff_match_patch_uncompressed.js
+/core/modules/utils/dom/csscolorparser.js
+/plugins/tiddlywiki/*/files/

package/.eslintrc.yml

@@ -64,7 +64,23 @@ rules:
   init-declarations: 'off'
   jsx-quotes: error
   key-spacing: 'off'
-  keyword-spacing: 'off'
+  keyword-spacing:
+    - error
+    - before: true
+      after: false
+      overrides:
+        'case':
+          after: true
+        'do':
+          'after': true
+        'else':
+          after: true
+        'return':
+          after: true
+        'throw':
+          after: true
+        'try':
+          after: true
   line-comment-position: 'off'
   linebreak-style: 'off'
   lines-around-comment: 'off'

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -23,6 +23,11 @@ A clear and concise description of what you expected to happen.
 **Screenshots**
 If applicable, add screenshots to help explain your problem.
 
+**TiddlyWiki Configuration (please complete the following information):**
+ - Version [e.g. v5.1.24]
+ - Saving mechanism [e.g. Node.js, TiddlyDesktop, TiddlyHost etc]
+ - Plugins installed [e.g. Freelinks, TiddlyMap]
+ 
 **Desktop (please complete the following information):**
  - OS: [e.g. iOS]
  - Browser [e.g. chrome, safari]

package/.github/workflows/ci.yml

@@ -72,3 +72,6 @@ jobs:
       - run: "./bin/ci-push.sh"
         env:
           GH_TOKEN: ${{ secrets.GITHUBPUSHTOKEN }}
+      - run: "./bin/build-tw-org.sh"
+        env:
+          GH_TOKEN: ${{ secrets.GITHUBPUSHTOKEN }}

package/bin/build-site.sh

@@ -5,7 +5,7 @@
 # Default to the current version number for building the plugin library
 
 if [  -z "$TW5_BUILD_VERSION" ]; then
-    TW5_BUILD_VERSION=v5.1.23
+    TW5_BUILD_VERSION=v5.2.2
 fi
 
 echo "Using TW5_BUILD_VERSION as [$TW5_BUILD_VERSION]"
@@ -107,7 +107,7 @@ node $TW5_BUILD_TIDDLYWIKI \
 # /empty.html			Empty
 # /empty.hta			For Internet Explorer
 node $TW5_BUILD_TIDDLYWIKI \
-	./editions/empty \
+	$TW5_BUILD_MAIN_EDITION \
 	--verbose \
 	--output $TW5_BUILD_OUTPUT \
 	--build empty \

package/bin/build-tw-org.sh

@@ -0,0 +1,97 @@
+#!/bin/bash
+
+# Build tiddlywiki.org assets.
+
+# Default to the version of TiddlyWiki installed in this repo
+
+if [  -z "$TWORG_BUILD_TIDDLYWIKI" ]; then
+    TWORG_BUILD_TIDDLYWIKI=./tiddlywiki.js
+fi
+
+echo "Using TWORG_BUILD_TIDDLYWIKI as [$TWORG_BUILD_TIDDLYWIKI]"
+
+# Set up the build details
+
+if [  -z "$TWORG_BUILD_DETAILS" ]; then
+    TWORG_BUILD_DETAILS="$(git symbolic-ref --short HEAD)-$(git rev-parse HEAD) from $(git remote get-url origin)"
+fi
+
+echo "Using TWORG_BUILD_DETAILS as [$TWORG_BUILD_DETAILS]"
+
+if [  -z "$TWORG_BUILD_COMMIT" ]; then
+	TWORG_BUILD_COMMIT="$(git rev-parse HEAD)"
+fi
+
+echo "Using TWORG_BUILD_COMMIT as [$TWORG_BUILD_COMMIT]"
+
+# Set up the build output directory
+
+if [  -z "$TWORG_BUILD_OUTPUT" ]; then
+    TWORG_BUILD_OUTPUT=$(mktemp -d)
+fi
+
+mkdir -p $TWORG_BUILD_OUTPUT
+
+if [  ! -d "$TWORG_BUILD_OUTPUT" ]; then
+    echo 'A valid TWORG_BUILD_OUTPUT environment variable must be set'
+    exit 1
+fi
+
+echo "Using TWORG_BUILD_OUTPUT as [$TWORG_BUILD_OUTPUT]"
+
+# Pull existing GitHub pages content
+
+git clone --depth=1 --branch=main "https://github.com/TiddlyWiki/tiddlywiki.org-gh-pages.git" $TWORG_BUILD_OUTPUT
+
+# Make the CNAME file that GitHub Pages requires
+
+echo "tiddlywiki.org" > $TWORG_BUILD_OUTPUT/CNAME
+
+# Delete any existing static content
+
+mkdir -p $TWORG_BUILD_OUTPUT/static
+rm $TWORG_BUILD_OUTPUT/static/*
+
+# Put the build details into a .tid file so that it can be included in each build (deleted at the end of this script)
+
+echo -e -n "title: $:/build\ncommit: $TWORG_BUILD_COMMIT\n\n$TWORG_BUILD_DETAILS\n" > $TWORG_BUILD_OUTPUT/build.tid
+
+######################################################
+#
+# tiddlywiki.org distribution
+#
+######################################################
+
+# /index.html			Main site
+# /favicon.ico			Favicon for main site
+# /static.html			Static rendering of default tiddlers
+# /alltiddlers.html		Static rendering of all tiddlers
+# /static/*				Static single tiddlers
+# /static/static.css	Static stylesheet
+# /static/favicon.ico	Favicon for static pages
+node $TWORG_BUILD_TIDDLYWIKI \
+	editions/tw.org \
+	--verbose \
+	--version \
+	--load $TWORG_BUILD_OUTPUT/build.tid \
+	--output $TWORG_BUILD_OUTPUT \
+	--build favicon static index \
+	|| exit 1
+
+# Delete the temporary build tiddler
+
+rm $TWORG_BUILD_OUTPUT/build.tid || exit 1
+
+# Push output back to GitHub
+
+# Exit script immediately if any command fails
+set -e
+
+pushd $TWORG_BUILD_OUTPUT
+git config --global user.email "actions@github.com"
+git config --global user.name "GitHub Actions"
+git add -A .
+git commit --message "GitHub build: $GITHUB_RUN_NUMBER of $TW5_BUILD_BRANCH ($(date +'%F %T %Z'))"
+git remote add deploy "https://$GH_TOKEN@github.com/TiddlyWiki/tiddlywiki.org-gh-pages.git" &>/dev/null
+git push deploy main &>/dev/null
+popd

package/bin/optimise-svgs.js

@@ -5,52 +5,52 @@ Optimise the SVGs in ./core/images using SVGO from https://github.com/svg/svgo
 
 Install SVGO with the following command in the root of the repo:
 
-npm install svgo
+npm install svgo@2.3.0
 */
 
 "use strict";
 
 var fs = require("fs"),
 	path = require("path"),
-	SVGO = require("svgo"),
-	svgo = new SVGO({
+	{ optimize } = require("svgo"),
+	config = {
 		plugins: [
-			{cleanupAttrs: true},
-			{removeDoctype: true},
-			{removeXMLProcInst: true},
-			{removeComments: true},
-			{removeMetadata: true},
-			{removeTitle: true},
-			{removeDesc: true},
-			{removeUselessDefs: true},
-			{removeEditorsNSData: true},
-			{removeEmptyAttrs: true},
-			{removeHiddenElems: true},
-			{removeEmptyText: true},
-			{removeEmptyContainers: true},
-			{removeViewBox: false},
-			{cleanupEnableBackground: true},
-			{convertStyleToAttrs: true},
-			{convertColors: true},
-			{convertPathData: true},
-			{convertTransform: true},
-			{removeUnknownsAndDefaults: true},
-			{removeNonInheritableGroupAttrs: true},
-			{removeUselessStrokeAndFill: true},
-			{removeUnusedNS: true},
-			{cleanupIDs: true},
-			{cleanupNumericValues: true},
-			{moveElemsAttrsToGroup: true},
-			{moveGroupAttrsToElems: true},
-			{collapseGroups: true},
-			{removeRasterImages: false},
-			{mergePaths: true},
-			{convertShapeToPath: true},
-			{sortAttrs: true},
-			{removeDimensions: false},
-			{removeAttrs: {attrs: "(stroke|fill)"}}
+			'cleanupAttrs',
+			'removeDoctype',
+			'removeXMLProcInst',
+			'removeComments',
+			'removeMetadata',
+			'removeTitle',
+			'removeDesc',
+			'removeUselessDefs',
+			'removeEditorsNSData',
+			'removeEmptyAttrs',
+			'removeHiddenElems',
+			'removeEmptyText',
+			'removeEmptyContainers',
+			// 'removeViewBox',
+			'cleanupEnableBackground',
+			'convertStyleToAttrs',
+			'convertColors',
+			'convertPathData',
+			'convertTransform',
+			'removeUnknownsAndDefaults',
+			'removeNonInheritableGroupAttrs',
+			'removeUselessStrokeAndFill',
+			'removeUnusedNS',
+			'cleanupIDs',
+			'cleanupNumericValues',
+			'moveElemsAttrsToGroup',
+			'moveGroupAttrsToElems',
+			'collapseGroups',
+			// 'removeRasterImages',
+			'mergePaths',
+			'convertShapeToPath',
+			'sortAttrs',
+			//'removeDimensions',
+			{name: 'removeAttrs', params: { attrs: '(stroke|fill)' } }
 		]
-	});
+	};
 
 var basepath = "./core/images/",
 	files = fs.readdirSync(basepath).sort();
@@ -66,12 +66,14 @@ files.forEach(function(filename) {
 			fakeSVG = body.join("\n");
 		// A hack to make the new-journal-button work
 		fakeSVG = fakeSVG.replace("<<now \"DD\">>","&lt;&lt;now &quot;DD&quot;&gt;&gt;");
-		svgo.optimize(fakeSVG, {path: filepath}).then(function(result) {
+		config.path = filepath;
+		var result = optimize(fakeSVG,config);
+		if(result) {
 			var newSVG = header.join("\n") + "\n\n" + result.data.replace("&lt;&lt;now &quot;DD&quot;&gt;&gt;","<<now \"DD\">>");
 			fs.writeFileSync(filepath,newSVG);
-		},function(err) {
+		} else {
 			console.log("Error " + err + " with " + filename)
 			process.exit();
-		});
+		};
 	}
 });