@nzdjb/static-site-generator 0.0.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 nzdjb
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,28 @@
+# static-website-generator
+
+A website generator. This is intended mostly for my own use, but you're welcome to use it too!
+
+## Usage
+
+At present, a directory and two files are needed:
+
+* The articles directory should contain toml files similar to the following:
+  ```toml
+  [[articles]]
+  title = "Article title"
+  date = 2023-01-01
+  content = "Article content"
+  author = "Article author"
+  published = true
+  ```
+  * author and published are optional, defaulting to empty string and true, respectively.
+  * content supports Markdown.
+* A template file, which should be a Handlebars HTML file.
+* An output file, which will be the location the output is written.
+
+Invocation is done as follows:
+```bash
+static-site-generator <path-to-articles> <path-to-template-file> <path-to-output-file>
+```
+
+This command is highly subject to change!

package/dist/src/article.d.ts

@@ -0,0 +1,22 @@
+#!/usr/bin/env node
+export interface Link {
+    target: string;
+    title: string;
+}
+export interface ArticleConfig {
+    title: string;
+    author?: string;
+    date: Date;
+    content: string;
+    published?: boolean;
+}
+export declare class Article {
+    readonly title: string;
+    readonly content: string;
+    readonly author?: string;
+    readonly date: string;
+    readonly published: boolean;
+    constructor(input: ArticleConfig);
+    compareDate(other: Article): 0 | 1 | -1;
+}
+//# sourceMappingURL=article.d.ts.map

package/dist/src/article.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"article.d.ts","sourceRoot":"","sources":["../../src/article.ts"],"names":[],"mappings":";AAUA,MAAM,WAAW,IAAI;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,IAAI,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,qBAAa,OAAO;IAClB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;gBAEhB,KAAK,EAAE,aAAa;IAQhC,WAAW,CAAC,KAAK,EAAE,OAAO;CAG3B"}

package/dist/src/article.js

