@marrs/sxml 0.3.0

package/LICENCE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 David Marrs
+
+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,13 @@
+S-Expression Markup Language (SXML)
+
+This is a simple language for writing XML and HTML.  It's for those of us who
+would like to write HTML directly but find the language a little bit too
+clunky and a little too easy to make mistakes with.  SXML just makes it a
+little bit nicer.
+
+Minimal effort is made to guard against bad code and it is quite possible to
+produce broken HTML. For convenience, angled brackets are escaped in positions
+where that is likely to be the preferred option.
+
+If you need to guard against script injection, you should run the HTML
+generated from the SXML against a library dedicated to that purpose.

package/cli/index.js

@@ -0,0 +1,32 @@
+#!/usr/bin/env node
+import fs from 'fs'
+import { StringDecoder } from 'string_decoder'
+import { Buffer } from 'buffer';
+import { init_parse_state, update_parse_state } from '../src/parser.js'
+import await_init from '../src/init.js';
+
+var idxFilename = (/node$/.test(process.argv[0]))? 2 : 1;
+var filename = process.argv[idxFilename];
+if (!filename) {
+    console.error("Please provide an SXML file");
+    process.exit();
+}
+
+await_init().then(function(data) {
+    var readStream = fs.createReadStream(filename);
+    var parseState, decoder;
+    decoder = new StringDecoder('utf8');
+    readStream.on('open', function() {
+        parseState = init_parse_state({
+            filename: filename,
+            extensions: data.extensions
+        });
+    });
+
+    readStream.on('data', function(chunk) {
+        var result = [];
+        var strChunk = decoder.write(chunk);
+        update_parse_state(strChunk, parseState, result);
+        process.stdout.write(Buffer.from(result.join('')));
+    });
+});

package/lib/index.js

@@ -0,0 +1,3 @@
+import { compile } from '../src/index.js';
+
+export { compile }

package/lib/preprocessors.js

@@ -0,0 +1,15 @@
+import {
+    pre_html_chars,
+    pre_html_entity,
+    pre_hex_chars,
+    pre_hex_entity,
+    pre_qualified_ns,
+} from '../src/processors/index.js';
+
+export {
+    pre_html_chars as htmlChars,
+    pre_html_entity as htmlEntity,
+    pre_hex_chars as hexChars,
+    pre_hex_entity as hexEntity,
+    pre_qualified_ns as qualifiedNs,
+};

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@marrs/sxml",
+  "version": "0.3.0",
+  "description": "S-Expression Markup Language",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/marrs/sxml.git"
+  },
+  "exports": {
+    ".": "./lib/index.js",
+    "./preprocessors": "./lib/preprocessors.js"
+  },
+  "type": "module",
+  "files": [
+    "lib",
+    "src",
+    "cli",
+    "README.md",
+    "LICENCE"
+  ],
+  "scripts": {
+    "sxml": "./cli/index.js",
+    "test": "mocha"
+  },
+  "bin": {
+    "sxml": "cli/index.js"
+  },
+  "author": "David Marrs",
+  "license": "MIT",
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "chai": "^4.3.6",
+    "mocha": "^9.2.2",
+    "sinon": "^13.0.1",
+    "sinon-chai": "^3.7.0"
+  }
+}

package/src/buffer.js

@@ -0,0 +1,72 @@
+import { count_newlines } from './util.js'
+
+function index_of_token_end(tkn) {
+    var matchEndOfToken = tkn.match(/(\)|\s)/);
+    return matchEndOfToken? matchEndOfToken.index : -1
+}
+
+export var Buffer_Trait = {
+    reset: function(idx) {
+        var start = this.cursor;
+        this.cursor = idx || 0;
+        if (this.cursor > this.str.length) {
+            this.cursor = this.str.length;
+        }
+        if (start < this.cursor) {
+            this.lineCount += count_newlines(this.str.substring(start, this.cursor));
+        }
+        this.substr = this.str.substring(this.cursor);
+    },
+
+    step: function(offset) {
+        if (void 0 === offset) {
+            offset = 1;
+        }
+        this.reset(this.cursor + offset);
+    },
+
+    skip_whitespace: function(x) {
+        x = (x === void 0)? Number.MAX_VALUE : x;
+
+        var nextNonWsChar = this.substr.match(/[^\s]/);
+        return nextNonWsChar?
+            this.step(Math.min(x, nextNonWsChar.index)):
+            this.reset(Math.min(x, this.str.length));
+    },
+
+    read_whitespace: function() {
+        var nextNonWsChar = this.substr.match(/[^\s]/);
+        if (nextNonWsChar) {
+            return this.read_to(nextNonWsChar.index);
+        }
+        return this.read_to_end();
+    },
+
+    read_to: function(offset) {
+        if (typeof offset === 'string') {
+            offset = this.substr.indexOf(offset);
+            if (offset < 0) {
+                offset = this.substr.length;
+            }
+        }
+        var output = this.substr.substring(0, offset);
+        this.step(offset);
+        return output;
+    },
+
+    read_to_end: function() {
+        var output = this.str.substring(this.cursor);
+        this.reset(this.str.length);
+        return output;
+    }
+};
+
+export var Sexp_Buffer_Trait = Object.create(Buffer_Trait);
+
+Object.assign(Sexp_Buffer_Trait, {
+    read_token: function() {
+        var idxTokenEnd = index_of_token_end(this.substr);
+        return idxTokenEnd < 0?
+            this.read_to_end() : this.read_to(idxTokenEnd);
+    }
+});

package/src/index.js

@@ -0,0 +1,31 @@
+import { ReadStream, readFileSync } from 'fs';
+import {
+    init_parse_state,
+    parse_chunk,
+} from '../src/parser.js'
+
+function is_string(value) {
+  return typeof value === 'string' || value instanceof String;
+}
+
+export function compile(source, options={}) {
+    // source can be one of:
+    // - fs.ReadStream
+    // - String.
+
+    var data = init_parse_state({
+        source,
+        isPrettyFormatting: options.pretty || false,
+        extensions: options.extensions || {},
+    });
+    var result = [];
+    if (source instanceof ReadStream) {
+        parse_chunk(readFileSync(source.path, 'utf8'), data, result);
+        return result.join('');
+    } else if (is_string(source)) {
+        parse_chunk(source, data, result);
+        return result.join('');
+    } else {
+        throw new Error("Incompatible type: Expected String or fs.ReadStream");
+    }
+}

package/src/init.js

@@ -0,0 +1,5 @@
+import { await_extensions } from './processors/index.js';
+
+export default function await_init() {
+    return await_extensions();
+}