wikity 1.3.0 → 1.3.1

package/package.json

@@ -1,54 +1,59 @@
-{
-  "name": "wikity",
-  "version": "1.3.0",
-  "description": "Compile wikitext to HTML: wikitext as a templating language.",
-  "main": "src/index.js",
-  "scripts": {
-    "test": "tsc && cd test && eleventy"
-  },
-  "bin": {
-    "wikity": "src/cli.js"
-  },
-  "files": [
-    "src/*.js",
-    "src/*.d.ts"
-  ],
-  "keywords": [
-    "eleventy",
-    "eleventy-plugin",
-    "wikitext",
-    "mediawiki",
-    "html",
-    "template-language",
-    "templating-language"
-  ],
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/Nixinova/Wikity.git"
-  },
-  "author": "Nixinova (https://nixinova.com)",
-  "bugs": {
-    "url": "https://github.com/Nixinova/Wikity/issues"
-  },
-  "homepage": "https://github.com/Nixinova/Wikity#readme",
-  "license": "ISC",
-  "dependencies": {
-    "dateformat": "^4.5.1",
-    "dedent": "^0.7.0",
-    "escape-html": "^1.0.3",
-    "glob": "^7.1.7",
-    "html-formatter": "^0.1.9"
-  },
-  "peerDependencies": {
-    "@11ty/eleventy": ">=0.10.0 <1"
-  },
-  "peerDependenciesMeta": {
-    "@11ty/eleventy": {
-      "optional": true
-    }
-  },
-  "devDependencies": {
-    "@types/node": "ts4.2",
-    "typescript": "~4.2.4"
-  }
-}
+{
+  "name": "wikity",
+  "version": "1.3.1",
+  "description": "Compile wikitext to HTML: wikitext as a templating language.",
+  "main": "dist/index.js",
+  "scripts": {
+    "test": "tsc && cd test && eleventy"
+  },
+  "bin": {
+    "wikity": "bin/index.js"
+  },
+  "engines": {
+    "node": ">=12"
+  },
+  "files": [
+    "bin/",
+    "dist/"
+  ],
+  "keywords": [
+    "compiler",
+    "compilation",
+    "wikitext",
+    "mediawiki",
+    "html",
+    "template-language",
+    "templating-language",
+    "eleventy",
+    "eleventy-plugin"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Nixinova/Wikity.git"
+  },
+  "author": "Nixinova (https://nixinova.com)",
+  "bugs": {
+    "url": "https://github.com/Nixinova/Wikity/issues"
+  },
+  "homepage": "https://github.com/Nixinova/Wikity#readme",
+  "license": "ISC",
+  "dependencies": {
+    "dateformat": "^4.6.3",
+    "dedent": "^0.7.0",
+    "escape-html": "^1.0.3",
+    "glob": "^7.2.3",
+    "html-formatter": "^0.1.9"
+  },
+  "peerDependencies": {
+    "@11ty/eleventy": ">=0.10.0"
+  },
+  "peerDependenciesMeta": {
+    "@11ty/eleventy": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@types/node": "ts5.0",
+    "typescript": "~5.0.4 <5.1"
+  }
+}

package/readme.md

@@ -4,11 +4,14 @@
 
 # Wikity
 
