mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-12-02 14:29:55 +00:00
Code Issues Releases Wiki Activity

AWS Plugin: Add aws-encodeuricomponent filter that also encodes single quotes

Browse Source 
Because AWS S3 doesn't allow single quotes in filenames
This commit is contained in:
jeremy@jermolene.com 2020-09-23 17:32:38 +01:00
parent 843319ebb0
commit 0338f0fee2
3 changed files with 30 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
plugins/tiddlywiki/aws/docs/help.tid
View File

@ -59,7 +59,7 @@ Save raw tiddlers matching a filter to an S3 bucket.
* ''filter'': filter identifying tiddlers to render * ''filter'': filter identifying tiddlers to render
* ''region'': AWS region * ''region'': AWS region
* ''bucket'': name of the bucket to save the files * ''bucket'': name of the bucket to save the files
* ''filenamefilter'': filter for converting tiddler titles to filepaths (eg `[encodeuricomponent[]addprefix[files/]addsuffix[.html]]`) * ''filenamefilter'': filter for converting tiddler titles to filepaths (eg `[aws-encodeuricomponent[]addprefix[files/]addsuffix[.html]]`)
* ''savetypefilter'': optional; a filter that is passed the title of the tiddler being saved and should yield the MIME type for the saved file (defaults to a filter that yields the value of the ''type'' field) * ''savetypefilter'': optional; a filter that is passed the title of the tiddler being saved and should yield the MIME type for the saved file (defaults to a filter that yields the value of the ''type'' field)
! "s3-rendertiddler" subcommand ! "s3-rendertiddler" subcommand
@ -91,6 +91,6 @@ Save the results of rendering tiddlers identified by a filter to files in an S3
* ''template'': template for rendering each tiddler * ''template'': template for rendering each tiddler
* ''region'': AWS region * ''region'': AWS region
* ''bucket'': name of the bucket to save the rendered file * ''bucket'': name of the bucket to save the rendered file
* ''filenamefilter'': filter for converting tiddler titles to filepaths (eg `[encodeuricomponent[]addprefix[files/]addsuffix[.html]]`) * ''filenamefilter'': filter for converting tiddler titles to filepaths (eg `[aws-encodeuricomponent[]addprefix[files/]addsuffix[.html]]`)
* ''type'': optional render type (defaults to "text/html") * ''type'': optional render type (defaults to "text/html")
* ''savetypefilter'': optional; a filter that is passed the title of the tiddler being rendered and should yield the MIME type for the saved file (defaults to the value of the ''type'' field via `[is[tiddler]get[type]]`) * ''savetypefilter'': optional; a filter that is passed the title of the tiddler being rendered and should yield the MIME type for the saved file (defaults to the value of the ''type'' field via `[is[tiddler]get[type]]`)

1
plugins/tiddlywiki/aws/docs/readme.tid
View File

@ -4,3 +4,4 @@ This plugin provides several tools for working with Amazon Web Services:
* Templates for saving a TiddlyWiki as a single JavaScript file in a ZIP file that can be executed as an AWS Lambda function. In this form, TiddlyWiki is a self contained single file containing both code and data, just like the standalone HTML file configuration * Templates for saving a TiddlyWiki as a single JavaScript file in a ZIP file that can be executed as an AWS Lambda function. In this form, TiddlyWiki is a self contained single file containing both code and data, just like the standalone HTML file configuration
* Commands that can be used to interact with AWS services, under both the Node.js and Lambda configurations of TiddlyWiki * Commands that can be used to interact with AWS services, under both the Node.js and Lambda configurations of TiddlyWiki
* A new "aws-encodeuricomponent" filter that acts like the core "encodeuricomponent" filter except it additionally encodes the single quote character

27
plugins/tiddlywiki/aws/modules/encodings.js Normal file
View File

@ -0,0 +1,27 @@
/*\
title: $:/plugins/tiddlywiki/aws/encodings.js
type: application/javascript
module-type: filteroperator
Filter operator for applying encodeuricomponent() to each item, with the addition of converting single quotes to %27, as required by AWS
\*/
(function(){
/*jslint node: true, browser: true */
/*global $tw: false */
"use strict";
/*
Export our filter functions
*/
exports["aws-encodeuricomponent"] = function(source,operator,options) {
var results = [];
source(function(tiddler,title) {
results.push(encodeURIComponent(title).replace(/'/g,"%27"));
});
return results;
};
})();