@@ -0,0 +1,28 @@
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Article = void 0;
+const marked_1 = require("marked");
+const sanitize_html_1 = __importDefault(require("sanitize-html"));
+const sanitizerSettings = {
+    allowedTags: sanitize_html_1.default.defaults.allowedTags.concat(['img']),
+    disallowedTagsMode: 'escape',
+};
+class Article {
+    constructor(input) {
+        var _a;
+        this.title = input.title;
+        this.author = input.author;
+        this.date = input.date.toISOString().split('T')[0];
+        this.content = (0, sanitize_html_1.default)(marked_1.marked.parse(input.content), sanitizerSettings);
+        this.published = (_a = input.published) !== null && _a !== void 0 ? _a : true;
+    }
+    compareDate(other) {
+        return this.date == other.date ? 0 : this.date > other.date ? 1 : -1;
+    }
+}
+exports.Article = Article;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXJ0aWNsZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9hcnRpY2xlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7QUFFQSxtQ0FBZ0M7QUFDaEMsa0VBQXlDO0FBRXpDLE1BQU0saUJBQWlCLEdBQTBCO0lBQy9DLFdBQVcsRUFBRSx1QkFBWSxDQUFDLFFBQVEsQ0FBQyxXQUFXLENBQUMsTUFBTSxDQUFDLENBQUMsS0FBSyxDQUFDLENBQUM7SUFDOUQsa0JBQWtCLEVBQUUsUUFBUTtDQUM3QixDQUFDO0FBZUYsTUFBYSxPQUFPO0lBT2xCLFlBQVksS0FBb0I7O1FBQzlCLElBQUksQ0FBQyxLQUFLLEdBQUcsS0FBSyxDQUFDLEtBQUssQ0FBQztRQUN6QixJQUFJLENBQUMsTUFBTSxHQUFHLEtBQUssQ0FBQyxNQUFNLENBQUM7UUFDM0IsSUFBSSxDQUFDLElBQUksR0FBRyxLQUFLLENBQUMsSUFBSSxDQUFDLFdBQVcsRUFBRSxDQUFDLEtBQUssQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQztRQUNuRCxJQUFJLENBQUMsT0FBTyxHQUFHLElBQUEsdUJBQVksRUFBQyxlQUFNLENBQUMsS0FBSyxDQUFDLEtBQUssQ0FBQyxPQUFPLENBQUMsRUFBRSxpQkFBaUIsQ0FBQyxDQUFDO1FBQzVFLElBQUksQ0FBQyxTQUFTLEdBQUcsTUFBQSxLQUFLLENBQUMsU0FBUyxtQ0FBSSxJQUFJLENBQUM7SUFDM0MsQ0FBQztJQUVELFdBQVcsQ0FBQyxLQUFjO1FBQ3hCLE9BQU8sSUFBSSxDQUFDLElBQUksSUFBSSxLQUFLLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLElBQUksQ0FBQyxJQUFJLEdBQUcsS0FBSyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUN2RSxDQUFDO0NBQ0Y7QUFsQkQsMEJBa0JDIiwic291cmNlc0NvbnRlbnQiOlsiIyEvdXNyL2Jpbi9lbnYgbm9kZVxuXG5pbXBvcnQgeyBtYXJrZWQgfSBmcm9tICdtYXJrZWQnO1xuaW1wb3J0IHNhbml0aXplSFRNTCBmcm9tICdzYW5pdGl6ZS1odG1sJztcblxuY29uc3Qgc2FuaXRpemVyU2V0dGluZ3M6IHNhbml0aXplSFRNTC5JT3B0aW9ucyA9IHtcbiAgYWxsb3dlZFRhZ3M6IHNhbml0aXplSFRNTC5kZWZhdWx0cy5hbGxvd2VkVGFncy5jb25jYXQoWydpbWcnXSksXG4gIGRpc2FsbG93ZWRUYWdzTW9kZTogJ2VzY2FwZScsXG59O1xuXG5leHBvcnQgaW50ZXJmYWNlIExpbmsge1xuICB0YXJnZXQ6IHN0cmluZztcbiAgdGl0bGU6IHN0cmluZztcbn1cblxuZXhwb3J0IGludGVyZmFjZSBBcnRpY2xlQ29uZmlnIHtcbiAgdGl0bGU6IHN0cmluZztcbiAgYXV0aG9yPzogc3RyaW5nO1xuICBkYXRlOiBEYXRlO1xuICBjb250ZW50OiBzdHJpbmc7XG4gIHB1Ymxpc2hlZD86IGJvb2xlYW47XG59XG5cbmV4cG9ydCBjbGFzcyBBcnRpY2xlIHtcbiAgcmVhZG9ubHkgdGl0bGU6IHN0cmluZztcbiAgcmVhZG9ubHkgY29udGVudDogc3RyaW5nO1xuICByZWFkb25seSBhdXRob3I/OiBzdHJpbmc7XG4gIHJlYWRvbmx5IGRhdGU6IHN0cmluZztcbiAgcmVhZG9ubHkgcHVibGlzaGVkOiBib29sZWFuO1xuXG4gIGNvbnN0cnVjdG9yKGlucHV0OiBBcnRpY2xlQ29uZmlnKSB7XG4gICAgdGhpcy50aXRsZSA9IGlucHV0LnRpdGxlO1xuICAgIHRoaXMuYXV0aG9yID0gaW5wdXQuYXV0aG9yO1xuICAgIHRoaXMuZGF0ZSA9IGlucHV0LmRhdGUudG9JU09TdHJpbmcoKS5zcGxpdCgnVCcpWzBdO1xuICAgIHRoaXMuY29udGVudCA9IHNhbml0aXplSFRNTChtYXJrZWQucGFyc2UoaW5wdXQuY29udGVudCksIHNhbml0aXplclNldHRpbmdzKTtcbiAgICB0aGlzLnB1Ymxpc2hlZCA9IGlucHV0LnB1Ymxpc2hlZCA/PyB0cnVlO1xuICB9XG5cbiAgY29tcGFyZURhdGUob3RoZXI6IEFydGljbGUpIHtcbiAgICByZXR1cm4gdGhpcy5kYXRlID09IG90aGVyLmRhdGUgPyAwIDogdGhpcy5kYXRlID4gb3RoZXIuZGF0ZSA/IDEgOiAtMTtcbiAgfVxufVxuIl19

package/dist/src/index.d.ts

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+import { Article } from './article';
+export declare function getArticles(articlesDir: string): Article[];
+export declare function renderIndex(template: string, articles: Article[]): string;
+//# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,OAAO,EAAiB,MAAM,WAAW,CAAC;AAMnD,wBAAgB,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,EAAE,CAG1D;AAED,wBAAgB,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,MAAM,CAKzE"}

package/dist/src/index.js

