@trenskow/parse 0.1.0

package/.eslintrc.cjs

@@ -0,0 +1,63 @@
+module.exports = {
+	'env': {
+		'es6': true,
+		'node': true,
+		'mocha': true
+	},
+	'parserOptions': {
+		'ecmaVersion': 2022,
+		'sourceType': 'module'
+	},
+	'extends': 'eslint:recommended',
+	'rules': {
+		'indent': [
+			'error',
+			'tab',
+			{ 'SwitchCase': 1 }
+		],
+		'linebreak-style': [
+			'error',
+			'unix'
+		],
+		'quotes': [
+			'error',
+			'single'
+		],
+		'semi': [
+			'error',
+			'always'
+		],
+		'no-console': [
+			'error', {
+				'allow': [
+					'warn',
+					'error',
+					'info'
+				]
+			}
+		],
+		'no-unused-vars': [
+			'error', {
+				'argsIgnorePattern': '^_'
+			}
+		],
+		'no-empty': [
+			'error', {
+				'allowEmptyCatch': true
+			}
+		],
+		'no-trailing-spaces': [
+			'error', {
+				'ignoreComments': true
+			}
+		],
+		'require-atomic-updates': 'off',
+		'no-implicit-globals': [
+			'error'
+		],
+		'eol-last': [
+			'error',
+			'always'
+		]
+	}
+};

package/.vscode/launch.json

@@ -0,0 +1,22 @@
+{
+	// Use IntelliSense to learn about possible attributes.
+	// Hover to view descriptions of existing attributes.
+	// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+	"version": "0.2.0",
+	"configurations": [
+		{
+			"type": "pwa-node",
+			"request": "launch",
+			"name": "Launch Program",
+			"skipFiles": [
+				"<node_internals>/**"
+			],
+			"program": "${workspaceFolder}/node_modules/mocha/bin/mocha",
+			"args": [
+				"${workspaceFolder}/test.js",
+				"--timeout",
+				"0"
+			]
+		}
+	]
+}

package/LICENSE

@@ -0,0 +1,9 @@
+Copyright 2021 Kristian Trenskow
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,37 @@
+@trenskow/parse
+----
+
+A small library for parsing a string into a tree.
+
+# Usage
+
+Below is an example on how to use the library.
+
+````javascript
+import parse from '@trenskow/parse';
+
+parse('${', '}').do('This ${is ${my ${nested ${string}}}}');
+````
+
+The above example will return the following structure
+
+````JSON
+[
+    "This ",
+    [
+        "is ",
+        [
+            "my ",
+            [
+                "nested ",
+                "string"
+            ]
+        ]
+    ]
+]
+````
+
+# License
+
+See license in LICENSE.
+

package/index.js

@@ -0,0 +1,62 @@
+// Created 02/05/22 by Kristian Trenskow
+// See LICENSE for license.
+
+export default (opening, closing) => {
+
+	if (typeof opening !== 'string' || typeof closing !== 'string') {
+		throw new TypeError('Opening and closing tokens must be strings.');
+	}
+
+	if (opening.length === 0 || closing.length === 0) {
+		throw new TypeError('Opening and closing tokens cannot be zero-length.');
+	}
+
+	if (opening === closing) {
+		throw new TypeError('Opening and closing tokens cannot be the same.');
+	}
+
+	return {
+		do: (text) => {
+
+			const next = (text, offset = 0) => {
+
+				let result = [];
+
+				let literal = '';
+
+				let idx = offset;
+
+				for (idx ; idx < text.length ; idx++) {
+					if (text[idx] === '\\') {
+						literal += text[++idx];
+					} else if (text.substring(idx, idx + opening.length) === opening) {
+						result.push(literal);
+						let value;
+						[idx, value] = next(text, idx + opening.length);
+						result.push(value);
+						literal = '';
+					} else if (text.substring(idx, idx + closing.length) === closing) {
+
+						if (literal.length > 0) result.push(literal);
+
+						if (result.length === 1 && typeof result[0] === 'string') {
+							result = result[0];
+						}
+
+						return [idx + closing.length - 1, result];
+
+					} else {
+						literal += text[idx];
+					}
+				}
+
+				throw new Error('Missing closing token.');
+
+			};
+
+			return next(text + closing)[1];
+
+		}
+	};
+
+};

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@trenskow/parse",
+  "version": "0.1.0",
+  "description": "A small library for parsing a string into a tree.",
+  "main": "index.js",
+  "type": "module",
+  "scripts": {
+    "test": "node ./node_modules/mocha/bin/mocha ./test.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/trenskow/parse.git"
+  },
+  "keywords": [
+    "parse",
+    "string",
+    "nested"
+  ],
+  "author": "Kristian Trenskow",
+  "license": "BSD-2-Clause",
+  "bugs": {
+    "url": "https://github.com/trenskow/parse/issues"
+  },
+  "homepage": "https://github.com/trenskow/parse#readme",
+  "devDependencies": {
+    "chai": "^4.3.6",
+    "eslint": "^8.14.0",
+    "mocha": "^10.0.0"
+  }
+}

package/test.js

@@ -0,0 +1,73 @@
+// Created 02/05/22 by Kristian Trenskow
+// See LICENSE for license.
+
+import { expect } from 'chai';
+
+import parse from './index.js';
+
+console.info(JSON.stringify(parse('[', ']').do('This [is [my [nested [string]]]]'), null, 4));
+
+describe('parser', () => {
+	it ('should come back with parsed tree (with escapes).', () => {
+		expect(parse('[', ']').do('This [is [my [\\[nested\\]] string]].')).to.eql([
+			'This ',
+			[
+				'is ',
+				[
+					'my ',
+					'[nested]',
+					' string'
+				]
+			],
+			'.'
+		]);
+	});
+	it ('should come back with parsed tree.', () => {
+		expect(parse('{', '}').do('This {is {my {nested} string}}.')).to.eql([
+			'This ',
+			[
+				'is ',
+				[
+					'my ',
+					'nested',
+					' string'
+				]
+			],
+			'.'
+		]);
+	});
+	it ('should come back with parsed tree (long tokens).', () => {
+		expect(parse('hello', 'goodbye').do('This hello is hello my hello nested goodbye string goodbye goodbye.')).to.eql([
+			'This ',
+			[
+				' is ',
+				[
+					' my ',
+					' nested ',
+					' string '
+				],
+				' '
+			],
+			'.']);
+	});
+	it ('should throw an error if closing token is missing.', () => {
+		expect(() => {
+			parse('[', ']').do('[this');
+		}).to.throw('Missing closing token.');
+	});
+	it ('should throw an error if opening or closing tokens are not a string.', () => {
+		expect(() => {
+			parse(0, 1).do('[this');
+		}).to.throw('Opening and closing tokens must be strings.');
+	});
+	it ('should throw an error if opening or closing tokens are zero-length.', () => {
+		expect(() => {
+			parse('', '').do('[this');
+		}).to.throw('Opening and closing tokens cannot be zero-length.');
+	});
+	it ('should throw an error if opening or closing are the same.', () => {
+		expect(() => {
+			parse('123', '123').do('[this');
+		}).to.throw('Opening and closing tokens cannot be the same.');
+	});
+});