-**Wikity** is a tool that allows you to use Wikitext (used by Wikipedia, Fandom, etc) as a templating language to create HTML pages, useful in build tools such as [Eleventy](https://11ty.dev).
+**Wikity** is a tool that allows you to use Wikitext (used by Wikipedia, Fandom, etc) as a templating language to create HTML pages.
+
+This package comes with built-in support for compilation using [Eleventy](https://11ty.dev).
 
 ## Install
 
 Wikity is available [on npm](https://www.npmjs.com/package/wikity).
+Install locally to use in a Node package or install globally for use from the command-line.
 
 | Local install        | Global install          |
 | -------------------- | ----------------------- |
@@ -20,24 +23,33 @@ Wikity is available [on npm](https://www.npmjs.com/package/wikity).
 
 - `wikity.compile(folder?: string, options?: object): void`
   - Compile all Wikitext (`.wiki`) files from an input folder (defaults to the current directory, `.`) into HTML.
-- `wikity.eleventyPlugin(folder?: string, options?: object): void`
-  - An implementation of `compile()` for use with Eleventy's `addPlugin` API. Identical to `compile()` except that option `eleventy` is `true` by default.
 - `wikity.parse(input: string, options?: object): string`
-  - Parse raw wikitext input into HTML. Only option available is `templatesFolder`.
+  - Parse raw wikitext input into HTML.
 
 - **Options**:
-  - `outputFolder?: string`
-    - Where outputted HTML files shall be placed (default: `wikity-out`).
-  - `templatesFolder?: string`
-    - What folder to place templates in (default: `'templates'`).
-  - `imagesFolder?: string`
-    - What folder to place images in (default: `'images'`). Make sure to pass through this folder to your build output if applicable.
-- `eleventy?: boolean`
+  - `eleventy: boolean = false`
     - Whether [front matter](https://www.11ty.dev/docs/data-frontmatter/) will be added to the outputted HTML for Eleventy to read (default: `false`).
-  - `defaultStyles?: boolean`
-    - Whether to use default wiki styling (default: `true`).
-  - `customStyles?: string`
-    - Custom CSS to style the wiki pages (default: `''`).
+      (**This parameter *must* be set to `true` if you want to use this with Eleventy.**)
+  - `outputFolder: string`
+    - *Used only with `compile()`.*
+    - Where outputted HTML files shall be placed.
+    - Default: `'wikity-out'`.
+  - `templatesFolder: string`
+    - What folder to place templates in.
+    - Default: `'templates'`.
+  - `imagesFolder: string`
+    - What folder to place images in.
+    - Default: `'images'`.
+  - `defaultStyles: boolean`
+    - *Used only with `compile()`.*
+    - Whether to use default wiki styling.
+    - Default: to `true` when called from `compile()` and `false` when called from `parse()`.
+  - `customStyles: string`
+    - *Used only with `compile()`.*
+    - Custom CSS styles to add to the wiki pages.
+    - Default: empty (`''`).
+
+#### Example
 
 ```js
 const wikity = require('wikity');
@@ -49,20 +61,35 @@ wikity.compile();
 let html = wikity.parse(`'''bold''' [[link|text]]`); // <b>bold</b> <a href="link"...>text</a>
 ```
 
-Use Wikity along with Eleventy to compile your wiki files during the build process:
+#### As an Eleventy plugin
+
+Use Wikity along with Eleventy to have all your wiki files compiled during the build process:
 
 ```js
 // .eleventy.js (eleventy's configuration file)
 const wikity = require('wikity');
 module.exports = function (eleventyConfig) {
-    const wikiFolder = '.'; // current directory
-    const wikityOptions = {templatesFolder: 'templates', imagesFolder: 'images'}; // set as needed
-    const wikityPlugin = () => wikity.eleventyPlugin(wikiFolder, wikityOptions);
+    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 });
     eleventyConfig.addPlugin(wikityPlugin);
     eleventyConfig.addPassthroughCopy({[imagesFolder]: 'wiki/' + imagesFolder}); // Eleventy does not pass through images by default
 }
 ```
 
+The above will use the following file structure (with some example wiki files given):
+
+- `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`)
+
+(View the above starting at the URL path `/wiki/` when ran in an HTTP server.)
+
 ### Command-line
 ```cmd
 $ wikity help
@@ -81,6 +108,7 @@ Use [Wikitext](https://en.wikipedia.org/wiki/Help:Wikitext) (file extension `.wi
 
 Any wiki templates (called using `{{template name}}`) must be inside the `templates/` folder by default.
 Any files must be inside the `images/` folder by default.
+Your wikitext (`*.wiki`) files go in the root directory by default.
 
 ### Wiki markup
 

package/src/cli.d.ts

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-export {};

package/src/common.d.ts

@@ -1,15 +0,0 @@
-export declare type Metadata = Record<string, any>;
-export declare type Config = {
-    outputFolder?: string;
-    eleventy?: boolean;
-    defaultStyles?: boolean;
-    customStyles?: string;
-    templatesFolder?: string;
-    imagesFolder?: string;
-};
-export declare class Result extends String {
-    metadata: Metadata;
-    constructor(str: string);
-}
-export declare function RegExpBuilder(regex: string, flag?: string): RegExp;
-export declare const VERSION = "1.3.0";

package/src/common.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.VERSION = exports.RegExpBuilder = exports.Result = void 0;
-class Result extends String {
-    constructor(str) {
-        super(str);
-        this.metadata = {};
-    }
-}
-exports.Result = Result;
-function RegExpBuilder(regex, flag = 'mgi') {
-    return RegExp(regex.replace(/ /g, '').replace(/\|\|.+?\|\|/g, ''), flag);
-}
-exports.RegExpBuilder = RegExpBuilder;
-exports.VERSION = '1.3.0';

package/src/compile.js

@@ -1,153 +0,0 @@
-"use strict";
-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 parse_1 = require("./parse");
-const common_1 = require("./common");
-const r = String.raw;
-function eleventyCompile(dir = '.', config = {}) {
-    compile(dir, { eleventy: true, ...config });
-}
-exports.eleventyCompile = eleventyCompile;
-function compile(dir = '.', config = {}) {
-    let stylesCreated = false;
-    // Write wikitext files
-    const files = glob.sync((dir || '.') + "/**/*.wiki", {});
-    files.forEach((file) => {
-        var _a;
-        let data = fs.readFileSync(file, { encoding: 'utf8' });
-        let content = parse_1.parse(data, config);
-        let outText = content.toString();
-        const templatesFolder = config.templatesFolder || 'templates';
-        const imagesFolder = config.imagesFolder || 'images';
-        let [, folder, filename] = file.match(common_1.RegExpBuilder(r `^(.+?[\/\\]) ((?:(?:${templatesFolder}|${imagesFolder})[\/\\])?[^\/\\]+)$`, '')) || [];
-        let outFolder = (dir || folder || '.') + '/' + (config.outputFolder || 'wikity-out') + '/';
-        let outFilename = filename.replace(/ /g, '_').replace('.wiki', '.html');
-        let url = outFilename.replace(/(?<=^|\/)\w/g, m => m.toUpperCase());
-        let displayTitle = content.metadata.displayTitle || url.replace('.html', '');
-        // Eleventy configuration
-        let frontMatter = '';
-        if (config.eleventy) {
-            frontMatter = dedent `
-                ---
-                permalink: /wiki/${url}
-                ---
-            `;
-        }
-        // Create HTML
-        let toc = '';
-        if (!content.metadata.notoc && (content.metadata.toc || (((_a = outText.match(/<h\d[^>]*>/g)) === null || _a === void 0 ? void 0 : _a.length) || 0) > 3)) {
-            let headings = Array.from(content.match(/<h\d[^>]*>.+?<\/h\d>/gs) || []);
-            headings.forEach(match => {
-                var _a;
-                const text = match.replace(/\s*<\/?h\d[^>]*>\s*/g, '');
-                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)}`;
-            });
-            toc = dedent `
-                <div id="toc">
-                    <span id="toc-heading">
-                        <strong>Contents</strong>
-                        [<a href="javascript:void(0)" onclick="
-                            document.querySelector('#toc ol').setAttribute('style', this.innerText === 'hide' ? 'display: none;' : '');
-                            this.innerText = this.innerText === 'hide' ? 'show' : 'hide';
-                        ">hide</a>]
-                    </span>
-                    <ol>${toc}</ol>
-                </div>
-            `;
-            if (outText.includes('<toc></toc>'))
-                outText = outText.replace('<toc></toc>', toc);
-            else
-                outText = outText.replace(/<h\d[^>]*>/, toc + '$&');
-        }
-        let html = dedent `
-            <html>
-                <head>
-                    <meta charset="utf-8">
-                    <meta name="viewport" content="initial-scale=1.0, width=device-width">
-                    <meta name="description" content="${data.substr(0, 256)}">
-                    <title>${displayTitle}</title>
-                    <link id="default-styles" rel="stylesheet" href="/wiki.css">
-                </head>
-                <body>
-                    <header>
-                        <h1 id="page-title">${displayTitle}</h1>
-                    </header>
-                    <main>
-                        <p>\n${outText}
-                        </p>
-                    </main>
-                    <footer>
-                        <p id="credit_wikity">Created using <a href="https://github.com/Nixinova/Wikity">Wikity</a></p>
-                    </footer>
-                </body>
-            </html>
-        `;
-        // Write to file
-        ['', templatesFolder, imagesFolder].forEach((path) => {
-            if (!fs.existsSync(outFolder + path))
-                fs.mkdirSync(outFolder + path);
-        });
-        let renderedHtml = formatter.render(html).replace(/(<\/\w+>)(\S)/g, '$1 $2');
-        fs.writeFileSync(outFolder + outFilename, frontMatter + '\n' + renderedHtml, 'utf8');
-        // Move images
-        glob(imagesFolder + '/*', {}, (err, files) => {
-            if (err)
-                console.warn(err);
-            const outImagesFolder = outFolder + imagesFolder + '/';
-            if (!fs.existsSync(outImagesFolder))
-                fs.mkdirSync(outImagesFolder);
-            files.forEach((file) => fs.copyFileSync(file, outImagesFolder + file.split(/[/\\]/).pop()));
-        });
-        // Create site styles
-        if (!stylesCreated) {
-            stylesCreated = true;
-            let styles = '';
-            if (config.defaultStyles !== false) {
-                styles = dedent `
-                    body {font-family: sans-serif; margin: 4em; max-width: 1000px; background: #eee;}
-                    main {margin: 3em -1em; background: #fff; padding: 1em;}
-                    h1, h2 {margin-bottom: 0.6em; font-weight: normal; border-bottom: 1px solid #a2a9b1;}
-                    ul, ol {margin: 0.3em 0 0 1.6em; padding: 0;}
-                    dt {font-weight: bold;}
-                    dd, dl dl {margin-block: 0; margin-inline-start: 30px;}
-
-                    figure {margin: 1em;}
-                    .image-thumb, .image-frame {padding: 6px; border: 1px solid gray;}
-                    figcaption {padding-top: 6px;}
-
-                    table.wikitable {border-collapse: collapse;}
-                    table.wikitable, table.wikitable th, table.wikitable td {border: 1px solid gray; padding: 6px;}
-                    table.wikitable th {background-color: #eaecf0; text-align: center;}
-
-                    a:not(:hover) {text-decoration: none;}
-                    a.internal-link {color: #04a;}
-                    a.internal-link:visited {color: #26d;}
-                    a.external-link {color: #36b;}
-                    a.external-link:visited {color: #58d;}
-                    a.external-link::after {content: '\1f855';}
-                    a.redlink {color: #d33;}
-                    a.redlink:visited {color: #b44;}
-
-                    #toc {display: inline-block; border: 1px solid #aab; padding: 8px; background-color: #f8f8f8; font-size: 95%;}
-                    #toc-heading {display: block; text-align: center;}
-                    #toc ol {margin: 0 0 0 1.3em;}
-                `;
-            }
-            if (config.customStyles)
-                styles += config.customStyles;
-            let cssOutput = dedent `
-                ---
-                permalink: /wiki.css
-                ---
-                ${styles}
-            `;
-            fs.writeFileSync(outFolder + 'wiki.css.njk', cssOutput);
-        }
-    });
-}
-exports.compile = compile;

package/src/index.js

@@ -1,8 +0,0 @@
-"use strict";
-const compile_1 = require("./compile");
-const parse_1 = require("./parse");
-module.exports = {
-    parse: parse_1.rawParse,
-    compile: compile_1.compile,
-    eleventyPlugin: compile_1.eleventyCompile, // deprecated
-};