@@ -0,0 +1,55 @@
+#!/usr/bin/env node
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.renderIndex = exports.getArticles = void 0;
+const article_1 = require("./article");
+const handlebars_1 = __importDefault(require("handlebars"));
+const fs_1 = require("fs");
+const toml_1 = __importDefault(require("@iarna/toml"));
+const path = __importStar(require("path"));
+function getArticles(articlesDir) {
+    const config = (0, fs_1.readdirSync)(articlesDir).map(file => path.join(articlesDir, file)).map(file => (0, fs_1.readFileSync)(file).toString()).join('\n');
+    return toml_1.default.parse(config)['articles'].map(article => new article_1.Article(article));
+}
+exports.getArticles = getArticles;
+function renderIndex(template, articles) {
+    articles = articles.filter((a) => a.published);
+    articles.sort((a, b) => a.compareDate(b));
+    articles.reverse();
+    return handlebars_1.default.compile(template)({ articles });
+}
+exports.renderIndex = renderIndex;
+if (require.main === module) {
+    const args = process.argv;
+    const articles = getArticles(args[2]);
+    const template = (0, fs_1.readFileSync)(args[3]).toString();
+    const index = renderIndex(template, articles);
+    (0, fs_1.writeFileSync)(args[4], index);
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0FBQ0EsdUNBQW1EO0FBQ25ELDREQUFvQztBQUNwQywyQkFBOEQ7QUFDOUQsdURBQStCO0FBQy9CLDJDQUE2QjtBQUU3QixTQUFnQixXQUFXLENBQUMsV0FBbUI7SUFDN0MsTUFBTSxNQUFNLEdBQUcsSUFBQSxnQkFBVyxFQUFDLFdBQVcsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsRUFBRSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsV0FBVyxFQUFFLElBQUksQ0FBQyxDQUFDLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxFQUFFLENBQUMsSUFBQSxpQkFBWSxFQUFDLElBQUksQ0FBQyxDQUFDLFFBQVEsRUFBRSxDQUFDLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDO0lBQ3hJLE9BQVEsY0FBSSxDQUFDLEtBQUssQ0FBQyxNQUFNLENBQUMsQ0FBQyxVQUFVLENBQWdDLENBQUMsR0FBRyxDQUFDLE9BQU8sQ0FBQyxFQUFFLENBQUMsSUFBSSxpQkFBTyxDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUM7QUFDN0csQ0FBQztBQUhELGtDQUdDO0FBRUQsU0FBZ0IsV0FBVyxDQUFDLFFBQWdCLEVBQUUsUUFBbUI7SUFDL0QsUUFBUSxHQUFHLFFBQVEsQ0FBQyxNQUFNLENBQUMsQ0FBQyxDQUFDLEVBQUUsRUFBRSxDQUFDLENBQUMsQ0FBQyxTQUFTLENBQUMsQ0FBQztJQUMvQyxRQUFRLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBVSxFQUFFLENBQVUsRUFBRSxFQUFFLENBQUMsQ0FBQyxDQUFDLFdBQVcsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDO0lBQzVELFFBQVEsQ0FBQyxPQUFPLEVBQUUsQ0FBQztJQUNuQixPQUFPLG9CQUFVLENBQUMsT0FBTyxDQUFDLFFBQVEsQ0FBQyxDQUFDLEVBQUUsUUFBUSxFQUFFLENBQUMsQ0FBQztBQUNwRCxDQUFDO0FBTEQsa0NBS0M7QUFFRCxJQUFJLE9BQU8sQ0FBQyxJQUFJLEtBQUssTUFBTSxFQUFFO0lBQzNCLE1BQU0sSUFBSSxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUM7SUFDMUIsTUFBTSxRQUFRLEdBQUcsV0FBVyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDO0lBQ3RDLE1BQU0sUUFBUSxHQUFHLElBQUEsaUJBQVksRUFBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxRQUFRLEVBQUUsQ0FBQztJQUNsRCxNQUFNLEtBQUssR0FBRyxXQUFXLENBQUMsUUFBUSxFQUFFLFFBQVEsQ0FBQyxDQUFDO0lBQzlDLElBQUEsa0JBQWEsRUFBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLEVBQUUsS0FBSyxDQUFDLENBQUM7Q0FDL0IiLCJzb3VyY2VzQ29udGVudCI6WyIjIS91c3IvYmluL2VudiBub2RlXG5pbXBvcnQgeyBBcnRpY2xlLCBBcnRpY2xlQ29uZmlnIH0gZnJvbSAnLi9hcnRpY2xlJztcbmltcG9ydCBIYW5kbGViYXJzIGZyb20gJ2hhbmRsZWJhcnMnO1xuaW1wb3J0IHsgcmVhZEZpbGVTeW5jLCB3cml0ZUZpbGVTeW5jLCByZWFkZGlyU3luYyB9IGZyb20gJ2ZzJztcbmltcG9ydCB0b21sIGZyb20gJ0BpYXJuYS90b21sJztcbmltcG9ydCAqIGFzIHBhdGggZnJvbSAncGF0aCc7XG5cbmV4cG9ydCBmdW5jdGlvbiBnZXRBcnRpY2xlcyhhcnRpY2xlc0Rpcjogc3RyaW5nKTogQXJ0aWNsZVtdIHtcbiAgY29uc3QgY29uZmlnID0gcmVhZGRpclN5bmMoYXJ0aWNsZXNEaXIpLm1hcChmaWxlID0+IHBhdGguam9pbihhcnRpY2xlc0RpciwgZmlsZSkpLm1hcChmaWxlID0+IHJlYWRGaWxlU3luYyhmaWxlKS50b1N0cmluZygpKS5qb2luKCdcXG4nKTtcbiAgcmV0dXJuICh0b21sLnBhcnNlKGNvbmZpZylbJ2FydGljbGVzJ10gYXMgdW5rbm93biBhcyBBcnRpY2xlQ29uZmlnW10pLm1hcChhcnRpY2xlID0+IG5ldyBBcnRpY2xlKGFydGljbGUpKTtcbn1cblxuZXhwb3J0IGZ1bmN0aW9uIHJlbmRlckluZGV4KHRlbXBsYXRlOiBzdHJpbmcsIGFydGljbGVzOiBBcnRpY2xlW10pOiBzdHJpbmcge1xuICBhcnRpY2xlcyA9IGFydGljbGVzLmZpbHRlcigoYSkgPT4gYS5wdWJsaXNoZWQpO1xuICBhcnRpY2xlcy5zb3J0KChhOiBBcnRpY2xlLCBiOiBBcnRpY2xlKSA9PiBhLmNvbXBhcmVEYXRlKGIpKTtcbiAgYXJ0aWNsZXMucmV2ZXJzZSgpO1xuICByZXR1cm4gSGFuZGxlYmFycy5jb21waWxlKHRlbXBsYXRlKSh7IGFydGljbGVzIH0pO1xufVxuXG5pZiAocmVxdWlyZS5tYWluID09PSBtb2R1bGUpIHtcbiAgY29uc3QgYXJncyA9IHByb2Nlc3MuYXJndjtcbiAgY29uc3QgYXJ0aWNsZXMgPSBnZXRBcnRpY2xlcyhhcmdzWzJdKTtcbiAgY29uc3QgdGVtcGxhdGUgPSByZWFkRmlsZVN5bmMoYXJnc1szXSkudG9TdHJpbmcoKTtcbiAgY29uc3QgaW5kZXggPSByZW5kZXJJbmRleCh0ZW1wbGF0ZSwgYXJ0aWNsZXMpO1xuICB3cml0ZUZpbGVTeW5jKGFyZ3NbNF0sIGluZGV4KTtcbn1cbiJdfQ==

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@nzdjb/static-site-generator",
+  "version": "0.0.3",
+  "description": "Static site generator.",
+  "main": "dist/src/index.js",
+  "repository": "https://github.com/nzdjb/static-site-generator",
+  "author": "nzdjb",
+  "license": "MIT",
+  "scripts": {
+    "build": "tsc",
+    "test": "jest",
+    "lint": "eslint src test"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.2.4",
+    "@types/marked": "^4.0.8",
+    "@types/node": "^18.11.10",
+    "@types/sanitize-html": "^2.9.0",
+    "@typescript-eslint/eslint-plugin": "^5.43.0",
+    "esbuild": "^0.15.18",
+    "esbuild-jest": "^0.5.0",
+    "eslint": "^8.0.1",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-config-standard-with-typescript": "^34.0.1",
+    "eslint-plugin-import": "^2.25.2",
+    "eslint-plugin-n": "^15.0.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-promise": "^6.0.0",
+    "jest": "^29.3.1",
+    "prettier": "^2.8.7",
+    "typescript": "*"
+  },
+  "bin": {
+    "static-site-generator": "dist/src/index.js"
+  },
+  "dependencies": {
+    "@iarna/toml": "^2.2.5",
+    "handlebars": "^4.7.7",
+    "marked": "^4.3.0",
+    "sanitize-html": "^2.10.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist/src"
+  ]
+}