iss1757 - Change current filters to transforms

Author: EJMFarrow

corsscripts/ascii/markdownitrules.js

@@ -1,20 +1,20 @@
 // Markdown-it plugin — bundled into stackascii.bundle.js via stackascii.src.js.
-// Edit filter behaviour in filters/*.js, then run: npm run build:bundle
+// Edit transform behaviour in markdownittransforms/*.js, then run: npm run build:bundle
 
-import boldfilter from './filters/020_boldfilter.js';
-import latexwrap from './filters/010_latexwrap.js';
+import boldfilter from './markdownittransforms/020_boldfilter.js';
+import latexwrap from './markdownittransforms/010_latexwrap.js';
 
-// Registry maps the string names used in options.filters to the actual functions.
-// Add new filters here after creating their file in filters/.
-const filterRegistry = {
+// Registry maps the string names used in options.transforms to the actual functions.
+// Add new transforms here after creating their file in markdownittransforms/.
+const transformRegistry = {
     boldfilter,
     latexwrap,
 };
 
 export default function markdownitrules(mdit, options) {
     "use strict";
     options = options || {};
-    const filters = (options.filters || '')
+    const transforms = (options.transforms || '')
         .split(',')
         .map(s => s.trim())
         .filter(Boolean);
@@ -39,7 +39,7 @@ export default function markdownitrules(mdit, options) {
 
     mdit.renderer.rules.asciimath_block = function(tokens, idx) {
         const code = tokens[idx].content;
-        const rendered = applyFilters(code, true);
+        const rendered = applyTransforms(code, true);
         if (collector) {
             collector.blocks.push({ type: 'asciimath_block', raw: code, rendered });
         }
@@ -58,7 +58,7 @@ export default function markdownitrules(mdit, options) {
 
     mdit.renderer.rules.math_block = function(tokens, idx) {
         const code = tokens[idx].content;
-        const rendered = applyFilters(code, false);
+        const rendered = applyTransforms(code, false);
         if (collector) {
             collector.blocks.push({ type: 'math_block', raw: code, rendered });
         }
@@ -69,16 +69,16 @@ export default function markdownitrules(mdit, options) {
         return code.split(/\r?\n/).map(line => line.trim()).filter(line => line !== '');
     }
 
-    function applyFilters(code, isASCIIMaths) {
+    function applyTransforms(code, isASCIIMaths) {
         let lines = splitBlock(code);
         if (isASCIIMaths) {
             lines = lines.map(line => window.AMparseMath(line, true));
         }
-        for (const filter of filters) {
-            if (!filterRegistry[filter]) {
-                throw new Error(`markdownitrules: unknown filter "${filter}"`);
+        for (const transform of transforms) {
+            if (!transformRegistry[transform]) {
+                throw new Error(`markdownitrules: unknown transform "${transform}"`);
             }
-            lines = filterRegistry[filter](lines);
+            lines = transformRegistry[transform](lines);
         }
         return lines.join('\n') + '\n';
     }

…rsscripts/ascii/filters/010_latexwrap.js …ii/markdownittransforms/010_latexwrap.jscorsscripts/ascii/filters/010_latexwrap.js renamed to corsscripts/ascii/markdownittransforms/010_latexwrap.js corsscripts/ascii/filters/010_latexwrap.js renamed to corsscripts/ascii/markdownittransforms/010_latexwrap.js

@@ -22,11 +22,11 @@ import regexall from './extractors/regexall.js';
 
 const extractorlib = { finalfunction, lastexpr, lastblock, regexmatch, regexall };
 
-export default function init(inputIds, filters, operations) {
+export default function init(inputIds, transforms, operations) {
     const markdownContainerId = inputIds[0];
     // inputIds[1..N] correspond to each parsed answer entry in order.
     const extractors = operations.filter(operator => operator.operation === 'extractor');
-    const inputFilters = filters ? filters : 'latexwrap,boldfilter';
+    const inputTransforms = transforms ? transforms : 'latexwrap,boldfilter';
 
     const blockCollector = { blocks: [] };
 
@@ -35,7 +35,7 @@ export default function init(inputIds, filters, operations) {
         .use(markdownitSub)
         .use(mdItPluginTex.tex, { render: (content) => content, delimiters: 'brackets' })
         .use(asciimathBlock)
-        .use(markdownitrules, { filters: inputFilters, collector: blockCollector });
+        .use(markdownitrules, { transforms: inputTransforms, collector: blockCollector });
 
     function convertMarkdown(markdown) {
         const html = previewMarkdownConverter.render(markdown);

…sscripts/ascii/filters/020_boldfilter.js …i/markdownittransforms/020_boldfilter.jscorsscripts/ascii/filters/020_boldfilter.js renamed to corsscripts/ascii/markdownittransforms/020_boldfilter.js corsscripts/ascii/filters/020_boldfilter.js renamed to corsscripts/ascii/markdownittransforms/020_boldfilter.js

@@ -10,7 +10,7 @@
 <p>Work line by line below, justifying your answer fully.  Your last line should be your answer \(f(x)=...\).</p>
 
 <p>[[input:ans1]] [[validation:ans1]]</p>
-[[ascii input="ans1" filters="latexwrap"]]
+[[ascii input="ans1" transforms="latexwrap"]]
 [[extractor targetinput="ans2" type="finalfunction"/]]
 [[/ascii]]
 <p>[[hint title="Input help"]][[commonstring key="free_text_fact"/]][[/hint]]</p>

…rsscripts/ascii/filters/findtextindex.js …ii/markdownittransforms/findtextindex.jscorsscripts/ascii/filters/findtextindex.js renamed to corsscripts/ascii/markdownittransforms/findtextindex.js corsscripts/ascii/filters/findtextindex.js renamed to corsscripts/ascii/markdownittransforms/findtextindex.js

@@ -42,7 +42,7 @@ public function compile($format, $options): ?MP_Node {
         // Define iframe params.
         $xpars = [];
         $inputs = [];
-        $xpars['filters'] = '';
+        $xpars['transforms'] = '';
 
         foreach ($this->params as $key => $value) {
             if ($key === 'input') {
@@ -115,7 +115,7 @@ public function compile($format, $options): ?MP_Node {
             return 'stack_js.request_access_to_input("' . $item . '"' . $extra . ')';
         }, $inputs, array_keys($inputs)));
         $linkcode = 'Promise.all([' . $answercalls . '])';
-        $linkcode .= ".then((inputIds) => {init(inputIds,'" . $xpars['filters'] . "'," . json_encode($operations) . ");});";
+        $linkcode .= ".then((inputIds) => {init(inputIds,'" . $xpars['transforms'] . "'," . json_encode($operations) . ");});";
 
         $r->items[] = new MP_String($linkcode);
         $r->items[] = new MP_String("\n</script>");
@@ -235,13 +235,13 @@ public function validate(
                 $key !== 'aspect-ratio' &&
                 $key !== 'input' &&
                 $key !== 'hidden' &&
-                $key !== 'filters'
+                $key !== 'transforms'
             ) {
                 $err[] = stack_string('stackBlock_ascii_unknown_param', $key);
                 $valid    = false;
                 if ($valids === null) {
                     $valids = [
-                        'width', 'height', 'aspect-ratio', 'input', 'hidden', 'filters'
+                        'width', 'height', 'aspect-ratio', 'input', 'hidden', 'transforms'
                     ];
                     $err[] = stack_string('stackBlock_ascii_param', [
                         'param' => implode(', ', $valids),