wikity 1.3.1 → 1.3.2

package/dist/cli.js

@@ -31,7 +31,7 @@ else if (arg(1).includes('c')) {
     const configArgs = args.slice(2);
     const argsList = configArgs.join(' ');
     // retrieve item from arguments list
-    const getArgContent = (arg) => arg.test(argsList) && configArgs.filter((_, i) => arg.test(configArgs[i - 1])).join(' ') || '';
+    const getArgContent = (arg) => arg.test(argsList) && configArgs.filter((_, i) => arg.test(configArgs[i - 1])).join(' ') || undefined;
     // Fetch user-supplied arguments
     const folder = arg(2) || '.';
     const outputFolder = getArgContent(/^-+o/);

package/dist/compile.js

@@ -4,37 +4,45 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.compile = exports.eleventyCompile = void 0;
-const fs = require('fs');
-const glob = require('glob');
-const dedent = require('dedent');
-const formatter = require('html-formatter');
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const glob_1 = __importDefault(require("glob"));
+const dedent_1 = __importDefault(require("dedent"));
+const formatter = require('html-formatter'); // does not have type package
 const parse_1 = require("./parse");
-const common_1 = require("./common");
 const wiki_css_1 = __importDefault(require("./wiki.css"));
-const r = String.raw;
 function eleventyCompile(dir = '.', config = {}) {
     compile(dir, { eleventy: true, ...config });
 }
 exports.eleventyCompile = eleventyCompile;
 function compile(dir = '.', config = {}) {
+    var _a, _b, _c;
+    // set defaults
+    (_a = config.templatesFolder) !== null && _a !== void 0 ? _a : (config.templatesFolder = 'templates');
+    (_b = config.imagesFolder) !== null && _b !== void 0 ? _b : (config.imagesFolder = 'images');
+    (_c = config.outputFolder) !== null && _c !== void 0 ? _c : (config.outputFolder = 'wikity-out');
+    // directory variables (absolute paths)
+    const baseDir = path_1.default.resolve(dir);
+    const templatesFolder = path_1.default.join(baseDir, config.templatesFolder);
+    const imagesFolder = path_1.default.join(baseDir, config.imagesFolder);
+    const outputFolder = path_1.default.join(baseDir, config.outputFolder);
+    const outputImagesFolder = path_1.default.join(baseDir, config.outputFolder, config.imagesFolder);
+    const newConfig = { ...config, templatesFolder, imagesFolder, outputFolder };
     let stylesCreated = false;
     // Write wikitext files
-    const files = glob.sync(dir + "/**/*.wiki", {});
+    const files = glob_1.default.sync(dir + "/**/*.wiki", {});
     files.forEach((file) => {
         var _a;
-        const fileData = fs.readFileSync(file, { encoding: 'utf8' });
-        const { data: parsedContent, metadata } = (0, parse_1.parse)(fileData, config);
+        const fileData = fs_1.default.readFileSync(file, { encoding: 'utf8' });
+        const { data: parsedContent, metadata } = (0, parse_1.parse)(fileData, newConfig);
         let outText = parsedContent;
-        const templatesFolder = config.templatesFolder || 'templates';
-        const imagesFolder = config.imagesFolder || 'images';
-        const outputFolder = config.outputFolder || 'wikity-out';
-        const [, folder, filename] = file.match((0, common_1.RegExpBuilder)(r `^(.+?[\/\\]) ((?:(?:${templatesFolder}|${imagesFolder})[\/\\])?[^\/\\]+)$`, '')) || [];
-        const outFolder = dir + '/' + outputFolder + '/';
+        const filename = file.replace(dir, '').replace(/^[\/\\]/, '');
         const outFilename = filename.replace(/ /g, '_').replace('.wiki', '.html');
-        const urlPath = outFilename.replace(/(?<=^|\/)\w/g, m => m.toUpperCase());
+        const outFilePath = path_1.default.join(outputFolder, outFilename);
+        const urlPath = outFilename.replace(/(?<=^|\/)\w/g, m => m.toUpperCase()); // capitalise first letters
         const displayTitle = metadata.displayTitle || urlPath.replace('.html', '');
         // Eleventy configuration
-        const frontMatter = config.eleventy ? dedent `
+        const frontMatter = config.eleventy ? (0, dedent_1.default) `
                 ---
                 permalink: /wiki/${urlPath}
                 ---
@@ -49,7 +57,7 @@ function compile(dir = '.', config = {}) {
                 const lvl = +(((_a = match.match(/\d/g)) === null || _a === void 0 ? void 0 : _a[0]) || -1);
                 toc += `${`<ol>`.repeat(lvl - 1)} <li> <a href="#${encodeURI(text.replace(/ /g, '_'))}">${text}</a> </li> ${`</ol>`.repeat(lvl - 1)}`;
             });
-            const tocElem = dedent `
+            const tocElem = (0, dedent_1.default) `
                 <div id="toc">
                     <span id="toc-heading">
                         <strong>Contents</strong>
@@ -70,14 +78,15 @@ function compile(dir = '.', config = {}) {
         // Create plaintext of HTML for use as description/metadata property.
         const plaintextData = parsedContent.replace(/<.+?>/gs, ' ');
         // Create HTML
-        const html = dedent `
+        const folderUpCount = file.split(/[\/\\]/).length - dir.split(/[\/\\]/).length; // number of folders to go up by to get to root
+        const html = (0, dedent_1.default) `
             <html>
                 <head>
                     <meta charset="utf-8">
                     <meta name="viewport" content="initial-scale=1.0, width=device-width">
                     <meta name="description" content="${plaintextData.substring(0, 256)}...">
                     <title>${displayTitle}</title>
-                    <link id="default-styles" rel="stylesheet" href="/wiki.css">
+                    <link id="default-styles" rel="stylesheet" href="${'../'.repeat(folderUpCount)}./wiki.css">
                 </head>
                 <body>
                     <header>
@@ -94,25 +103,21 @@ function compile(dir = '.', config = {}) {
             </html>
         `;
         // Write to file
-        for (const path of ['', templatesFolder, imagesFolder]) {
-            if (!fs.existsSync(outFolder + path)) {
-                fs.mkdirSync(outFolder + path);
-            }
+        if (!fs_1.default.existsSync(path_1.default.dirname(outFilePath))) {
+            fs_1.default.mkdirSync(path_1.default.dirname(outFilePath));
         }
-        ;
         const renderedHtml = formatter.render(html).replace(/(<\/\w+>)(\S)/g, '$1 $2');
-        fs.writeFileSync(outFolder + outFilename, frontMatter + '\n' + renderedHtml, 'utf8');
+        fs_1.default.writeFileSync(outFilePath, frontMatter + '\n' + renderedHtml, 'utf8');
         // Move images
-        glob(imagesFolder + '/*', {}, (err, files) => {
+        (0, glob_1.default)(imagesFolder + '/*', {}, (err, files) => {
             if (err) {
                 console.warn(err);
             }
-            const outImagesFolder = outFolder + imagesFolder + '/';
-            if (!fs.existsSync(outImagesFolder)) {
-                fs.mkdirSync(outImagesFolder);
+            if (!fs_1.default.existsSync(outputImagesFolder)) {
+                fs_1.default.mkdirSync(outputImagesFolder);
             }
             for (const file of files) {
-                fs.copyFileSync(file, outImagesFolder + file.split(/[/\\]/).pop());
+                fs_1.default.copyFileSync(file, path_1.default.join(outputImagesFolder, path_1.default.basename(file)));
             }
             ;
         });
@@ -126,13 +131,14 @@ function compile(dir = '.', config = {}) {
             if (config.customStyles) {
                 styles += config.customStyles;
             }
-            const cssOutput = dedent `
+            const cssOutput = config.eleventy ? (0, dedent_1.default) `
                 ---
                 permalink: /wiki.css
                 ---
                 ${styles}
-            `;
-            fs.writeFileSync(outFolder + 'wiki.css.njk', cssOutput);
+            ` : styles;
+            const cssOutFilename = config.eleventy ? 'wiki.css.njk' : 'wiki.css';
+            fs_1.default.writeFileSync(path_1.default.join(outputFolder, cssOutFilename), cssOutput);
         }
     });
 }

package/dist/parse.js

@@ -1,21 +1,30 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parse = exports.rawParse = void 0;
-const fs = require('fs');
-const htmlEscape = require('escape-html');
-const dateFormat = require('dateformat');
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const escape_html_1 = __importDefault(require("escape-html"));
+const dateformat_1 = __importDefault(require("dateformat"));
 const common_1 = require("./common");
 const r = String.raw;
 const MAX_RECURSION = 20;
-const MAX_ARG_COUNT = 10;
 const arg = r `\s*([^|}]+?)\s*`;
+function fullyEscape(text) {
+    return (0, escape_html_1.default)(text)
+        .replace(/{/g, '{'); // avoid keeping plain {{}} which is parsed as a template call
+}
 function rawParse(data, config = {}) {
     return parse(data, config).data;
 }
 exports.rawParse = rawParse;
 function parse(data, config = {}) {
-    const templatesFolder = config.templatesFolder || 'templates';
-    const imagesFolder = config.imagesFolder || 'images';
+    var _a, _b, _c;
+    const templatesFolder = (_a = config.templatesFolder) !== null && _a !== void 0 ? _a : 'templates';
+    const imagesFolder = (_b = config.imagesFolder) !== null && _b !== void 0 ? _b : 'images';
+    const outputFolder = (_c = config.outputFolder) !== null && _c !== void 0 ? _c : 'wikity-out';
     const vars = {};
     const metadata = {};
     const nowikis = [];
@@ -24,7 +33,6 @@ function parse(data, config = {}) {
     let rawExtLinkCount = 0;
     let refCount = 0;
     let outText = data;
-    let stylesCreated = false;
     for (let l = 0, last = ''; l < MAX_RECURSION; l++) {
         if (last === outText)
             break;
@@ -93,20 +101,21 @@ function parse(data, config = {}) {
                         const errMsg = `Wikity does not use Wikipedia's #time function syntax. Use repetition-based formatting (e.g. yyyy-mm-dd) instead.`;
                         console.warn(`<Wikity> [WARN] ${errMsg}`);
                     }
-                    return dateFormat(args[1] ? new Date(args[1]) : new Date(), args[0]);
+                    return (0, dateformat_1.default)(args[1] ? new Date(args[1]) : new Date(), args[0]);
             }
         })
             // Templates: {{template}}
             .replace((0, common_1.RegExpBuilder)(r `(?<!{) {{ \s* ([^#{}|]+?) (\|[^{}]+)? }} (?!})`), (_, title, params = '') => {
-            const page = templatesFolder + '/' + title.trim().replace(/ /g, '_');
+            const page = path_1.default.join(templatesFolder, title.trim().replace(/ /g, '_'));
             let content = '';
             // Try retrieve template content
             try {
-                content = fs.readFileSync('./' + page + '.wiki', { encoding: 'utf8' });
+                content = fs_1.default.readFileSync(page + '.wiki', { encoding: 'utf8' });
             }
             catch {
                 // Return redlink if template doesn't exist
-                return `<a class="internal-link redlink" title="${title}" href="${page}">${title}</a>`;
+                const relPage = path_1.default.basename(templatesFolder) + '/' + path_1.default.relative(templatesFolder, page);
+                return `<a class="internal-link redlink" title="${title}" href="${relPage}">${title}</a>`;
             }
             // Remove non-template sections
             content = content
@@ -133,7 +142,7 @@ function parse(data, config = {}) {
             .replace((0, common_1.RegExpBuilder)(r `\[\[ (?:File|Image): (.+?) (\|.+?)? \]\]`), (_, file, params = '') => {
             if (/{{/.test(params))
                 return _;
-            const path = imagesFolder + '/' + file.trim().replace(/ /g, '_');
+            const path = path_1.default.join(imagesFolder, file.trim().replace(/ /g, '_'));
             let caption = '';
             let imageData = {};
             let imageArgs = params.split('|').map((arg) => arg.replace(/"/g, '&quot;'));
@@ -197,7 +206,7 @@ function parse(data, config = {}) {
                         "
                     >
                         <img
-                            src="${path}"
+                            src="${path_1.default.basename(imagesFolder)}/${path_1.default.relative(imagesFolder, path)}"
                             alt="${imageData.alt || file}"
                             width="${imageData.width || 300}"
                             height="${imageData.height || 300}"
@@ -235,7 +244,8 @@ function parse(data, config = {}) {
             .replace((0, common_1.RegExpBuilder)(r `^ \{\| (.*?) $`), (_, attrs) => `<table ${attrs}><tr>`)
             .replace((0, common_1.RegExpBuilder)(r `^ ! ([^]+?) (?= \n^[!|] )`), (_, content) => `<th>${content}</th>`)
             .replace((0, common_1.RegExpBuilder)(r `^ \|\+ (.*?) $`), (_, content) => `<caption>${content}</caption>`)
-            .replace((0, common_1.RegExpBuilder)(r `^ \|[^-+}] ([^]*?) (?= \n^[!|] )`), (_, content) => `<td>${content}</td>`)
+            .replace((0, common_1.RegExpBuilder)(r `^ \|[^-+}] ([^]*?) (?= \n | \|\| )`), (_, content) => `<td>${content}</td>`)
+            .replace((0, common_1.RegExpBuilder)(r `\|\|[^-+}] ([^]*?) (?= \n | \|\| )`), (_, content) => `<td>${content}</td>`)
             .replace((0, common_1.RegExpBuilder)(r `^ \|- (.*?) $`), (_, attrs) => `</tr><tr ${attrs}>`)
             .replace((0, common_1.RegExpBuilder)(r `^ \|\}`), `</tr></table>`)
             // References: <ref></ref>, <references/>
@@ -249,10 +259,12 @@ function parse(data, config = {}) {
             .replace((0, common_1.RegExpBuilder)(r ` \`\`\` ([^\`]+?) \`\`\` `), '<pre>$1</pre>')
             .replace((0, common_1.RegExpBuilder)(r ` \`\` ([^\`]+?) \`\` `), '<code>$1</code>')
             // Spacing
-            .replace(/(\r?\n){2}/g, '\n</p><p>\n')
-            // Restore nowiki contents
-            .replace(/%NOWIKI#(\d+)%/g, (_, n) => htmlEscape(nowikis[n]));
+            .replace(/(\r?\n){2}/g, '\n</p><p>\n');
     }
+    // Final changes (run only once)
+    outText = outText
+        // Restore nowiki contents
+        .replace(/%NOWIKI#(\d+)%/g, (_, n) => fullyEscape(nowikis[n]));
     const result = { data: outText, metadata: metadata };
     return result;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wikity",
-  "version": "1.3.1",
+  "version": "1.3.2",
   "description": "Compile wikitext to HTML: wikitext as a templating language.",
   "main": "dist/index.js",
   "scripts": {
@@ -39,20 +39,16 @@
   "license": "ISC",
   "dependencies": {
     "dateformat": "^4.6.3",
-    "dedent": "^0.7.0",
+    "dedent": "^1.5.3",
     "escape-html": "^1.0.3",
-    "glob": "^7.2.3",
+    "glob": "^8.1.0",
     "html-formatter": "^0.1.9"
   },
-  "peerDependencies": {
-    "@11ty/eleventy": ">=0.10.0"
-  },
-  "peerDependenciesMeta": {
-    "@11ty/eleventy": {
-      "optional": true
-    }
-  },
   "devDependencies": {
+    "@types/dateformat": "^3.0.1",
+    "@types/dedent": "^0.7.2",
+    "@types/escape-html": "^1.0.4",
+    "@types/glob": "^8.1.0",
     "@types/node": "ts5.0",
     "typescript": "~5.0.4 <5.1"
   }

package/readme.md

@@ -69,12 +69,13 @@ Use Wikity along with Eleventy to have all your wiki files compiled during the b
 // .eleventy.js (eleventy's configuration file)
 const wikity = require('wikity');
 module.exports = function (eleventyConfig) {
-    const wikiFolder = 'src';
-    const templatesFolder = 'templates', imagesFolder = 'images', outputFolder = 'wikity-out'; // defaults
-    const wikityOptions = { templatesFolder, imagesFolder, outputFolder };
-    const wikityPlugin = () => wikity.compile(wikiFolder, { eleventy: true, ...wikityOptions });
+    const rootFolder = 'src';
+    const templatesFolder = 'templates', imagesFolder = 'images'; // defaults; relative to root folder
+    const outputFolder = 'wikity-out'; // default
+    const wikityOptions = { eleventy: true, templatesFolder, imagesFolder, outputFolder };
+    const wikityPlugin = () => wikity.compile(rootFolder, wikityOptions);
     eleventyConfig.addPlugin(wikityPlugin);
-    eleventyConfig.addPassthroughCopy({[imagesFolder]: 'wiki/' + imagesFolder}); // Eleventy does not pass through images by default
+    eleventyConfig.addPassthroughCopy({ 'src/images': 'wiki/' + imagesFolder }); // Eleventy does not pass through images by default
 }
 ```
 
@@ -83,10 +84,10 @@ The above will use the following file structure (with some example wiki files gi
 - `src/`
   - `templates/`: Directory for wiki templates (called like `{{this}}`)
   - `images/`: Directory to place images (called like `[[File:this]]`)
-  - `wikity-out/`: File templates compiled from the `.wiki` files (add this to `.gitignore`)
   - `Index.wiki`: Example file
   - `Other_Page.wiki`: Example other file
-- `wiki/`: Output HTML files compiled from wikity-out (add this to `.gitignore`)
+- `wikity-out/`: File templates compiled from the `.wiki` files (add this to `.gitignore`)
+- `wiki/`: Output HTML files compiled from `wikity-out/` (add this to `.gitignore`)
 
 (View the above starting at the URL path `/wiki/` when ran in an HTTP server.)