1.2.0

- Add `eleventyPlugin` method
- Add `outputFolder` and `templatesFolder` options
- Add various CLI options
- Add wikitext tables

Author: Nixinova

.gitignore

@@ -3,3 +3,4 @@ node_modules/
 wikity-out/
 
 src/*.js
+src/*.d.ts

.npmignore

@@ -1,9 +1,18 @@
 # Changelog
 
+## 1.2.0
+*2021-04-01*
+- Added function `eleventyPlugin()` for use with Eleventy's `addPlugin` method.
+- Added configuration option `outputFolder` to configure the folder the compiled HTML files are placed in.
+- Added configuration option `templatesFolder` to configure the folder templates are placed in.
+- Added CLI options `--outputFolder`, `--templatesFolder`, `--eleventy`, and `--defaultStyles` to change configuration options.
+- Added support for tables.
+- Added a warning when the parser detects non-repetition-based `#time` function syntax is being used.
+
 ## 1.1.0
 *2021-03-28*
 - Added `parse` CLI command to implement `parse()`.
-- Added support for a table of contents.
+- Added a generated table of contents if there are over 4 headings.
 - Added support for `nowiki` tag.
 - Added support for `onlyinclude`, `includeonly`, and `noinclude` tags in templates.
 - Added support for magic words `__TOC__`, `__FORCETOC__`, `__NOTOC__`, and `__NOINDEX__`.

changelog.md

@@ -1,6 +1,6 @@
 {
   "name": "wikity",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Wikitext as a templating language, with built-in Eleventy support.",
   "main": "src/index.js",
   "scripts": {
@@ -9,6 +9,10 @@
   "bin": {
     "wikity": "src/cli.js"
   },
+  "files": [
+    "src/*.js",
+    "src/*.d.ts"
+  ],
   "keywords": [
     "eleventy",
     "eleventy-plugin",
@@ -18,20 +22,27 @@
     "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",
     "escape-html": "^1.0.3",
     "glob": "^7.1.6",
-    "html-formatter": "^0.1.9",
-    "novasheets": "1.0.0-pre3"
+    "html-formatter": "^0.1.9"
   },
   "peerDependencies": {
     "@11ty/eleventy": ">=0.10.0"
   },
   "devDependencies": {
     "@types/node": "^14.14.37",
-    "typescript": "^4.2.3"
+    "typescript": "~4.2.3"
   }
 }

package-lock.json

@@ -12,41 +12,65 @@ Wikity is available [on npm](https://www.npmjs.com/package/wikity).
 
 ## API
 
-- `wikity.compile(directory?: string, options?: object)`
-  - Compile Wikitext files into HTML. Find outputted files in folder `wikity-out/`.
+### Node
+
+- `wikity.compile(folder?: string, options?: object): void`
+  - Compile all Wikitext (`.wiki`) files into HTML.
   - `directory?: string`
     - The folder to compile (default: `.`, the current directory).
   - `options?: object`
+    - `outputFolder?: string`
+      - Where outputted HTML files shall be placed (default: `wikity-out`).
+    - `templatesFolder?: string`
+      - What folder to place templates in (default: `'templates'`).
     - `eleventy?: boolean`
       - 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: `''`).
-- `wikity.clean()`
-  - Clean up residual folders after compilation.
-
-Calling `wikity()` will compile all `.wiki` files into their corresponding `.html` versions.
-Outputted files are located in the `wikity-out/` directory.
+- `wikity.eleventyPlugin(folder?: string, options?: object): void`
+  - An implementation of `compile` for use with Eleventy's `addPlugin` API.
+- `wikity.parse(input: string): string`
+  - Parse raw wikitext input into HTML.
 
 ```js
 const wikity = require('wikity');
-wikity.compile(); // compile all .wiki files inside this directory
+
+// compile all .wiki files inside this directory
+wikity.compile();
+
+// parse wikitext from an input string
+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:
 
 ```js
 // .eleventy.js (eleventy's configuration file)
 const wikity = require('wikity');
-wikity.compile('.', { eleventy: true });
+module.exports = function (eleventyConfig) {
+    eleventyConfig.addPlugin( () => wikity.eleventyPlugin() );
+}
+```
+
+### Command-line
+```cmd
+$ wikity help
+Display a help message
+$ wikity (compile|-c) [<folder>] [-o <folder>] [-t <folder>] [-e] [-d]
+Compile Wikity with various options
+$ wikity parse <input>
+Parse raw input into HTML
+$ wikity version
+Display the latest version of Wikity
 ```
 
 ## Usage
 
 Use [Wikitext](https://en.wikipedia.org/wiki/Help:Wikitext) (file extension `.wiki`) to create your pages.
 
-Any wiki templates (called using `{{template name}}`) must be inside the `templates/` folder.
+Any wiki templates (called using `{{template name}}`) must be inside the `templates/` folder by default.
 
 ### Wiki markup
 
@@ -75,24 +99,29 @@ Any wiki templates (called using `{{template name}}`) must be inside the `templa
 | `{{tp name\|arg=val}}`           | *(ditto but `{{{arg}}}` is set to 'val')* |
 | `{{{arg}}}`                      | *(value given by template)*               |
 | `{{{arg\|default val}}}`         | *(ditto but 'default val' if unset)*      |
+| `{\| style="margin:1em"`         | *table opening*                           |
+| `! Cell heading`                 | **Cell heading**                          |
+| `\|- class="new-row"`            | *new table row*                           |
+| `\| Cell content`                | Cell content                              |
+| `\|}`                            | *table closing*                           |
 | `{{#if:non-empty-string\|text}}` | text                                      |
 | `{{#ifeq:1\|2\|true\|false}}`    | false                                     |
 | `{{#vardefine:varname\|text}}`   | *(saved to memory)*                       |
 | `{{#var:varname}}`               | text *(from memory)*                      |
 | `{{#var:varname\|default val}}`  | *(ditto but 'default val' if unset)*      |
 | `{{#switch:a\|a=1\|b=2\|c=3}}`   | 1                                         |
 | `{{#time:dd/mm/yy\|2021-03-28}}` | 28/03/21                                  |
-| `{{lc:TEXT}}`                    | text                                      |
-| `{{ucfirst:text}}`               | Text                                      |
-| `{{len:12345}}`                  | 5                                         |
-| `{{sub:string|2|4}}`             | ring                                      |
-| `{{pos:text|x}}`                 | 2                                         |
-| `{{padleft:text|5|_}}`           | _text                                     |
-| `{{padright:msg|5|_}}`           | msg__                                     |
-| `{{replace:Message|e|3}}`        | M3ssag3                                   |
-| `{{explode:A-B-C-D|-|2}}`        | C                                         |
-| `{{urlencode:t e x t}}`          | t%20e%20x%20t                             |
-| `{{urldecode:a%20b%27c}}`        | a b'c                                     |
+| `{{#lc:TEXT}}`                   | text                                      |
+| `{{#ucfirst:text}}`              | Text                                      |
+| `{{#len:12345}}`                 | 5                                         |
+| `{{#sub:string\|2\|4}}`          | ring                                      |
+| `{{#pos:text\|x}}`               | 2                                         |
+| `{{#padleft:text\|5\|_}}`        | _text                                     |
+| `{{#padright:msg\|5\|_}}`        | msg__                                     |
+| `{{#replace:Message\|e\|3}}`     | M3ssag3                                   |
+| `{{#explode:A-B-C-D\|-\|2}}`     | C                                         |
+| `{{#urlencode:t e x t}}`         | t%20e%20x%20t                             |
+| `{{#urldecode:a%20b%27c}}`       | a b'c                                     |
 | `<noinclude>No</noinclude>`      | *(blank outside a template)*              |
 | `<onlyinclude>Yes</onlyinclude>` | Yes                                       |
 | `<includeonly>Yes</includeonly>` | Yes *(blank inside a template)*           |

package.json

@@ -0,0 +1,7 @@
+import fs from 'fs';
+
+const OUT_FOLDER = 'wikity-out/';
+
+export function clean(): void {
+    fs.rmdirSync('_site/' + OUT_FOLDER, { recursive: true });
+}

readme.md

@@ -2,39 +2,51 @@
 
 import wikity from './index';
 
-const VERSION = '1.1.0';
+const VERSION = '1.2.0';
 
 const indent = (n: number): string => ' '.repeat(n * 4);
 const usage = (command: string, ...desc: string[]): void => {
     console.log('\n' + indent(2) + command);
-    for (let msg of desc) console.log(indent(3) + msg);
+    desc.forEach((msg: string) => console.log(indent(2.5) + msg));
 }
 const arg = (n: number): string => process.argv[n + 1] || '';
-
+const args = process.argv.slice(1);
 
 if (!arg(1)) {
     console.log('Type `wikity help` for a list of commands.');
 }
 else if (arg(1).includes('h')) {
     console.log(`\n${indent(1)}Wikity CLI commands:`);
-    usage(`wikity [--]h[elp]`,
+    usage(`wikity (help|-h)`,
         `Display this help message.`,
     );
-    usage(`wikity [--]c[ompile] [<folder>]`,
+    usage(`wikity (compile|-c) [<folder>] [-o <folder>] [-t <folder>] [-e] [-d]`,
         `Compile wikitext files from a given folder.`,
+        `  [<folder>]\n${indent(3.5)}Input folder ('.' (current folder) if unset).`,
+        `  (-o|--outputFolder) <folder>\n${indent(3.5)}Folder that compiled HTML files are placed in ('wikity-out' if unset).`,
+        `  (-t|--templatesFolder) <folder>\n${indent(3.5)}Where to place wiki templates ('templates' if unset).`,
+        `  (-e|--eleventy)\n${indent(3.5)}Compiles files with Eleventy front matter (false if unset).`,
+        `  (-d|--defaultStyles)\n${indent(3.5)}Add default wiki styling to all pages (true if unset).`,
     )
-    usage(`wikity [--]p[arse] "<input>"`,
+    usage(`wikity (parse|-p) "<input>"`,
         `Parse raw wikitext from the command line.`,
     )
-    usage(`wikity [--]v[ersion]`,
+    usage(`wikity (version|-v)`,
         `Display the current version of Wikity.`,
     );
 }
 else if (arg(1).includes('c')) {
-    wikity.compile(arg(2) || '.', { eleventy: !!arg(3) });
+    const configArgs = args.slice(2);
+    const folder = arg(2) || '.';
+    const outputFolder = configArgs.join(' ').includes('-o') && configArgs.filter((_, i) => configArgs[i - 1]?.includes('-o')).join(' ') || '';
+    const templatesFolder = configArgs.join(' ').includes('-t') && configArgs.filter((_, i) => configArgs[i - 1]?.includes('-t')).join(' ') || '';
+    const eleventy = configArgs.join(' ').includes('-e');
+    const defaultStyles = configArgs.join(' ').includes('-d');
+    wikity.compile(folder, { outputFolder, templatesFolder, eleventy, defaultStyles });
 }
 else if (arg(1).includes('p')) {
-    console.log(wikity.parse(arg(2)));
+    const input = arg(2);
+    console.log(wikity.parse(input));
 }
 else if (arg(1).includes('v')) {
     console.log('The current version of Wikity is ' + VERSION);

src/clean.ts

@@ -1,9 +1,11 @@
 export type Metadata = Record<string, any>;
 
 export type Config = {
+    outputFolder?: string,
     eleventy?: boolean,
     defaultStyles?: boolean,
     customStyles?: string,
+    templatesFolder?: string,
 }
 
 export class Result extends String {
@@ -13,3 +15,9 @@ export class Result extends String {
         this.metadata = {};
     }
 }
+
+export function RegExpBuilder(regex: string, flag: string = 'mgi') {
+    return RegExp(regex.replace(/ /g, '').replace(/\|\|.+?\|\|/g, ''), flag);
+}
+
+export const RawString = String.raw;