├── public
    ├── global.css
    ├── fav.png
    ├── script.js
    └── index.html
├── src
    ├── global.d.ts
    ├── main.ts
    ├── tests
    │   ├── clui_many_commands.ts
    │   ├── converter.test.ts
    │   ├── clui_one_command.ts
    │   ├── search.test.ts
    │   ├── parser.test.ts
    │   ├── matcher.test.ts
    │   ├── clui.test.ts
    │   └── runner.test.ts
    ├── lib
    │   ├── converter.ts
    │   ├── searcher.ts
    │   ├── matcher.ts
    │   ├── parser.ts
    │   └── runner.ts
    ├── Old.svelte
    ├── commands.ts
    ├── old.css
    ├── clui.ts
    └── Clui.svelte
├── .gitignore
├── .vscode
    └── settings.json
├── svelte.config.js
├── CHANGELOG.md
├── jest.config.js
├── wallaby.js
├── package.json
├── README.md
├── rollup.config.js
├── tsconfig.json
└── LICENSE


/public/global.css:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/src/global.d.ts:
--------------------------------------------------------------------------------
1 | /// <reference types="svelte" />


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | /node_modules/
2 | /public/dist/
3 | 
4 | .DS_Store
5 | 


--------------------------------------------------------------------------------
/src/main.ts:
--------------------------------------------------------------------------------
1 | import Clui from './Clui.svelte';
2 | 
3 | export { Clui };


--------------------------------------------------------------------------------
/public/fav.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Vandesm14/clui/HEAD/public/fav.png


--------------------------------------------------------------------------------
/public/script.js:
--------------------------------------------------------------------------------
1 | // clui.load({
2 | // 	'name': 'test',
3 | // 	'description': 'test'
4 | // });


--------------------------------------------------------------------------------
/.vscode/settings.json:
--------------------------------------------------------------------------------
1 | {
2 | 	"jest.jestCommandLine": "npm run test --",
3 | 	"recommendations": ["svelte.svelte-vscode"]
4 | }


--------------------------------------------------------------------------------
/src/tests/clui_many_commands.ts:
--------------------------------------------------------------------------------
1 | import git from './clui_one_command';
2 | 
3 | export default [git, {name: 'npm'}, {name: 'node'}];


--------------------------------------------------------------------------------
/svelte.config.js:
--------------------------------------------------------------------------------
1 | const sveltePreprocess = require('svelte-preprocess');
2 | 
3 | module.exports = {
4 |   preprocess: sveltePreprocess()
5 | };


--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
1 | # Changelog
2 | All notable changes to this project will be documented in this file.
3 | 
4 | The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
5 | and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6 | 
7 | ## [Unreleased]


--------------------------------------------------------------------------------
/jest.config.js:
--------------------------------------------------------------------------------
 1 | module.exports = {
 2 |   preset: 'ts-jest',
 3 |   testEnvironment: 'node',
 4 | 	collectCoverageFrom: [
 5 | 		// 'src/**/*.test.ts' // tests only
 6 | 		'src/**/*.ts' // full coverage
 7 | 	],
 8 | 	// coveragePathIgnorePatterns: [
 9 | 	// 	'src/**/*.types.ts',
10 | 	// 	'src/global.d.ts',
11 | 	// 	'main.ts'
12 | 	// ]
13 |   globals: {
14 |     'ts-jest': {tsconfig: './tsconfig.json'}
15 |   }
16 | };


--------------------------------------------------------------------------------
/wallaby.js:
--------------------------------------------------------------------------------
 1 | module.exports = function(wallaby) {
 2 |   return {
 3 | 		autoDetect: true,
 4 |     testFramework: {
 5 |       configFile: './jest.config.js'
 6 |     },
 7 | 		filesWithNoCoverageCalculated: [
 8 | 			'src/**/*.types.ts',
 9 | 			'src/**/*.d.ts',
10 | 			'src/commands.ts',
11 | 			'src/tests/**/*_commands.ts',
12 | 			'src/tests/**/*_command.ts',
13 | 			'src/main.ts'
14 | 		],
15 | 		// runMode: 'onsave'
16 |   };
17 | };


--------------------------------------------------------------------------------
/public/index.html:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE html>
 2 | <html lang="en">
 3 | 	<head>
 4 | 		<meta charset='utf-8'>
 5 | 		<meta name='viewport' content='width=device-width,initial-scale=1'>
 6 | 
 7 | 		<title>CLUI</title>
 8 | 
 9 | 		<link rel='icon' type='image/png' href='fav.png'>
10 | 		<link rel='stylesheet' href='global.css'>
11 | 
12 | 		<style>
13 | 			body {
14 | 				background-color: hsl(225, 38%, 6%);
15 | 			}
16 | 		</style>
17 | 		
18 | 		<script src='dist/clui.js'></script>
19 | 		<script type="module" src="script.js"></script>
20 | 	</head>
21 | 
22 | 	<body>
23 | 		<clui-main />
24 | 	</body>
25 | </html>


--------------------------------------------------------------------------------
/src/tests/converter.test.ts:
--------------------------------------------------------------------------------
 1 | import convert from '../lib/converter';
 2 | 
 3 | import _git from './clui_one_command';
 4 | import { Command, Arg } from '../clui';
 5 | 
 6 | 
 7 | const git = convert(_git);
 8 | const push: Command = git.children[0] as Command;
 9 | 
10 | describe('converter', () => {
11 | 	it('convert command', () => {
12 |     expect(git instanceof Command).toBe(true);
13 | 	});
14 | 	it('convert subcommand', () => {
15 |     expect(push instanceof Command).toBe(true);
16 | 	});
17 |   it('convert argument', () => {
18 |     expect(push.children[0] instanceof Arg).toBe(true);
19 |   });
20 | });


--------------------------------------------------------------------------------
/src/lib/converter.ts:
--------------------------------------------------------------------------------
 1 | import { Command, Arg } from "../clui";
 2 | 
 3 | const convert = (cmd: Command) => {
 4 |   cmd = new Command(cmd, false);
 5 | 
 6 |   if (cmd.children && cmd.type === 'cmd') {
 7 |     let list = [];
 8 |     for (let item of cmd.children) {
 9 |       list.push(convert(item as Command));
10 |     }
11 |     cmd.children = list;
12 |   } else if (cmd.children && cmd.type === 'arg') {
13 |     let list = [];
14 |     for (let item of cmd.children) {
15 |       list.push(new Arg(item as Arg));
16 |     }
17 |     cmd.children = list;
18 |   }
19 | 
20 |   return cmd;
21 | };
22 | 
23 | export default convert;


--------------------------------------------------------------------------------
/src/tests/clui_one_command.ts:
--------------------------------------------------------------------------------
 1 | import type { Command, Arg } from '../clui';
 2 | import type { Request, Response } from '../lib/runner';
 3 | 
 4 | const push: Command = {
 5 | 	name: 'push',
 6 | 	description: 'push local changes to git remote [test]',
 7 | 	type: 'arg',
 8 | 	children: [
 9 | 		{
10 | 			name: 'remote',
11 | 			description: 'the name of the remote to push changes to',
12 | 			required: true,
13 | 			type: 'string',
14 | 			mode: 'arg'
15 | 		},
16 | 		{
17 | 			name: 'branch',
18 | 			description: 'the name of the branch to push changes to',
19 | 			required: true,
20 | 			type: 'string',
21 | 			mode: 'arg'
22 | 		},
23 | 		{
24 | 			name: 'force',
25 | 			description: 'forces the push of unrelated histories',
26 | 			type: 'boolean',
27 | 			mode: 'opt'
28 | 		}
29 | 	],
30 |   run: (req: Request, res: Response) => {
31 |     res.status('ok');
32 |   }
33 | };
34 | 
35 | const git: Command = {
36 | 	name: 'git',
37 | 	description: 'a simple git cli [test]',
38 | 	type: 'cmd',
39 | 	children: [push]
40 | };
41 | 
42 | export default git;


--------------------------------------------------------------------------------
/src/tests/search.test.ts:
--------------------------------------------------------------------------------
 1 | import convert from '../lib/converter';
 2 | import search from '../lib/searcher';
 3 | 
 4 | import _git from './clui_one_command';
 5 | import { Command, Arg, default as CLUI } from '../clui';
 6 | 
 7 | const git = convert(_git);
 8 | const push: Command = git.children[0] as Command;
 9 | 
10 | const clui = new CLUI();
11 | clui.load(git);
12 | 
13 | // const commands = new Command({name: 'h', type: 'cmd', children: [git]});
14 | 
15 | describe('searcher', () => {
16 | 	it('find a command by name', () => {
17 |     expect(search(clui, 'git')).toEqual([git, push]);
18 | 	});
19 | 	it('find a sub-command by name', () => {
20 |     expect(search(git, 'push')).toEqual([push]);
21 | 	});
22 | 	it('find a command by description', () => {
23 |     expect(search(clui, 'a simple git cli')).toEqual([git]);
24 | 	});
25 | 	it('find a sub-command by description', () => {
26 | 		expect(search(clui, 'local changes')).toEqual([push]);
27 | 	});
28 | 	it('find multiple commands via description', () => {
29 | 		expect(search(clui, '[test]')).toEqual([git, push]);
30 | 	});
31 | 	it('zero matches', () => {
32 | 		expect(search(push, 'local changes')).toEqual([]);
33 | 	});
34 | });


--------------------------------------------------------------------------------
/src/lib/searcher.ts:
--------------------------------------------------------------------------------
 1 | import { Command, Arg, default as clui } from "../clui";
 2 | import Fuse from "fuse.js";
 3 | 
 4 | export interface options {
 5 | 	withPath?: boolean
 6 | }
 7 | 
 8 | export default function(root: Command | clui, query: string, opts?: options) {
 9 | 	const { withPath } = opts || {};
10 | 	let cmd: Command[] | [];
11 | 	if (root instanceof clui && !withPath) return root.fuse.search(query).map(el => el.item);
12 | 	else if (root instanceof clui) cmd = root.commands ?? [];
13 | 	else cmd = root.type === 'cmd' && root.children ? root.children as Command[] : [];
14 | 
15 | 	const flatten = (commands: Command[], path: Command[] = []): Command[] => {
16 | 		let result: Command[] = [];
17 | 		for (let command of commands) {
18 | 			path.push(command);
19 | 			if (withPath) result.push(new Command({...command, path: [...path]}));
20 | 			else result.push(command);
21 | 
22 | 			if (command.type === 'cmd' && command.children) result = result.concat(flatten(command.children as Command[], path));
23 | 			path.pop();
24 | 		}
25 | 		return result;
26 | 	};
27 | 
28 | 	let list = flatten(cmd);
29 | 	const options = {
30 | 		keys: [
31 | 			'name',
32 | 			'description'
33 | 		]
34 | 	};
35 | 	const fuse = new Fuse(list, options);
36 | 	
37 | 	return fuse.search(query).map(el => el.item);
38 | }


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "clui",
 3 |   "version": "1.0.0",
 4 |   "description": "The CLUI is a unified command system for the web",
 5 |   "homepage": "https://github.com/Vandesm14/clui#readme",
 6 |   "bugs": {
 7 |     "url": "https://github.com/Vandesm14/clui/issues"
 8 |   },
 9 |   "repository": {
10 |     "type": "git",
11 |     "url": "git+https://github.com/Vandesm14/clui.git"
12 |   },
13 |   "license": "agpl-3.0",
14 |   "author": "Vandesm14",
15 |   "scripts": {
16 |     "build": "rollup -c",
17 |     "dev": "rollup -c -w",
18 |     "start": "sirv public --no-clear",
19 |     "check": "svelte-check --tsconfig ./tsconfig.json",
20 |     "test": "jest",
21 |     "test:watch": "npm test -- --watch"
22 |   },
23 |   "dependencies": {
24 |     "sirv-cli": "^1.0.0"
25 |   },
26 |   "devDependencies": {
27 |     "@rollup/plugin-commonjs": "^17.0.0",
28 |     "@rollup/plugin-node-resolve": "^11.0.0",
29 |     "@rollup/plugin-typescript": "^8.0.0",
30 |     "@testing-library/jest-dom": "^5.14.1",
31 |     "@testing-library/svelte": "^3.0.3",
32 |     "@tsconfig/svelte": "^2.0.0",
33 |     "@types/jest": "^26.0.24",
34 |     "fuse.js": "^6.4.6",
35 |     "jest": "^26.6.3",
36 |     "rollup": "^2.3.4",
37 |     "rollup-plugin-css-only": "^3.1.0",
38 |     "rollup-plugin-livereload": "^2.0.0",
39 |     "rollup-plugin-svelte": "^7.0.0",
40 |     "rollup-plugin-terser": "^7.0.0",
41 |     "svelte": "^3.0.0",
42 |     "svelte-check": "^2.0.0",
43 |     "svelte-jester": "^1.7.0",
44 |     "svelte-preprocess": "^4.0.0",
45 |     "ts-jest": "^26.5.6",
46 |     "tslib": "^2.0.0",
47 |     "typescript": "^4.0.0"
48 |   }
49 | }
50 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # The CLUI
 2 | <!-- ## Build: [Pre-Alpha](CHANGELOG.md) -->
 3 | 
 4 | ![](clui-cover.png)
 5 | 
 6 | <!-- ### [Demo](https://vandesm14.github.io/clui/) -->
 7 | 
 8 | The CLUI is a unified command system for the web inspired by the project built by [replit](https://docs.replit.com/misc/clui). The CLUI has the speed of a CLI while having the convenience of a UI.
 9 | 
10 | Instead of fumbling through CLI documentation, spend more time running commands by using the CLUI's integrated form system to easily understand and fill out parameters and arguments. Adding a reactive command line to your website is as easy as including a plugin and adding commands!
11 | 
12 | **Open to contributions, just email me at vandesm14@gmail.com, find me on [Discord](https://respdev.com/discord), or open an issue/PR**
13 | 
14 | ## Update (v3)
15 | 
16 | This is the 3rd iteration of the CLUI. It went from a simple vanilla JS & HTML app to now a fully-fledged stateless & functional API!
17 | 
18 | ## Features
19 | 
20 | The CLUI isn’t just a command system, it’s a workflow. It’s time to speed up your tasks with the [Intelligent CLI](#intelligent-cli), [Interactive GUI](#interactive-gui), and [Seamless Integration](#seamless-integration). The CLUI allows you to focus on your work without wasting time reading command docs.
21 | 
22 | ### Intelligent CLI
23 | 
24 | The Intelligent CLI is the best option when it comes to input. Forget steep learning curves, the CLUI can easily work with any skill level with it’s highly customizable behavior.
25 | 
26 | ### Interactive GUI
27 | 
28 | [PLACEHOLDER]
29 | 
30 | ### Seamless Integration
31 | 
32 | No GUI? No problem! Enjoy the functionality of the CLUI using the barebones API! It's now possible integrate the CLUI essentially *anywhere* without relying on HTML DOM.


--------------------------------------------------------------------------------
/src/lib/matcher.ts:
--------------------------------------------------------------------------------
 1 | import { Command, Arg } from '../clui';
 2 | import type * as parser from './parser';
 3 | import clui from '../clui';
 4 | 
 5 | // TODO: create an unknown command and arg type with the unknown property (true)
 6 | export type matcher = (Command | Arg | any)[];
 7 | 
 8 | interface UnknownCommand extends Command {
 9 | 	unknown: true
10 | }
11 | 
12 | interface UnknownArg extends Arg {
13 | 	unknown: true
14 | }
15 | 
16 | export default function(root: Command | clui, tokens: parser.Token[]): matcher {
17 | 	let list = [];
18 | 	if (root instanceof clui) root = new Command({name: 'h', type: 'cmd', children: root.commands ?? []});
19 | 	if (root instanceof Command) { // Is a command
20 | 		let cmd = root as Command;
21 | 		let argIndex;
22 | 		for (let i = 0; i < tokens.length; i++) {
23 | 			let token = tokens[i];
24 | 			if (cmd instanceof Command && cmd.type && 'children' in cmd) { // If command has children
25 | 				if (cmd.type === 'cmd') { // Command has commands
26 | 					const children = cmd.children as Command[];
27 | 					let find = children.find((el: Command | Arg) => el.name === (token.val as string));
28 | 					if (find) {
29 | 						cmd = find;
30 | 						list.push(cmd);
31 | 					} else { // unknown token
32 |             list.push(...tokens.slice(i).map(el => {return {name: el.val, unknown: true}}));
33 |             return list;
34 |           }
35 | 				} else if (cmd.type === 'arg') { // Command has args
36 | 					if (argIndex === undefined) argIndex = i;
37 | 					list.push(new Arg({...(cmd.children[i - argIndex] as Arg), value: token.type === 'opt' || token.val}));
38 | 				}
39 | 			} else {
40 | 				return list;
41 | 			}
42 | 		}
43 | 		return list;
44 | 	} else {
45 | 		throw new Error('Invalid root type (root has to be a Command)');
46 | 	}
47 | }


--------------------------------------------------------------------------------
/rollup.config.js:
--------------------------------------------------------------------------------
 1 | import svelte from 'rollup-plugin-svelte';
 2 | import commonjs from '@rollup/plugin-commonjs';
 3 | import resolve from '@rollup/plugin-node-resolve';
 4 | import livereload from 'rollup-plugin-livereload';
 5 | import { terser } from 'rollup-plugin-terser';
 6 | import sveltePreprocess from 'svelte-preprocess';
 7 | import typescript from '@rollup/plugin-typescript';
 8 | import css from 'rollup-plugin-css-only';
 9 | 
10 | const production = !process.env.ROLLUP_WATCH;
11 | 
12 | function serve() {
13 | 	let server;
14 | 	function toExit() {
15 | 		if (server) server.kill(0);
16 | 	}
17 | 
18 | 	return {
19 | 		writeBundle() {
20 | 			if (server) return;
21 | 			server = require('child_process').spawn('npm', ['run', 'start', '--', '--dev'], {
22 | 				stdio: ['ignore', 'inherit', 'inherit'],
23 | 				shell: true
24 | 			});
25 | 
26 | 			process.on('SIGTERM', toExit);
27 | 			process.on('exit', toExit);
28 | 		}
29 | 	};
30 | }
31 | 
32 | export default {
33 | 	input: 'src/main.ts',
34 | 	output: {
35 | 		sourcemap: true,
36 | 		format: 'iife',
37 | 		name: 'clui',
38 | 		file: 'public/dist/clui.js'
39 | 	},
40 | 	plugins: [
41 | 		svelte({
42 | 			preprocess: sveltePreprocess({ sourceMap: !production }),
43 | 			compilerOptions: { // enable run-time checks when not in production
44 | 				dev: !production,
45 | 				customElement: true
46 | 			},
47 | 		}),
48 | 		// we'll extract any component CSS out into
49 | 		// a separate file - better for performance
50 | 		css({ output: 'clui.css' }),
51 | 		resolve({
52 | 			browser: true,
53 | 			dedupe: ['svelte']
54 | 		}),
55 | 		commonjs(),
56 | 		typescript({
57 | 			sourceMap: !production,
58 | 			inlineSources: !production
59 | 		}),
60 | 		
61 | 		!production && serve(),
62 | 		!production && livereload('public'),
63 | 		production && terser()
64 | 	],
65 | 	watch: {
66 | 		clearScreen: false
67 | 	}
68 | };
69 | 


--------------------------------------------------------------------------------
/src/tests/parser.test.ts:
--------------------------------------------------------------------------------
 1 | import parse from '../lib/parser';
 2 | 
 3 | describe('parser', () => {
 4 | 	it('type cmd', () => {
 5 | 		let out = parse('git');
 6 | 		expect(out).toEqual([​
 7 | 			{type: 'cmd', val: 'git'}
 8 | 		]);
 9 | 	});
10 | 	it('type opt', () => {
11 | 		let out = parse('-f');
12 | 		expect(out).toEqual([​
13 | 			{type: 'opt', val: 'f'}
14 | 		]);
15 | 	});
16 | 	it('type string', () => {
17 | 		let out = parse(`'hello' "hi"`);
18 | 		expect(out).toEqual([​
19 | 			{type: 'string', val: 'hello'},
20 | 			{type: 'string', val: 'hi'}
21 | 		]);
22 | 	});
23 | 	it('type number', () => {
24 | 		let out = parse('123.4 123');
25 | 		expect(out).toEqual([​
26 | 			{type: 'number', val: 123.4},
27 | 			{type: 'number', val: 123}
28 | 		]);
29 | 	});
30 | 
31 | 	it('all tokens', () => {
32 | 		let out = parse('git commit -m "message hi" --amend 123.4');
33 | 		expect(out).toEqual([​
34 | 			{type: 'cmd', val: 'git'},
35 | 			{type: 'cmd', val: 'commit'},
36 | 			{type: 'opt', val: 'm'},
37 | 			{type: 'string', val: 'message hi'},
38 | 			{type: 'opt', val: 'amend'},
39 | 			{type: 'number', val: 123.4}
40 | 		]);
41 | 	});
42 | 
43 | 	describe('cursor output', () => {
44 | 		it('cursor.start', () => {
45 | 			let out = parse('git commit -m "message hi" --amend 123.4', {start: 0});
46 | 			expect(out).toEqual([​
47 | 				{type: 'cmd', val: 'git', cursor: true},
48 | 				{type: 'cmd', val: 'commit', cursor: false},
49 | 				{type: 'opt', val: 'm', cursor: false},
50 | 				{type: 'string', val: 'message hi', cursor: false},
51 | 				{type: 'opt', val: 'amend', cursor: false},
52 | 				{type: 'number', val: 123.4, cursor: false}
53 | 			]);
54 | 		});
55 | 		it('cursor.start and cursor.end', () => {
56 | 			let out = parse('git commit -m "message hi" --amend 123.4', {start: 2, end: 6});
57 | 			expect(out).toEqual([​
58 | 				{type: 'cmd', val: 'git', cursor: true},
59 | 				{type: 'cmd', val: 'commit', cursor: true},
60 | 				{type: 'opt', val: 'm', cursor: false},
61 | 				{type: 'string', val: 'message hi', cursor: false},
62 | 				{type: 'opt', val: 'amend', cursor: false},
63 | 				{type: 'number', val: 123.4, cursor: false}
64 | 			]);
65 | 		});
66 | 		it('cursor.start = 0 and cursor.end', () => {
67 | 			let out = parse('git commit -m "message hi" --amend 123.4', {start: 0, end: 6});
68 | 			expect(out).toEqual([​
69 | 				{type: 'cmd', val: 'git', cursor: true},
70 | 				{type: 'cmd', val: 'commit', cursor: true},
71 | 				{type: 'opt', val: 'm', cursor: false},
72 | 				{type: 'string', val: 'message hi', cursor: false},
73 | 				{type: 'opt', val: 'amend', cursor: false},
74 | 				{type: 'number', val: 123.4, cursor: false}
75 | 			]);
76 | 		});
77 | 	});
78 | });


--------------------------------------------------------------------------------
/src/Old.svelte:
--------------------------------------------------------------------------------
 1 | <!-- <svelte:window on:error={(err)=>new clui.Toast(err.message, 'red')} /> -->
 2 | 	<div class="clui-toasts">
 3 | 		{#each $store.toasts as toast (toast.id)}
 4 | 			<div class="clui-toast clui-toast-{toast.color}" in:fly={{x: 200, duration: 500}} out:slide={{duration: 300}}>{toast.msg}</div>
 5 | 		{/each}
 6 | 	</div>
 7 | 	<div class="clui-cli">
 8 | 		<div class="clui-cli-input">
 9 | 			<img src="icons/cli.png" alt="" class="clui-cli-icon">
10 | 			{#if $store?.tokens}
11 | 				<div class="clui-cli-autocomplete">
12 | 					{$store.tokens.slice(0, $store.depth + $store.argDepth).join(' ')} {' '} {$current?.commands ? clui.filter($value)[selection]?.name ?? '' : ''}
13 | 				</div>
14 | 			{/if}
15 | 			<input type="text" placeholder={''} bind:value={$value} on:input={parse} on:keydown={keydown}>
16 | 			{#if $current?.run}
17 | 				<button class="clui-cli-run" on:click={execute}>{$store.canRun ? 'run' : 'form'}</button>
18 | 			{/if}
19 | 			{#if $value}
20 | 				<button class="clui-cli-run" on:click={clear}>x</button>
21 | 			{/if}
22 | 		</div>
23 | 		<div class="clui-cli-dropdown">
24 | 			{#if $current?.commands}
25 | 				{#each clui.filter($value) as command, i}
26 | 					{#if $store.divider > 0 && i === $store.divider}
27 | 						<hr>
28 | 					{/if}
29 | 					<div class="clui-dropdown-item {i === selection ? 'clui-selected' : ''}"	on:click={()=>clui.select(command.name)} on:mouseover={()=>hover(i)}>
30 | 						{#if typeof command.name !== 'number'}
31 | 							<span class="clui-dropdown-name">{command.name}</span>
32 | 						{/if}
33 | 						<span class="clui-dropdown-description">{command.desc}</span>
34 | 					</div>
35 | 				{/each}
36 | 			{:else if $current?.args}
37 | 				{#each clui.filter($value) as argument, i}
38 | 					{#if $store.divider > 0 && i === $store.divider}
39 | 						<hr>
40 | 					{/if}
41 | 					<div class="clui-dropdown-item {i === selection ? 'clui-selected' : ''}" on:mouseover={()=>hover(i)} on:click={()=>clui.select(argument.name)}>
42 | 						<span class="clui-dropdown-name">{(argument.short ? argument.short + ', ' : '') + argument.name + (argument.required ? '*' : '')}</span>
43 | 						<span class="clui-dropdown-description">{argument?.desc}</span>
44 | 					</div>
45 | 				{/each}
46 | 			{/if}
47 | 		</div>
48 | 		<div class="clui-pages">
49 | 			{#each $store.pages as page, i (page.id)}
50 | 				<div class="clui-page-container" in:slide={{duration: 200}} out:slide={{duration: 200}}>
51 | 					<div class="clui-page-buttons">
52 | 						<button on:click={page.rerun()}>Rr</button>
53 | 						<button on:click={page.reset()}>R</button>
54 | 						<button on:click={page.close()}>X</button>
55 | 					</div>
56 | 					<div class="clui-page">
57 | 						{#each $store.pages[i].items as item}
58 | 							<Item arg={item} />
59 | 						{/each}
60 | 					</div>
61 | 				</div>
62 | 			{/each}
63 | 		</div>
64 | 	</div>


--------------------------------------------------------------------------------
/src/lib/parser.ts:
--------------------------------------------------------------------------------
 1 | export type Token = TokenOther | TokenNumber | TokenBoolean;
 2 | 
 3 | interface TokenBase {
 4 | 	type: any,
 5 | 	val: any,
 6 | 	cursor?: boolean
 7 | }
 8 | 
 9 | interface TokenOther extends TokenBase {
10 |   type: "cmd" | "opt" | "string";
11 |   val: string;
12 | }
13 | 
14 | interface TokenNumber extends TokenBase {
15 |   type: "number";
16 |   val: number;
17 | }
18 | 
19 | interface TokenBoolean extends TokenBase {
20 |   type: "boolean";
21 |   val: boolean;
22 | }
23 | 
24 | class Tokens extends Array {
25 | 	
26 | }
27 | 
28 | function parse(input: string, cursor?: {start: number, end?: number}) {
29 | 	const tokens: Token[] = new Tokens();
30 | 	let i = 0;
31 | 
32 | 	const peek = () => input.charAt(i);
33 | 	const next = () => input.charAt(i++);
34 | 	const eof = () => peek() === "";
35 | 	const croak = (err: Error) => { throw err; };
36 | 
37 | 	const isId = (ch: string) => /[a-z_]/i.test(ch);
38 | 	const isFlag = (ch: string) => "-".indexOf(ch) >= 0;
39 | 
40 | 	const isBool = (word: string) => ['true', 'false'].includes(word);
41 | 	const isStr = (ch: string) => `"'`.indexOf(ch) >= 0;
42 | 	const isNum = (ch: string) => /[0-9]/.test(ch);
43 | 
44 | 	const add = (token: Token, i: number) => {
45 | 		const {type, val} = {...token};
46 | 		if (cursor && cursor.start !== undefined) {
47 | 			if (cursor.end === undefined) cursor.end = cursor.start;
48 | 			// @ts-expect-error
49 | 			tokens.push({type, val, cursor: i - val.length <= cursor.end && i >= cursor.start});
50 | 		} else {
51 | 			// @ts-expect-error
52 | 			tokens.push({type, val});
53 | 		}
54 | 	}
55 | 
56 | 	const take = (fn: (ch: string) => boolean) => {
57 | 		let token = "";
58 | 		while(!eof() && fn(peek())) token += next();
59 | 		return token;
60 | 	};
61 | 
62 | 	while(!eof()) {
63 | 		const ch = next();
64 | 		if(ch === " ") continue;
65 | 
66 | 		if(isId(ch)) { // ids (git, merge)
67 | 			const id = ch + take(isId);
68 | 
69 | 			if(isBool(id)) add({ type: "boolean", val: Boolean(id) }, i); // e.g. true, false
70 | 			else add({ type: "cmd", val: id }, i); // e.g. git, merge
71 | 		}	else if(isFlag(ch)) { // flags (-f, --flag)
72 | 			const flag = ch + take(isFlag);
73 | 
74 | 			if(flag.length === 1) add({ type: "opt", val: next() }, i); // e.g. -f
75 | 			else if(flag.length === 2) add({ type: "opt", val: take(isId) }, i); // e.g. --flag
76 | 			else croak(Error(`too many recurring "-" in flag`)); // error
77 | 		}	else if(isStr(ch)) { // str ("hello, world!")
78 | 			add({ type: "string", val: take(val => val !== ch) }, i);
79 | 			next();
80 | 		}	else if(isNum(ch)) { // num (1234, 12.34)
81 | 			let decimal = false;
82 | 			const num = ch + take(val => {
83 | 				if(val === ".") {
84 | 					if(decimal) croak(Error(`too many recurring "." in number`));
85 | 					decimal = true;
86 | 					return true;
87 | 				}
88 | 				return isNum(val);
89 | 			});
90 | 			add({ type: "number", val: Number(num) }, i);
91 | 		}
92 | 	}
93 | 
94 | 	return tokens;
95 | }
96 | 
97 | export default parse;


--------------------------------------------------------------------------------
/src/lib/runner.ts:
--------------------------------------------------------------------------------
 1 | import { Command, Arg, default as CLUI } from '../clui';
 2 | import parse from './parser';
 3 | import match from './matcher';
 4 | 
 5 | export function checkRun(root: CLUI | Command, tokens: (Command | Arg)[] | string, internal?: boolean): boolean;
 6 | export function checkRun(root: CLUI | Command, tokens: (Command | Arg)[] | string, internal: true): [boolean, Command?, Arg[]?];
 7 | 
 8 | export function checkRun(root: CLUI | Command, tokens: (Command | Arg)[] | string, internal = false): any {
 9 | 	if (typeof tokens === 'string') tokens = match(root, parse(tokens));
10 | 	if (root instanceof CLUI) root = new Command({name: 'h', type: 'cmd', children: root.commands ?? []});
11 | 
12 | 	let allRequired = false;
13 | 	let command = undefined;
14 | 	let args = undefined;
15 | 
16 | 	if (tokens[0] instanceof Command || root instanceof Command) { // if token is a command
17 | 		let commands = tokens.filter(el => el instanceof Command);
18 | 		command = commands.length > 0  ? commands[commands.length - 1] as Command : root;
19 | 		args = tokens.filter(el => el instanceof Arg) as Arg[];
20 | 
21 | 		if (command) {
22 | 			allRequired = 'run' in command;
23 | 			if (command.type === 'arg' && command.children !== undefined) {
24 | 				let required = (command.children as Arg[]).filter((el: Arg) => el.required).length;
25 | 				allRequired = required === args.filter((el: Arg) => el.required).length;
26 | 			}
27 | 		}
28 | 	}
29 | 
30 | 	if (!internal) return allRequired;
31 | 	else return [allRequired, command, args];
32 | };
33 | 
34 | export interface OutputItem {
35 | 	type: 'string' | 'string_long' | 'number' | 'boolean' | 'enum' | 'button' | 'paragraph' | 'table',
36 | 	name: string,
37 | 	description?: string,
38 | 	value?: any,
39 | 	run?: () => void,
40 | }
41 | 
42 | export class Request {
43 | 	args: Arg[];
44 | 	clui: CLUI;
45 | 	command: Command;
46 | 
47 | 	constructor(args: Arg[], clui: CLUI, command: Command) {
48 | 		this.args = args;
49 | 		this.clui = clui;
50 | 		this.command = command;
51 | 	}
52 | }
53 | 
54 | export class Response {
55 | 	out: (items: OutputItem[]) => void;
56 | 	status: (status: 'ok' | 'err' | string) => void;
57 | 
58 | 	constructor(out: Response['out'], status: Response['status']) {
59 | 		this.out = out;
60 | 		this.status = status;
61 | 	}
62 | }
63 | 
64 | export default function run(clui: CLUI, root: CLUI | Command, tokens: (Command | Arg)[] | string) {
65 | 	const [canRun, command, args] = checkRun(root, tokens, true);
66 | 
67 | 	return new Promise<{success: boolean, output: any}>((resolve, reject) => {
68 | 		if (!command) resolve({success: false, output: 'Error: Missing command'});
69 | 		if (!canRun) resolve({success: false, output: 'Error: Missing required arguments'});
70 | 
71 | 		const req = new Request(args, clui, command);
72 | 		const res = new Response(console.log, console.log);
73 | 
74 | 		if (command.run) {
75 | 			command.run(req, res);
76 | 			resolve({success: true, output: 'ok'});
77 | 		}
78 | 		else resolve({success: false, output: 'Error: Command has no run function'});
79 | 	});
80 | };


--------------------------------------------------------------------------------
/src/tests/matcher.test.ts:
--------------------------------------------------------------------------------
 1 | import convert from '../lib/converter';
 2 | 
 3 | import _git from './clui_one_command';
 4 | import { Command, Arg, default as CLUI } from '../clui';
 5 | 
 6 | const git = convert(_git);
 7 | const push: Command = git.children[0] as Command;
 8 | 
 9 | const clui = new CLUI();
10 | clui.load(git);
11 | 
12 | describe('matcher', () => {
13 | 	it('match a command', () => {
14 | 		expect(clui.match(clui, [
15 | 			{type: 'cmd', val: 'git'}
16 | 		])).toEqual([git]);
17 | 	});
18 | 	it('match a sub-command', () => {
19 | 		expect(clui.match(clui, [
20 | 			{type: 'cmd', val: 'git'},
21 | 			{type: 'cmd', val: 'push'}
22 | 		])).toEqual([git, push]);
23 | 	});
24 | 	it('match all tokens (cmd | arg)', () => {
25 | 		expect(clui.match(clui, [
26 | 			{type: 'cmd', val: 'git'},
27 | 			{type: 'cmd', val: 'push'},
28 | 			{type: 'cmd', val: 'origin'}
29 | 		])).toEqual([
30 | 			git,
31 | 			push,
32 | 			{ ...push.children[0], value: 'origin' },
33 | 		]);
34 | 		expect(clui.match(clui, [
35 | 			{type: 'cmd', val: 'git'},
36 | 			{type: 'cmd', val: 'push'},
37 | 			{type: 'cmd', val: 'origin'},
38 | 			{type: 'cmd', val: 'master'}
39 | 		])).toEqual([
40 | 			git,
41 | 			push,
42 | 			{ ...push.children[0], value: 'origin' },
43 | 			{ ...push.children[1], value: 'master' },
44 | 		]);
45 | 		expect(clui.match(clui, [
46 | 			{type: 'cmd', val: 'git'},
47 | 			{type: 'cmd', val: 'push'},
48 | 			{type: 'cmd', val: 'origin'},
49 | 			{type: 'cmd', val: 'master'},
50 | 			{type: 'opt', val: 'f'},
51 | 		])).toEqual([
52 | 			git,
53 | 			push,
54 | 			{ ...push.children[0], value: 'origin' },
55 | 			{ ...push.children[1], value: 'master' },
56 | 			{ ...push.children[2], value: true },
57 | 		]);
58 | 	});
59 | 	it('match & return unknown tokens', () => {
60 | 		expect(clui.match(clui, [
61 | 			{type: 'cmd', val: 'git'},
62 | 			{type: 'cmd', val: 'hello'},
63 | 			{type: 'cmd', val: 'origin'},
64 | 			{type: 'cmd', val: 'master'},
65 | 			{type: 'opt', val: 'f'},
66 | 		])).toEqual([
67 | 			git,
68 | 			{ name: 'hello', unknown: true },
69 | 			{ name: 'origin', unknown: true },
70 | 			{ name: 'master', unknown: true },
71 | 			{ name: 'f', unknown: true },
72 | 		]);
73 | 	});
74 | 	it('match tokens with custom root element', () => {
75 | 		expect(clui.match(new Command(git), [
76 | 			{type: 'cmd', val: 'push'},
77 | 			{type: 'cmd', val: 'origin'}
78 | 		])).toEqual([
79 | 			push,
80 | 			{ ...push.children[0], value: 'origin' },
81 | 		]);
82 | 		expect(clui.match(new Command(push), [
83 | 			{type: 'cmd', val: 'origin'},
84 | 			{type: 'cmd', val: 'master'}
85 | 		])).toEqual([
86 | 			{ ...push.children[0], value: 'origin' },
87 | 			{ ...push.children[1], value: 'master' },
88 | 		]);
89 | 	});
90 | 	it('invalid root type', () => {
91 | 		// @ts-expect-error
92 | 		expect(() => clui.match({}, clui.parse(''))).toThrow('Invalid root type (root has to be a Command)');
93 | 	});
94 | 	it('command.children is undefined', () => {
95 | 		// @ts-expect-error
96 | 		expect(clui.match(new Command({}), clui.parse('git push origin master'))).toEqual([]);
97 | 	});
98 | });


--------------------------------------------------------------------------------
/src/tests/clui.test.ts:
--------------------------------------------------------------------------------
 1 | import path from 'path';
 2 | import convert from '../lib/converter';
 3 | 
 4 | import _git from './clui_one_command';
 5 | import _many from './clui_many_commands';
 6 | import { Command, Arg, default as CLUI } from '../clui';
 7 | import type * as types from '../clui';
 8 | 
 9 | const git = convert(_git);
10 | const many = _many.map(el => convert(el));
11 | 
12 | let clui: CLUI;
13 | 
14 | beforeEach(() => {
15 | 	clui = new CLUI(); // reset the CLUI instance
16 | });
17 | 
18 | describe('clui', () => {
19 | 	describe('load', () => {
20 | 		it('load one command', () => {
21 | 			clui.load(git);
22 | 			
23 | 			expect(clui.commands.find(el => el.name === git.name)).toEqual(git);
24 | 			expect(clui.commands[0]).toEqual(git);
25 | 		});
26 | 		it('load multiple commands', () => {
27 | 			clui.load(...many);
28 | 
29 | 			many.forEach(command => {
30 | 				expect(clui.commands.find(el => el.name === command.name)).toEqual(command);
31 | 			});
32 | 			expect(clui.commands).toEqual(many);
33 | 		});
34 | 		it('load a command via URL', async () => {
35 | 			await clui.loadURL(path.resolve(__dirname, './clui_one_command'));
36 | 
37 | 			expect(clui.commands.find(el => el.name === git.name)).toEqual(git);
38 | 			expect(clui.commands[0]).toEqual(git);
39 | 		});
40 | 		it('load multiple commands via URL', async () => {
41 | 			await clui.loadURL(path.resolve(__dirname, './clui_many_commands'));
42 | 
43 | 			many.forEach(command => {
44 | 				expect(clui.commands.find(el => el.name === command.name)).toEqual(command);
45 | 			});
46 | 			expect(clui.commands).toEqual(many);
47 | 		});
48 | 	});
49 | 
50 | 	describe('getLastCommand', () => {
51 | 		it('get last command', () => {
52 | 			clui.load(git);
53 | 
54 | 			expect(clui.getLastCommand([clui.commands[0]])).toEqual(git);
55 | 		});
56 | 		it('get last sub-command', () => {
57 | 			clui.load(git);
58 | 			let push = clui.commands[0].children[0];
59 | 
60 | 			expect(clui.getLastCommand([clui.commands[0], push])).toEqual(push);
61 | 		});
62 | 		it('get last sub-command with commands and args as input', () => {
63 | 			clui.load(git);
64 | 			let push = clui.commands[0].children[0] as Command;
65 | 			let args = push.children as Arg[];
66 | 
67 | 			expect(clui.getLastCommand([clui.commands[0], push, ...args])).toEqual(push);
68 | 		});
69 | 	});
70 | 
71 | 	describe('stateful', () => {
72 |     let stateful: types.stateful;
73 | 
74 | 		beforeEach(() => {
75 | 			clui.load(git);
76 | 			stateful = clui.stateful();
77 | 		});
78 | 
79 | 		it('parse', () => {
80 | 			expect(stateful.parse('git')).toEqual([{type: 'cmd', val: 'git'}]);
81 | 		});
82 | 		it('match', () => {
83 | 			expect(stateful.match(stateful.parse('git'))).toEqual([git]);
84 | 		});
85 | 		it('run', async () => {
86 | 			const result = await stateful.run([
87 | 				new Command(git),
88 | 				new Command(git.children[0] as Command)]);
89 | 			expect(result.success).toBe(false);
90 | 			expect(result.output).toBe('Error: Missing required arguments');
91 | 		});
92 | 		it('search', () => {
93 | 			expect(stateful.search('a simple git')).toEqual([git]);
94 | 		});
95 | 	});
96 | });


--------------------------------------------------------------------------------
/src/commands.ts:
--------------------------------------------------------------------------------
  1 | import type { Command, Arg } from './clui';
  2 | import type { Request, Response } from './lib/runner';
  3 | import clui_many_commands from './tests/clui_many_commands';
  4 | 
  5 | const system: Command = {
  6 | 	name: 'clui',
  7 | 	description: 'the main system (so meta)',
  8 | 	type: 'cmd',
  9 | 	children: [
 10 | 		{
 11 | 			name: 'version',
 12 | 			description: 'show the version',
 13 | 			run: (req: Request, res: Response) => {
 14 | 				res.out([
 15 | 					{
 16 | 						name: 'Version',
 17 | 						type: 'paragraph',
 18 | 						value: `CLUI version ${req.clui.version}`,
 19 | 					},
 20 | 				]);
 21 | 				res.status('ok');
 22 | 			}
 23 | 		},
 24 | 		{
 25 | 			name: 'debug',
 26 | 			description: 'debugging',
 27 | 			type: 'cmd',
 28 | 			children: [
 29 | 				{
 30 | 					name: 'log',
 31 | 					description: 'logging',
 32 | 				}
 33 | 			]
 34 | 		},
 35 | 		{
 36 | 			name: 'help',
 37 | 			description: 'get help with the CLUI',
 38 | 			type: 'arg',
 39 | 			children: [
 40 | 				{
 41 | 					name: 'command',
 42 | 					description: 'the command to get help with',
 43 | 					type: 'string'
 44 | 				}
 45 | 			],
 46 | 			run: (req: Request, res: Response) => {
 47 | 				const command = req.args[0];
 48 | 				if (command) {
 49 | 					const query = req.clui.search(req.clui, command.value, {withPath: true});
 50 | 					if (query.length) {
 51 | 						const first = query[0];
 52 | 						res.out([
 53 | 								{
 54 | 								name: first.name,
 55 | 								type: 'paragraph',
 56 | 								value: `Description: ${first.description}\n`+
 57 | 								`Children: ${first.type} (${first.children?.length})\n`+
 58 | 								`Path: ${first.path.map(el => el.name).join(' > ')}`
 59 | 							},
 60 | 							{
 61 | 								name: 'Arguments',
 62 | 								type: 'table',
 63 | 								value: first.children?.map(el => ({
 64 | 									name: el.name,
 65 | 									type: el.type,
 66 | 									description: el.description
 67 | 								}))
 68 | 							},
 69 | 							{
 70 | 								name: 'Run',
 71 | 								type: 'button',
 72 | 								value: 'Run',
 73 | 								run: () => {
 74 | 									req.clui.run(req.clui, [first]);
 75 | 								}
 76 | 							}
 77 | 						]);
 78 | 						res.status('ok');
 79 | 					} else {
 80 | 						res.out([{
 81 | 							name: 'Error',
 82 | 							type: 'paragraph',
 83 | 							value: `No command found for "${command.value}"`
 84 | 						}]);
 85 | 						res.status('error');
 86 | 					}
 87 | 				} else {
 88 | 					res.out([{
 89 | 						name: 'CLUI',
 90 | 						type: 'paragraph',
 91 | 						value: 'The CLUI is a unified command system for the web',
 92 | 					}]);
 93 | 					res.status('ok');
 94 | 				}
 95 | 			}
 96 | 		},
 97 | 		{
 98 | 			name: 'config',
 99 | 			description: 'configure the CLUI',
100 | 			type: 'arg',
101 | 			children: [
102 | 				{
103 | 					name: 'option',
104 | 					description: 'the option to configure',
105 | 					type: 'string',
106 | 					required: true
107 | 				},
108 | 				{
109 | 					name: 'value',
110 | 					description: 'the value to set',
111 | 					type: 'string',
112 | 					required: true
113 | 				}
114 | 			]
115 | 		}
116 | 	]
117 | };
118 | 
119 | const commands: Command[] = [
120 | 	system
121 | ];
122 | 
123 | export default commands;


--------------------------------------------------------------------------------
/src/old.css:
--------------------------------------------------------------------------------
  1 | 
  2 | .clui-toasts {
  3 | 	position: absolute;
  4 | 	right: 0;
  5 | 	bottom: 0;
  6 | 	display: flex;
  7 | 	overflow: hidden;
  8 | 	flex-direction: column;
  9 | }
 10 | .clui-toast {
 11 | 	margin: 0.6rem 1.2rem;
 12 | 	padding: 0.6rem 1.2rem;
 13 | 	max-width: 30ch;
 14 | 	border-radius: 3px;
 15 | 	background-color: hsl(225, 35%, 36%);
 16 | 	color: var(--text-light);
 17 | }
 18 | .clui-toast-red {
 19 | 	background-color: hsl(0, 54%, 40%);
 20 | }
 21 | .clui-toast-yellow {
 22 | 	background-color: hsl(50, 54%, 40%);
 23 | }
 24 | .clui-toast-green {
 25 | 	background-color: hsl(100, 54%, 40%);
 26 | }
 27 | .clui-cli {
 28 | 	display: flex;
 29 | 	flex-direction: column;
 30 | 	margin: 4vh auto;
 31 | 	width: max-content;
 32 | }
 33 | .clui-cli-input {
 34 | 	position: relative;
 35 | 	display: flex;
 36 | 	align-items: center;
 37 | 	border: 2px solid var(--medium);
 38 | 	border-radius: 3px 3px 0 0;
 39 | 	background-color: var(--dark);
 40 | }
 41 | .clui-cli-input > .clui-cli-icon {
 42 | 	width: 1.6rem;
 43 | }
 44 | .clui-cli-input > .clui-cli-autocomplete {
 45 | 	position: absolute;
 46 | 	left: 1.8rem;
 47 | 	z-index: 1;
 48 | 	padding: 0 0.2rem;
 49 | 	border-radius: 2px;
 50 | 	background-color: var(--light);
 51 | }
 52 | .clui-cli-input > input {
 53 | 	position: relative;
 54 | 	z-index: 1;
 55 | 	flex: 1;
 56 | 	padding: 0.6rem 0.4rem;
 57 | 	outline: none;
 58 | 	border: none;
 59 | 	background-color: transparent;
 60 | 	color: var(--text-light);
 61 | 	font-size: inherit;
 62 | 	font-family: Calibri, sans-serif;
 63 | }
 64 | .clui-cli-input > input::placeholder {
 65 | 	color: var(--text-medium);
 66 | }
 67 | .clui-cli-run {
 68 | 	margin: 0 0.4rem;
 69 | 	padding: 0 0.2rem;
 70 | 	outline: 2px solid var(--light);
 71 | 	border: none;
 72 | 	border-radius: 2px;
 73 | 	background-color: transparent;
 74 | 	color: var(--text-medium);
 75 | 	font: inherit;
 76 | 	cursor: pointer;
 77 | }
 78 | .clui-cli-run:hover {
 79 | 	background-color: var(--light);
 80 | 	color: var(--text-light);
 81 | }
 82 | .clui-cli-dropdown {
 83 | 	overflow-y: auto;
 84 | 	min-width: 40vw;
 85 | 	max-width: 60vw;
 86 | 	max-height: 40vh;
 87 | 	border-radius: 0 0 3px 3px;
 88 | 	background-color: var(--darker);
 89 | }
 90 | .clui-cli-dropdown > hr {
 91 | 	margin: 0.4rem 0.2rem;
 92 | 	color: var(--light);
 93 | }
 94 | .clui-dropdown-item {
 95 | 	position: relative;
 96 | 	z-index: 1;
 97 | 	padding: 0.6rem 1.2rem;
 98 | 	padding-left: 2.2rem;
 99 | 	border-radius: 3px;
100 | 	background-color: var(--darker);
101 | }
102 | .clui-dropdown-item.clui-selected {
103 | 	outline: 2px solid var(--light);
104 | 	outline-offset: -2px;
105 | 	background-color: var(--light);
106 | 	background-color: var(--medium);
107 | 	color: var(--text-light);
108 | 	cursor: pointer;
109 | }
110 | .clui-dropdown-name {
111 | 	margin-right: 0.3rem;
112 | 	margin-left: -0.5rem;
113 | 	padding: 0.3rem 0.5rem;
114 | 	border: 2px solid var(--light);
115 | 	border-radius: 3px;
116 | }
117 | .clui-selected > .clui-dropdown-name {
118 | 	background-color: var(--light);
119 | }
120 | .clui-pages {
121 | 	display: flex;
122 | 	flex-direction: column;
123 | 	margin: 4vh auto;
124 | 	min-width: 40vw;
125 | 	max-width: 60vw;
126 | }
127 | .clui-page-container {
128 | 	margin: 0.8rem 0;
129 | }
130 | .clui-page-buttons {
131 | 	display: flex;
132 | 	flex-direction: row;
133 | 	justify-content: flex-end;
134 | }
135 | .clui-page-buttons > button {
136 | 	padding: 0.3rem 0.5rem;
137 | 	border: 2px solid var(--medium);
138 | 	border-radius: 3px;
139 | 	background-color: transparent;
140 | 	color: var(--text-medium);
141 | 	cursor: pointer;
142 | }
143 | .clui-page-buttons > button:hover {
144 | 	border: 2px solid var(--light);
145 | 	background-color: var(--light);
146 | 	color: var(--text-light);
147 | }
148 | .clui-page {
149 | 	display: flex;
150 | 	overflow-y: auto;
151 | 	flex-direction: column;
152 | 	margin: 0.2rem 0;
153 | 	padding: 0.6rem 1.2rem;
154 | 	max-height: 70vh;
155 | 	width: 100%;
156 | 	border: 2px solid var(--medium);
157 | 	border-radius: 3px;
158 | 	background-color: var(--darker);
159 | }
160 | #clui .clui-page > div {
161 | 	padding: 0.4rem 0;
162 | }


--------------------------------------------------------------------------------
/src/clui.ts:
--------------------------------------------------------------------------------
  1 | import convert from './lib/converter';
  2 | import parse from './lib/parser';
  3 | import match from './lib/matcher';
  4 | import { default as run, checkRun } from './lib/runner';
  5 | import search from './lib/searcher';
  6 | 
  7 | import Fuse from 'fuse.js';
  8 | 
  9 | import type * as parser from './lib/parser';
 10 | import type * as searcher from './lib/searcher';
 11 | import type * as matcher from './lib/matcher';
 12 | import type * as runner from './lib/runner';
 13 | 
 14 | export interface Command {
 15 | 	name: string,
 16 | 	description?: string,
 17 | 
 18 | 	type?: 'cmd' | 'arg',
 19 | 	children?: Command[] | Arg[],
 20 | 
 21 | 	/** tells the runner if a command is interactive (ie: will use the res to output multiple times) */
 22 | 	interactive?: boolean,
 23 | 	run?: (req: runner.Request, res: runner.Response) => void,
 24 | 
 25 | 	/** set by the matcher to define unknown tokens */
 26 | 	unknown?: boolean,
 27 | 	
 28 | 	/** set by the searcher to define the path to the command */
 29 | 	path?: Command[]
 30 | }
 31 | 
 32 | export class Command {
 33 | 	constructor(obj: Command, recursive = true) {
 34 | 		if (recursive) obj = convert(obj);
 35 | 		Object.keys(obj).forEach(key => {
 36 | 			// @ts-ignore
 37 | 			this[key] = obj[key];
 38 | 		});
 39 | 	}
 40 | }
 41 | 
 42 | export interface Arg {
 43 | 	name: string,
 44 | 	description?: string,
 45 | 	type: 'string' | 'number' | 'boolean',
 46 | 
 47 | 	/** arg: a parameter (ls __~/Desktop__), opt: an option (__-a__ or __--flag param__) */
 48 | 	mode?: 'arg' | 'opt',
 49 | 	required?: boolean,
 50 | 
 51 | 	/** set by the matcher to define unknown tokens */
 52 | 	unknown?: boolean,
 53 | 
 54 | 	/** used by the runner to define the value of the arg */
 55 | 	value?: any
 56 | }
 57 | 
 58 | export class Arg {
 59 | 	constructor(obj: Arg) {
 60 | 		this.name = obj.name;
 61 | 		this.description = obj.description;
 62 | 		this.type = obj.type;
 63 | 		this.mode = obj.mode;
 64 | 		this.required = obj.required;
 65 | 		this.unknown = obj.unknown;
 66 | 		this.value = obj.value;
 67 | 	}
 68 | }
 69 | 
 70 | export interface stateful {
 71 |   parse: typeof parse,
 72 |   match: (tokens: parser.Token[]) => matcher.matcher,
 73 |   run: (tokens: (Command | Arg)[]) => any,
 74 |   search: (query: string, opts?: searcher.options) => any
 75 | }
 76 | 
 77 | export default class CLUI {
 78 | 	parse = parse;
 79 | 	match = match;
 80 | 	search = search;
 81 | 	checkRun = checkRun;
 82 | 	run = (root: CLUI | Command, tokens: (Command | Arg)[] | string) => run(this, root, tokens);
 83 | 	parseMatch = (str: string, root?: Command | CLUI, cursor?: {start: number, end?: number}) => match(root ?? this, parse(str, cursor));
 84 | 
 85 | 	commands: Command[] = [];
 86 | 	fuse = new Fuse(this.commands);
 87 | 
 88 | 	// version = require('../package.json').version; 
 89 | 	version = '0.0.1'; // TODO: figure out a way to get the version from the package.json
 90 | 
 91 | 	load(...commands: Command[]) {
 92 | 		for (let command of commands) {
 93 | 			this.commands.push(new Command(command));
 94 | 		}
 95 | 		this.updateFuse();
 96 | 	}
 97 | 
 98 | 	async loadURL(url: string) {
 99 | 		const result = (await import(url)).default;
100 | 		if (Array.isArray(result)) {
101 | 			for (let command of result) {
102 | 				this.commands.push(command);
103 | 			}
104 | 		} else {
105 | 			this.commands.push(result);
106 | 		}
107 | 		this.updateFuse();
108 | 	}
109 | 
110 | 	getLastCommand(tokens: (Command | Arg)[]): Command | undefined {
111 | 		for (let i = tokens.length - 1; i >= 0; i--) {
112 | 			if (tokens[i] instanceof Command) return tokens[i] as Command;
113 | 		}
114 | 		return undefined;
115 | 	}
116 | 
117 | 	updateFuse() {
118 | 		const flatten = (commands: Command[]): Command[] => {
119 | 			let result: Command[] = [];
120 | 			for (let command of commands) {
121 | 				result.push(command);
122 | 				if (command.type === 'cmd' && command.children) result = result.concat(flatten(command.children as Command[]));
123 | 			}
124 | 			return result;
125 | 		};
126 | 	
127 | 		let list = flatten(this.commands);
128 | 		const options = {
129 | 			keys: [
130 | 				'name',
131 | 				'description'
132 | 			]
133 | 		};
134 | 		this.fuse = new Fuse(list, options);
135 | 	}
136 | 
137 | 	stateful(root?: Command): stateful {
138 | 		if (root === undefined) root = new Command({name: 'h', type: 'cmd', children: this.commands ?? []});
139 | 		return {
140 | 			parse,
141 | 			match: (tokens: parser.Token[]) => match((root as Command), tokens),
142 | 			run: (tokens: (Command | Arg)[] | string) => run(this, (root as Command), tokens),
143 | 			search: (query: string, opts?: searcher.options) => search((root as Command), query, opts)
144 | 		};
145 | 	}
146 | };


--------------------------------------------------------------------------------
/src/tests/runner.test.ts:
--------------------------------------------------------------------------------
  1 | import convert from '../lib/converter';
  2 | // import { default as run, checkRun } from '../lib/runner';
  3 | 
  4 | import _git from './clui_one_command';
  5 | import { Command, Arg, default as CLUI } from '../clui';
  6 | import { checkRun } from '../lib/runner';
  7 | 
  8 | const git = convert(_git);
  9 | const push: Push = git.children[0] as Push;
 10 | 
 11 | interface Push extends Command {
 12 |   type: 'arg',
 13 |   children: Arg[];
 14 | }
 15 | 
 16 | const clui = new CLUI();
 17 | clui.load(git);
 18 | 
 19 | const run = clui.run;
 20 | 
 21 | describe('checkRun', () => {
 22 | 	it('valid command and args', () => {
 23 | 		expect(checkRun(clui, [
 24 |       git,
 25 |       push,
 26 |       new Arg({...push.children[0], value: 'origin'}),
 27 |       new Arg({...push.children[1], value: 'master'})
 28 | 		])).toBe(true);
 29 | 	});
 30 | 	it('valid command', () => {
 31 | 		expect(checkRun(clui, [git, push])).toBe(false);
 32 | 	});
 33 | 	it('no run function', () => {
 34 | 		expect(checkRun(clui, [git])).toBe(false);
 35 | 	});
 36 | });
 37 | 
 38 | describe('runner', () => {
 39 | 	it('run a command by itself', async () => {
 40 |     const result = await run(clui, [git, push]);
 41 |     expect(result.success).toBe(false);
 42 | 		expect(result.output).toBe('Error: Missing required arguments');
 43 | 	});
 44 | 	it('run a command with one required arg', async () => {
 45 |     const result = await run(clui, [
 46 |       git,
 47 |       push,
 48 |       new Arg({...push.children[0], value: 'origin'})
 49 | 		]);
 50 |     expect(result.success).toBe(false);
 51 | 		expect(result.output).toBe('Error: Missing required arguments');
 52 | 	});
 53 | 	it('run a command with one required arg and flag', async () => {
 54 |     const result = await run(clui, [
 55 |       git,
 56 |       push,
 57 |       new Arg({...push.children[0], value: 'origin'}),
 58 |       new Arg({...push.children[2], value: true})]);
 59 |     expect(result.success).toBe(false);
 60 | 		expect(result.output).toBe('Error: Missing required arguments');
 61 | 	});
 62 | 	it('run a command with all required args', async () => {
 63 |     const result = await run(clui, [
 64 |       git,
 65 |       push,
 66 |       new Arg({...push.children[0], value: 'origin'}),
 67 |       new Arg({...push.children[1], value: 'master'})]);
 68 |     expect(result.success).toBe(true);
 69 |   });
 70 | 	it('run a command with all required args and flag', async () => {
 71 |     const result = await run(clui, [
 72 |       git,
 73 |       push,
 74 |       new Arg({...push.children[0], value: 'origin'}),
 75 |       new Arg({...push.children[1], value: 'master'}),
 76 |       new Arg({...push.children[2], value: true})]);
 77 |     expect(result.success).toBe(true);
 78 |   });
 79 | 	it('run with an array of arguments', async () => {
 80 |     // @ts-expect-error
 81 | 		const result = await run(push.children, []);
 82 | 		expect(result.success).toBe(false);
 83 | 		expect(result.output).toBe('Error: Missing command');
 84 | 	});
 85 | 	it('run with an object', async () => {
 86 | 		// @ts-expect-error
 87 | 		const result = await run({}, []);
 88 | 		expect(result.success).toBe(false);
 89 | 		expect(result.output).toBe('Error: Missing command');
 90 | 	});
 91 | 
 92 | 	describe('string as input', () => {
 93 | 		it('run a command with clui as the root', async () => {
 94 | 			const result = await run(clui, 'git push');
 95 | 			expect(result.success).toBe(false);
 96 | 			expect(result.output).toBe('Error: Missing required arguments');
 97 | 		});
 98 | 		it('run a command with by itself', async () => {
 99 | 			const result = await run(git, 'push');
100 | 			expect(result.success).toBe(false);
101 | 			expect(result.output).toBe('Error: Missing required arguments');
102 | 		});
103 | 		it('run a command with the command as the root', async () => {
104 | 			const result = await run(git, 'push origin');
105 | 			expect(result.success).toBe(false);
106 | 			expect(result.output).toBe('Error: Missing required arguments');
107 | 		});
108 | 		it('run a command with the sub-command as the root', async () => {
109 | 			const result = await run(push, 'origin');
110 | 			expect(result.success).toBe(false);
111 | 			expect(result.output).toBe('Error: Missing required arguments');
112 | 		});
113 | 		it('run a command with all required args', async () => {
114 | 			const result = await run(clui, 'git push origin master -f');
115 | 			expect(result.success).toBe(true);
116 | 		});
117 | 		it('run a command with no run function', async () => {
118 | 			const result = await run(new Command({...push, run: undefined}), 'origin master');
119 | 			expect(result.success).toBe(false);
120 | 			expect(result.output).toBe('Error: Command has no run function');
121 | 		});
122 | 	});
123 | });


--------------------------------------------------------------------------------
/tsconfig.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "extends": "@tsconfig/svelte/tsconfig.json",
 3 |   "include": ["src/**/*.d.ts", "src/**/*.ts", "src/**/*.js", "src/**/*.svelte"],
 4 | 	"exclude": ["src/**/*.test.ts"],
 5 |   "compilerOptions": {
 6 |     /* Visit https://aka.ms/tsconfig.json to read more about this file */
 7 | 
 8 |     /* Basic Options */
 9 |     // "incremental": true,                         /* Enable incremental compilation */
10 |     "target": "es2015",                             /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', 'ES2021', or 'ESNEXT'. */
11 |     "module": "es2020",                             /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
12 |     // "lib": [],                                   /* Specify library files to be included in the compilation. */
13 |     // "allowJs": true,                             /* Allow javascript files to be compiled. */
14 |     // "checkJs": true,                             /* Report errors in .js files. */
15 |     "jsx": "react",                                 /* Specify JSX code generation: 'preserve', 'react-native', 'react', 'react-jsx' or 'react-jsxdev'. */
16 |     // "declaration": true,                         /* Generates corresponding '.d.ts' file. */
17 |     // "declarationMap": true,                      /* Generates a sourcemap for each corresponding '.d.ts' file. */
18 |     // "sourceMap": true,                           /* Generates corresponding '.map' file. */
19 |     // "outFile": "./dist/script.js",               /* Concatenate and emit output to single file. */
20 |     "outDir": "./dist",                             /* Redirect output structure to the directory. */
21 |     // "rootDir": "./src",                          /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
22 |     // "composite": true,                           /* Enable project compilation */
23 |     // "tsBuildInfoFile": "./",                     /* Specify file to store incremental compilation information */
24 |     "removeComments": true,                         /* Do not emit comments to output. */
25 |     // "noEmit": true,                              /* Do not emit outputs. */
26 |     // "importHelpers": true,                       /* Import emit helpers from 'tslib'. */
27 |     // "downlevelIteration": true,                  /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
28 |     // "isolatedModules": true,                     /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
29 | 
30 |     /* Strict Type-Checking Options */
31 |     "strict": true,                                 /* Enable all strict type-checking options. */
32 |     "noImplicitAny": true,                          /* Raise error on expressions and declarations with an implied 'any' type. */
33 |     "strictNullChecks": false,                      /* Enable strict null checks. */
34 |     // "strictFunctionTypes": true,                 /* Enable strict checking of function types. */
35 |     // "strictBindCallApply": true,                 /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
36 |     // "strictPropertyInitialization": true,        /* Enable strict checking of property initialization in classes. */
37 |     "noImplicitThis": true,                         /* Raise error on 'this' expressions with an implied 'any' type. */
38 |     "alwaysStrict": true,                           /* Parse in strict mode and emit "use strict" for each source file. */
39 | 
40 |     /* Additional Checks */
41 |     // "noUnusedLocals": true,                      /* Report errors on unused locals. */
42 |     // "noUnusedParameters": true,                  /* Report errors on unused parameters. */
43 |     // "noImplicitReturns": true,                   /* Report error when not all code paths in function return a value. */
44 |     // "noFallthroughCasesInSwitch": true,          /* Report errors for fallthrough cases in switch statement. */
45 |     // "noUncheckedIndexedAccess": true,            /* Include 'undefined' in index signature results */
46 |     // "noImplicitOverride": true,                  /* Ensure overriding members in derived classes are marked with an 'override' modifier. */
47 |     // "noPropertyAccessFromIndexSignature": true,  /* Require undeclared properties from index signatures to use element accesses. */
48 | 
49 |     /* Module Resolution Options */
50 |     // "moduleResolution": "node",                  /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
51 |     // "baseUrl": "./",                             /* Base directory to resolve non-absolute module names. */
52 |     // "paths": {},                                 /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
53 |     // "rootDirs": [],                              /* List of root folders whose combined content represents the structure of the project at runtime. */
54 |     // "typeRoots": [],                             /* List of folders to include type definitions from. */
55 |     // "types": [],                                 /* Type declaration files to be included in compilation. */
56 |     // "allowSyntheticDefaultImports": true,        /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
57 |     "esModuleInterop": true,                        /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
58 |     // "preserveSymlinks": true,                    /* Do not resolve the real path of symlinks. */
59 |     // "allowUmdGlobalAccess": true,                /* Allow accessing UMD globals from modules. */
60 | 
61 |     /* Source Map Options */
62 |     // "sourceRoot": "",                            /* Specify the location where debugger should locate TypeScript files instead of source locations. */
63 |     // "mapRoot": "",                               /* Specify the location where debugger should locate map files instead of generated locations. */
64 |     // "inlineSourceMap": true,                     /* Emit a single file with source maps instead of having a separate file. */
65 |     // "inlineSources": true,                       /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
66 | 
67 |     /* Experimental Options */
68 |     // "experimentalDecorators": true,              /* Enables experimental support for ES7 decorators. */
69 |     // "emitDecoratorMetadata": true,               /* Enables experimental support for emitting type metadata for decorators. */
70 | 
71 |     /* Advanced Options */
72 |     "skipLibCheck": true,                           /* Skip type checking of declaration files. */
73 |     "forceConsistentCasingInFileNames": true        /* Disallow inconsistently-cased references to the same file. */
74 |   }
75 | }
76 | 


--------------------------------------------------------------------------------
/src/Clui.svelte:
--------------------------------------------------------------------------------
  1 | <!-- fake warning -->
  2 | <svelte:options tag="clui-main" immutable={true} />
  3 | 
  4 | <script lang="ts">
  5 | 	import commands from './commands';
  6 | 	import type { Request, Response } from './lib/runner';
  7 | 	import { Command, Arg } from './clui';
  8 | 	import CLUI from './clui';
  9 | 	const clui = new CLUI();
 10 | 
 11 | 	// @ts-expect-error
 12 | 	window.clui = clui;
 13 | 	clui.load(...commands);
 14 | 
 15 | 	let current: (Command | Arg)[] = [];
 16 | 	let correct: (Command | Arg)[] = [];
 17 | 	let list: Command[] = [];
 18 | 	let canRun = false;
 19 | 
 20 | 	let pages = [];
 21 | 	let form = {};
 22 | 	let showForm = false;
 23 | 
 24 | 	let selection = 0;
 25 | 	let focus = false;
 26 | 	let value = '';
 27 | 
 28 | 	let cursor = [0, 0];
 29 | 
 30 | 	$: updateCorrect(current);
 31 | 	
 32 | 	const updateCorrect = (current: (Command | Arg)[]) => correct = current.filter(el => el.unknown !== true);
 33 | 
 34 | 	const search = () => {
 35 | 		if (value && (clui.getLastCommand(current)?.type === 'cmd' || clui.getLastCommand(current) === undefined)) {
 36 | 			current = clui.parseMatch(value, clui, {start: cursor[0], end: cursor[1]});
 37 | 			updateCorrect(current);
 38 | 			const last = correct[correct.length - 1];
 39 | 
 40 | 			if (value.endsWith(' ') && last instanceof Command && last.type === 'cmd') list = last.children as Command[];
 41 | 			else list = clui.search((last && last instanceof Command ? last : clui), current[current.length - 1]?.name || '', {withPath: true});
 42 | 			
 43 | 			selection = list.length ? Math.min(selection, list.length - 1) : 0;
 44 | 		} else if (clui.getLastCommand(current)?.type === 'arg') {
 45 | 			current = clui.parseMatch(value, clui, {start: cursor[0], end: cursor[1]});
 46 | 			updateCorrect(current);
 47 | 			list = [];
 48 | 		} else if (focus) {
 49 | 			list = clui.commands;
 50 | 			current = [];
 51 | 			correct = [];
 52 | 		} else {
 53 | 			// list = [];
 54 | 		}
 55 | 		
 56 | 		canRun = clui.checkRun(clui, current);
 57 | 	};
 58 | 
 59 | 	const keyHandler = (e: KeyboardEvent) => {
 60 | 		const target = e.target as HTMLInputElement;
 61 | 
 62 | 		switch (e.key) {
 63 | 			case 'ArrowDown':
 64 | 				e.preventDefault();
 65 | 				selection = Math.min(selection + 1, list.length - 1);
 66 | 				break;
 67 | 			case 'ArrowUp':
 68 | 				e.preventDefault();
 69 | 				selection = Math.max(selection - 1, 0);
 70 | 				break;
 71 | 			case 'Tab':
 72 | 				e.preventDefault();
 73 | 				resolve(current, list[selection].path || list[selection]);
 74 | 				break;
 75 | 			case 'Enter':
 76 | 				const last = clui.getLastCommand(current);
 77 | 				e.preventDefault();
 78 | 				if (last.hasOwnProperty('run')) run();
 79 | 				else resolve(current, list[selection].path || list[selection]);
 80 | 				break;
 81 | 		}
 82 | 
 83 | 		cursor = [target.selectionStart, target.selectionEnd];
 84 | 	};
 85 | 
 86 | 	const resolve = (tokens: (Command | Arg)[], token: (Command | Arg) | (Command | Arg)[]) => {
 87 | 		if (!Array.isArray(token)) token = [token];
 88 | 		const index = tokens.findIndex(el => el.unknown);
 89 | 		if (index !== -1) tokens.splice(index, 1, ...token);
 90 | 		else tokens.push(...token);
 91 | 		value = toString(tokens) + ' ';
 92 | 		search();
 93 | 	};
 94 | 
 95 | 	const toString = (tokens: (Command | Arg)[]) => {
 96 | 		return tokens.map(el => {
 97 | 			if (el instanceof Command) return el.name;
 98 | 			else return el.value;
 99 | 		}).join(' ');
100 | 	};
101 | 
102 | 	const run = () => {
103 | 		if (canRun) {
104 | 			clui.run(clui, current);
105 | 			clear();
106 | 		}
107 | 		else console.log('cannot run');
108 | 	};
109 | 
110 | 	const currentWithoutUnknown = (current: (Command | Arg)[]) => {
111 | 		current = current.filter(el => el instanceof Command);
112 | 		if (current[current.length - 1]?.unknown) return current.slice(0, current.length - 1);
113 | 		else return current;
114 | 	};
115 | 
116 | 	const clear = () => {
117 | 		value = '';
118 | 		list = clui.commands;
119 | 		current = [];
120 | 		correct = [];
121 | 	};
122 | </script>
123 | 
124 | <div id="clui-fragment">
125 | 	<div class="cli">
126 | 		<div class="input">
127 | 			<div class="tokens">
128 | 				{#each currentWithoutUnknown(current) as token, i}
129 | 					<span class="token transparent {token.unknown ? 'unknown' : ''}">{token.name}{@html i === currentWithoutUnknown(current).length - 1 ? '' : '&nbsp;'}</span>
130 | 				{/each}
131 | 				<!-- {#if focus}
132 | 					<span class="token unknown">{list[selection]?.path?.map(el => el.name).join(' ') || list[selection]?.name || ''}</span>
133 | 				{/if} -->
134 | 			</div>
135 | 			<img src="fav.png" alt="icon" class="icon" style="width: 1.6rem; padding-left: 0.4rem">
136 | 			<input type="text" placeholder={focus ? '' : 'Enter a command'} bind:value={value} on:keydown={keyHandler} on:input={search} on:focus={(e)=>{focus=true;search()}} on:blur={(e)=>{focus=false;search()}}>
137 | 			<button class="input-button {value !== '' && clui.getLastCommand(current)?.hasOwnProperty('run') ? 'show' : ''}" on:click={run}>
138 | 				{canRun ? 'run' : 'form'}
139 | 			</button>
140 | 		</div>
141 | 		<div class="dropdown">
142 | 			{#each list as item, i}
143 | 				<div class="dropdown-item {i === selection ? 'selected' : ''}" on:mouseover={()=>selection = i}
144 | 					on:click={()=>resolve(current, list[selection].path || list[selection])}>
145 | 					{#if item.path && item.path.length > 0}
146 | 						{#each item.path as p}
147 | 							<span class="item-name">{p.name}</span>
148 | 						{/each}
149 | 					{:else}
150 | 						<span class="item-name">{item.name}</span>
151 | 					{/if}
152 | 					<span class="item-description">{item.description ?? ''}</span>
153 | 				</div>
154 | 			{/each}
155 | 		</div>
156 | 		<div class="form" class:hide={!showForm}>
157 | 
158 | 		</div>
159 | 	</div>
160 | </div>
161 | 
162 | <style>
163 | 	#clui-fragment, #clui-fragment * {
164 | 		box-sizing: border-box;
165 | 	}
166 | 	#clui-fragment {
167 | 	--dark: hsl(225, 32%, 13%);
168 | 	--darker: hsl(225, 35%, 9%);
169 | 	--darkest: hsl(225, 38%, 6%);
170 | 	--light: hsl(225, 35%, 36%);
171 | 	--medium: hsl(225, 31%, 18%);
172 | 	--text-light: hsl(225, 54%, 89%);
173 | 	--text-medium: hsl(225, 33%, 64%);
174 | 		background-color: var(--darkest);
175 | 		color: var(--text-medium);
176 | 		font-size: 1.3rem;
177 | 		font-family: Calibri, sans-serif;
178 | 	}
179 | 
180 | 	#clui-fragment {
181 | 		display: flex;
182 | 		flex-direction: column;
183 | 		align-items: center;
184 | 		margin: 0 auto;
185 | 	}
186 | 	
187 | 	.input {
188 | 		position: relative;
189 | 		display: flex;
190 | 		align-items: center;
191 | 		border: 2px solid var(--medium);
192 | 		border-radius: 3px;
193 | 		background-color: var(--dark);
194 | 	}
195 | 
196 | 	.input > .tokens {
197 | 		left: 2rem;
198 | 		position: absolute;
199 | 	}
200 | 
201 | 	.input > .tokens > span {
202 | 		display: inline-block;
203 | 		border-radius: 3px;
204 | 	}
205 | 	.input > .tokens > span.transparent {
206 | 		color: transparent;
207 | 	}
208 | 	.input > .tokens > span:not(.unknown) {
209 | 		background-color: var(--light);
210 | 		padding: 0.1rem 0.2rem;
211 | 		margin-left: -0.2rem;
212 | 		margin-right: -0.2rem;
213 | 	}
214 | 
215 | 	.input > input {
216 | 		position: relative;
217 | 		z-index: 1;
218 | 		flex: 1;
219 | 		padding: 0.6rem 0.4rem;
220 | 		outline: none;
221 | 		border: none;
222 | 		background-color: transparent;
223 | 		color: var(--text-light);
224 | 		font-size: inherit;
225 | 		font-family: Calibri, sans-serif;
226 | 	}
227 | 
228 | 	.input > .input-button {
229 | 		margin-right: 0.3rem;
230 | 		padding: 0.3rem 0.5rem;
231 | 		border: 2px solid var(--light);
232 | 		border-radius: 3px;
233 | 		display: none;
234 | 		user-select: none;
235 | 		font: inherit;
236 | 		color: inherit;
237 | 		background-color: transparent;
238 | 	}
239 | 	.input > .input-button.show {
240 | 		display: inline-block;
241 | 	}
242 | 	.input > .input-button:hover {
243 | 		background-color: var(--light);
244 | 		color: var(--text-light);
245 | 		cursor: pointer;
246 | 	}
247 | 
248 | 	.dropdown, .form {
249 | 		overflow-y: auto;
250 | 		min-width: 40vw;
251 | 		max-width: 60vw;
252 | 		max-height: 40vh;
253 | 		border-radius: 0 0 3px 3px;
254 | 		background-color: var(--darker);
255 | 	}
256 | 	.dropdown-item {
257 | 		position: relative;
258 | 		z-index: 1;
259 | 		padding: 0.3rem 0.6rem;
260 | 		padding-left: 1.6rem;
261 | 		border-radius: 3px;
262 | 		background-color: var(--darker);
263 | 	}
264 | 	.dropdown-item.selected {
265 | 		outline: 2px solid var(--light);
266 | 		outline-offset: -2px;
267 | 		background-color: var(--medium);
268 | 		color: var(--text-light);
269 | 		cursor: pointer;
270 | 	}
271 | 	.item-name {
272 | 		margin-right: 0.3rem;
273 | 		padding: 0.3rem 0.5rem;
274 | 		border: 2px solid var(--light);
275 | 		border-radius: 3px;
276 | 		display: inline-block;
277 | 	}
278 | 	.selected > .item-name {
279 | 		background-color: var(--light);
280 | 	}
281 | </style>


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                     GNU AFFERO GENERAL PUBLIC LICENSE
  2 |                        Version 3, 19 November 2007
  3 | 
  4 |  Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  5 |  Everyone is permitted to copy and distribute verbatim copies
  6 |  of this license document, but changing it is not allowed.
  7 | 
  8 |                             Preamble
  9 | 
 10 |   The GNU Affero General Public License is a free, copyleft license for
 11 | software and other kinds of works, specifically designed to ensure
 12 | cooperation with the community in the case of network server software.
 13 | 
 14 |   The licenses for most software and other practical works are designed
 15 | to take away your freedom to share and change the works.  By contrast,
 16 | our General Public Licenses are intended to guarantee your freedom to
 17 | share and change all versions of a program--to make sure it remains free
 18 | software for all its users.
 19 | 
 20 |   When we speak of free software, we are referring to freedom, not
 21 | price.  Our General Public Licenses are designed to make sure that you
 22 | have the freedom to distribute copies of free software (and charge for
 23 | them if you wish), that you receive source code or can get it if you
 24 | want it, that you can change the software or use pieces of it in new
 25 | free programs, and that you know you can do these things.
 26 | 
 27 |   Developers that use our General Public Licenses protect your rights
 28 | with two steps: (1) assert copyright on the software, and (2) offer
 29 | you this License which gives you legal permission to copy, distribute
 30 | and/or modify the software.
 31 | 
 32 |   A secondary benefit of defending all users' freedom is that
 33 | improvements made in alternate versions of the program, if they
 34 | receive widespread use, become available for other developers to
 35 | incorporate.  Many developers of free software are heartened and
 36 | encouraged by the resulting cooperation.  However, in the case of
 37 | software used on network servers, this result may fail to come about.
 38 | The GNU General Public License permits making a modified version and
 39 | letting the public access it on a server without ever releasing its
 40 | source code to the public.
 41 | 
 42 |   The GNU Affero General Public License is designed specifically to
 43 | ensure that, in such cases, the modified source code becomes available
 44 | to the community.  It requires the operator of a network server to
 45 | provide the source code of the modified version running there to the
 46 | users of that server.  Therefore, public use of a modified version, on
 47 | a publicly accessible server, gives the public access to the source
 48 | code of the modified version.
 49 | 
 50 |   An older license, called the Affero General Public License and
 51 | published by Affero, was designed to accomplish similar goals.  This is
 52 | a different license, not a version of the Affero GPL, but Affero has
 53 | released a new version of the Affero GPL which permits relicensing under
 54 | this license.
 55 | 
 56 |   The precise terms and conditions for copying, distribution and
 57 | modification follow.
 58 | 
 59 |                        TERMS AND CONDITIONS
 60 | 
 61 |   0. Definitions.
 62 | 
 63 |   "This License" refers to version 3 of the GNU Affero General Public License.
 64 | 
 65 |   "Copyright" also means copyright-like laws that apply to other kinds of
 66 | works, such as semiconductor masks.
 67 | 
 68 |   "The Program" refers to any copyrightable work licensed under this
 69 | License.  Each licensee is addressed as "you".  "Licensees" and
 70 | "recipients" may be individuals or organizations.
 71 | 
 72 |   To "modify" a work means to copy from or adapt all or part of the work
 73 | in a fashion requiring copyright permission, other than the making of an
 74 | exact copy.  The resulting work is called a "modified version" of the
 75 | earlier work or a work "based on" the earlier work.
 76 | 
 77 |   A "covered work" means either the unmodified Program or a work based
 78 | on the Program.
 79 | 
 80 |   To "propagate" a work means to do anything with it that, without
 81 | permission, would make you directly or secondarily liable for
 82 | infringement under applicable copyright law, except executing it on a
 83 | computer or modifying a private copy.  Propagation includes copying,
 84 | distribution (with or without modification), making available to the
 85 | public, and in some countries other activities as well.
 86 | 
 87 |   To "convey" a work means any kind of propagation that enables other
 88 | parties to make or receive copies.  Mere interaction with a user through
 89 | a computer network, with no transfer of a copy, is not conveying.
 90 | 
 91 |   An interactive user interface displays "Appropriate Legal Notices"
 92 | to the extent that it includes a convenient and prominently visible
 93 | feature that (1) displays an appropriate copyright notice, and (2)
 94 | tells the user that there is no warranty for the work (except to the
 95 | extent that warranties are provided), that licensees may convey the
 96 | work under this License, and how to view a copy of this License.  If
 97 | the interface presents a list of user commands or options, such as a
 98 | menu, a prominent item in the list meets this criterion.
 99 | 
100 |   1. Source Code.
101 | 
102 |   The "source code" for a work means the preferred form of the work
103 | for making modifications to it.  "Object code" means any non-source
104 | form of a work.
105 | 
106 |   A "Standard Interface" means an interface that either is an official
107 | standard defined by a recognized standards body, or, in the case of
108 | interfaces specified for a particular programming language, one that
109 | is widely used among developers working in that language.
110 | 
111 |   The "System Libraries" of an executable work include anything, other
112 | than the work as a whole, that (a) is included in the normal form of
113 | packaging a Major Component, but which is not part of that Major
114 | Component, and (b) serves only to enable use of the work with that
115 | Major Component, or to implement a Standard Interface for which an
116 | implementation is available to the public in source code form.  A
117 | "Major Component", in this context, means a major essential component
118 | (kernel, window system, and so on) of the specific operating system
119 | (if any) on which the executable work runs, or a compiler used to
120 | produce the work, or an object code interpreter used to run it.
121 | 
122 |   The "Corresponding Source" for a work in object code form means all
123 | the source code needed to generate, install, and (for an executable
124 | work) run the object code and to modify the work, including scripts to
125 | control those activities.  However, it does not include the work's
126 | System Libraries, or general-purpose tools or generally available free
127 | programs which are used unmodified in performing those activities but
128 | which are not part of the work.  For example, Corresponding Source
129 | includes interface definition files associated with source files for
130 | the work, and the source code for shared libraries and dynamically
131 | linked subprograms that the work is specifically designed to require,
132 | such as by intimate data communication or control flow between those
133 | subprograms and other parts of the work.
134 | 
135 |   The Corresponding Source need not include anything that users
136 | can regenerate automatically from other parts of the Corresponding
137 | Source.
138 | 
139 |   The Corresponding Source for a work in source code form is that
140 | same work.
141 | 
142 |   2. Basic Permissions.
143 | 
144 |   All rights granted under this License are granted for the term of
145 | copyright on the Program, and are irrevocable provided the stated
146 | conditions are met.  This License explicitly affirms your unlimited
147 | permission to run the unmodified Program.  The output from running a
148 | covered work is covered by this License only if the output, given its
149 | content, constitutes a covered work.  This License acknowledges your
150 | rights of fair use or other equivalent, as provided by copyright law.
151 | 
152 |   You may make, run and propagate covered works that you do not
153 | convey, without conditions so long as your license otherwise remains
154 | in force.  You may convey covered works to others for the sole purpose
155 | of having them make modifications exclusively for you, or provide you
156 | with facilities for running those works, provided that you comply with
157 | the terms of this License in conveying all material for which you do
158 | not control copyright.  Those thus making or running the covered works
159 | for you must do so exclusively on your behalf, under your direction
160 | and control, on terms that prohibit them from making any copies of
161 | your copyrighted material outside their relationship with you.
162 | 
163 |   Conveying under any other circumstances is permitted solely under
164 | the conditions stated below.  Sublicensing is not allowed; section 10
165 | makes it unnecessary.
166 | 
167 |   3. Protecting Users' Legal Rights From Anti-Circumvention Law.
168 | 
169 |   No covered work shall be deemed part of an effective technological
170 | measure under any applicable law fulfilling obligations under article
171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
172 | similar laws prohibiting or restricting circumvention of such
173 | measures.
174 | 
175 |   When you convey a covered work, you waive any legal power to forbid
176 | circumvention of technological measures to the extent such circumvention
177 | is effected by exercising rights under this License with respect to
178 | the covered work, and you disclaim any intention to limit operation or
179 | modification of the work as a means of enforcing, against the work's
180 | users, your or third parties' legal rights to forbid circumvention of
181 | technological measures.
182 | 
183 |   4. Conveying Verbatim Copies.
184 | 
185 |   You may convey verbatim copies of the Program's source code as you
186 | receive it, in any medium, provided that you conspicuously and
187 | appropriately publish on each copy an appropriate copyright notice;
188 | keep intact all notices stating that this License and any
189 | non-permissive terms added in accord with section 7 apply to the code;
190 | keep intact all notices of the absence of any warranty; and give all
191 | recipients a copy of this License along with the Program.
192 | 
193 |   You may charge any price or no price for each copy that you convey,
194 | and you may offer support or warranty protection for a fee.
195 | 
196 |   5. Conveying Modified Source Versions.
197 | 
198 |   You may convey a work based on the Program, or the modifications to
199 | produce it from the Program, in the form of source code under the
200 | terms of section 4, provided that you also meet all of these conditions:
201 | 
202 |     a) The work must carry prominent notices stating that you modified
203 |     it, and giving a relevant date.
204 | 
205 |     b) The work must carry prominent notices stating that it is
206 |     released under this License and any conditions added under section
207 |     7.  This requirement modifies the requirement in section 4 to
208 |     "keep intact all notices".
209 | 
210 |     c) You must license the entire work, as a whole, under this
211 |     License to anyone who comes into possession of a copy.  This
212 |     License will therefore apply, along with any applicable section 7
213 |     additional terms, to the whole of the work, and all its parts,
214 |     regardless of how they are packaged.  This License gives no
215 |     permission to license the work in any other way, but it does not
216 |     invalidate such permission if you have separately received it.
217 | 
218 |     d) If the work has interactive user interfaces, each must display
219 |     Appropriate Legal Notices; however, if the Program has interactive
220 |     interfaces that do not display Appropriate Legal Notices, your
221 |     work need not make them do so.
222 | 
223 |   A compilation of a covered work with other separate and independent
224 | works, which are not by their nature extensions of the covered work,
225 | and which are not combined with it such as to form a larger program,
226 | in or on a volume of a storage or distribution medium, is called an
227 | "aggregate" if the compilation and its resulting copyright are not
228 | used to limit the access or legal rights of the compilation's users
229 | beyond what the individual works permit.  Inclusion of a covered work
230 | in an aggregate does not cause this License to apply to the other
231 | parts of the aggregate.
232 | 
233 |   6. Conveying Non-Source Forms.
234 | 
235 |   You may convey a covered work in object code form under the terms
236 | of sections 4 and 5, provided that you also convey the
237 | machine-readable Corresponding Source under the terms of this License,
238 | in one of these ways:
239 | 
240 |     a) Convey the object code in, or embodied in, a physical product
241 |     (including a physical distribution medium), accompanied by the
242 |     Corresponding Source fixed on a durable physical medium
243 |     customarily used for software interchange.
244 | 
245 |     b) Convey the object code in, or embodied in, a physical product
246 |     (including a physical distribution medium), accompanied by a
247 |     written offer, valid for at least three years and valid for as
248 |     long as you offer spare parts or customer support for that product
249 |     model, to give anyone who possesses the object code either (1) a
250 |     copy of the Corresponding Source for all the software in the
251 |     product that is covered by this License, on a durable physical
252 |     medium customarily used for software interchange, for a price no
253 |     more than your reasonable cost of physically performing this
254 |     conveying of source, or (2) access to copy the
255 |     Corresponding Source from a network server at no charge.
256 | 
257 |     c) Convey individual copies of the object code with a copy of the
258 |     written offer to provide the Corresponding Source.  This
259 |     alternative is allowed only occasionally and noncommercially, and
260 |     only if you received the object code with such an offer, in accord
261 |     with subsection 6b.
262 | 
263 |     d) Convey the object code by offering access from a designated
264 |     place (gratis or for a charge), and offer equivalent access to the
265 |     Corresponding Source in the same way through the same place at no
266 |     further charge.  You need not require recipients to copy the
267 |     Corresponding Source along with the object code.  If the place to
268 |     copy the object code is a network server, the Corresponding Source
269 |     may be on a different server (operated by you or a third party)
270 |     that supports equivalent copying facilities, provided you maintain
271 |     clear directions next to the object code saying where to find the
272 |     Corresponding Source.  Regardless of what server hosts the
273 |     Corresponding Source, you remain obligated to ensure that it is
274 |     available for as long as needed to satisfy these requirements.
275 | 
276 |     e) Convey the object code using peer-to-peer transmission, provided
277 |     you inform other peers where the object code and Corresponding
278 |     Source of the work are being offered to the general public at no
279 |     charge under subsection 6d.
280 | 
281 |   A separable portion of the object code, whose source code is excluded
282 | from the Corresponding Source as a System Library, need not be
283 | included in conveying the object code work.
284 | 
285 |   A "User Product" is either (1) a "consumer product", which means any
286 | tangible personal property which is normally used for personal, family,
287 | or household purposes, or (2) anything designed or sold for incorporation
288 | into a dwelling.  In determining whether a product is a consumer product,
289 | doubtful cases shall be resolved in favor of coverage.  For a particular
290 | product received by a particular user, "normally used" refers to a
291 | typical or common use of that class of product, regardless of the status
292 | of the particular user or of the way in which the particular user
293 | actually uses, or expects or is expected to use, the product.  A product
294 | is a consumer product regardless of whether the product has substantial
295 | commercial, industrial or non-consumer uses, unless such uses represent
296 | the only significant mode of use of the product.
297 | 
298 |   "Installation Information" for a User Product means any methods,
299 | procedures, authorization keys, or other information required to install
300 | and execute modified versions of a covered work in that User Product from
301 | a modified version of its Corresponding Source.  The information must
302 | suffice to ensure that the continued functioning of the modified object
303 | code is in no case prevented or interfered with solely because
304 | modification has been made.
305 | 
306 |   If you convey an object code work under this section in, or with, or
307 | specifically for use in, a User Product, and the conveying occurs as
308 | part of a transaction in which the right of possession and use of the
309 | User Product is transferred to the recipient in perpetuity or for a
310 | fixed term (regardless of how the transaction is characterized), the
311 | Corresponding Source conveyed under this section must be accompanied
312 | by the Installation Information.  But this requirement does not apply
313 | if neither you nor any third party retains the ability to install
314 | modified object code on the User Product (for example, the work has
315 | been installed in ROM).
316 | 
317 |   The requirement to provide Installation Information does not include a
318 | requirement to continue to provide support service, warranty, or updates
319 | for a work that has been modified or installed by the recipient, or for
320 | the User Product in which it has been modified or installed.  Access to a
321 | network may be denied when the modification itself materially and
322 | adversely affects the operation of the network or violates the rules and
323 | protocols for communication across the network.
324 | 
325 |   Corresponding Source conveyed, and Installation Information provided,
326 | in accord with this section must be in a format that is publicly
327 | documented (and with an implementation available to the public in
328 | source code form), and must require no special password or key for
329 | unpacking, reading or copying.
330 | 
331 |   7. Additional Terms.
332 | 
333 |   "Additional permissions" are terms that supplement the terms of this
334 | License by making exceptions from one or more of its conditions.
335 | Additional permissions that are applicable to the entire Program shall
336 | be treated as though they were included in this License, to the extent
337 | that they are valid under applicable law.  If additional permissions
338 | apply only to part of the Program, that part may be used separately
339 | under those permissions, but the entire Program remains governed by
340 | this License without regard to the additional permissions.
341 | 
342 |   When you convey a copy of a covered work, you may at your option
343 | remove any additional permissions from that copy, or from any part of
344 | it.  (Additional permissions may be written to require their own
345 | removal in certain cases when you modify the work.)  You may place
346 | additional permissions on material, added by you to a covered work,
347 | for which you have or can give appropriate copyright permission.
348 | 
349 |   Notwithstanding any other provision of this License, for material you
350 | add to a covered work, you may (if authorized by the copyright holders of
351 | that material) supplement the terms of this License with terms:
352 | 
353 |     a) Disclaiming warranty or limiting liability differently from the
354 |     terms of sections 15 and 16 of this License; or
355 | 
356 |     b) Requiring preservation of specified reasonable legal notices or
357 |     author attributions in that material or in the Appropriate Legal
358 |     Notices displayed by works containing it; or
359 | 
360 |     c) Prohibiting misrepresentation of the origin of that material, or
361 |     requiring that modified versions of such material be marked in
362 |     reasonable ways as different from the original version; or
363 | 
364 |     d) Limiting the use for publicity purposes of names of licensors or
365 |     authors of the material; or
366 | 
367 |     e) Declining to grant rights under trademark law for use of some
368 |     trade names, trademarks, or service marks; or
369 | 
370 |     f) Requiring indemnification of licensors and authors of that
371 |     material by anyone who conveys the material (or modified versions of
372 |     it) with contractual assumptions of liability to the recipient, for
373 |     any liability that these contractual assumptions directly impose on
374 |     those licensors and authors.
375 | 
376 |   All other non-permissive additional terms are considered "further
377 | restrictions" within the meaning of section 10.  If the Program as you
378 | received it, or any part of it, contains a notice stating that it is
379 | governed by this License along with a term that is a further
380 | restriction, you may remove that term.  If a license document contains
381 | a further restriction but permits relicensing or conveying under this
382 | License, you may add to a covered work material governed by the terms
383 | of that license document, provided that the further restriction does
384 | not survive such relicensing or conveying.
385 | 
386 |   If you add terms to a covered work in accord with this section, you
387 | must place, in the relevant source files, a statement of the
388 | additional terms that apply to those files, or a notice indicating
389 | where to find the applicable terms.
390 | 
391 |   Additional terms, permissive or non-permissive, may be stated in the
392 | form of a separately written license, or stated as exceptions;
393 | the above requirements apply either way.
394 | 
395 |   8. Termination.
396 | 
397 |   You may not propagate or modify a covered work except as expressly
398 | provided under this License.  Any attempt otherwise to propagate or
399 | modify it is void, and will automatically terminate your rights under
400 | this License (including any patent licenses granted under the third
401 | paragraph of section 11).
402 | 
403 |   However, if you cease all violation of this License, then your
404 | license from a particular copyright holder is reinstated (a)
405 | provisionally, unless and until the copyright holder explicitly and
406 | finally terminates your license, and (b) permanently, if the copyright
407 | holder fails to notify you of the violation by some reasonable means
408 | prior to 60 days after the cessation.
409 | 
410 |   Moreover, your license from a particular copyright holder is
411 | reinstated permanently if the copyright holder notifies you of the
412 | violation by some reasonable means, this is the first time you have
413 | received notice of violation of this License (for any work) from that
414 | copyright holder, and you cure the violation prior to 30 days after
415 | your receipt of the notice.
416 | 
417 |   Termination of your rights under this section does not terminate the
418 | licenses of parties who have received copies or rights from you under
419 | this License.  If your rights have been terminated and not permanently
420 | reinstated, you do not qualify to receive new licenses for the same
421 | material under section 10.
422 | 
423 |   9. Acceptance Not Required for Having Copies.
424 | 
425 |   You are not required to accept this License in order to receive or
426 | run a copy of the Program.  Ancillary propagation of a covered work
427 | occurring solely as a consequence of using peer-to-peer transmission
428 | to receive a copy likewise does not require acceptance.  However,
429 | nothing other than this License grants you permission to propagate or
430 | modify any covered work.  These actions infringe copyright if you do
431 | not accept this License.  Therefore, by modifying or propagating a
432 | covered work, you indicate your acceptance of this License to do so.
433 | 
434 |   10. Automatic Licensing of Downstream Recipients.
435 | 
436 |   Each time you convey a covered work, the recipient automatically
437 | receives a license from the original licensors, to run, modify and
438 | propagate that work, subject to this License.  You are not responsible
439 | for enforcing compliance by third parties with this License.
440 | 
441 |   An "entity transaction" is a transaction transferring control of an
442 | organization, or substantially all assets of one, or subdividing an
443 | organization, or merging organizations.  If propagation of a covered
444 | work results from an entity transaction, each party to that
445 | transaction who receives a copy of the work also receives whatever
446 | licenses to the work the party's predecessor in interest had or could
447 | give under the previous paragraph, plus a right to possession of the
448 | Corresponding Source of the work from the predecessor in interest, if
449 | the predecessor has it or can get it with reasonable efforts.
450 | 
451 |   You may not impose any further restrictions on the exercise of the
452 | rights granted or affirmed under this License.  For example, you may
453 | not impose a license fee, royalty, or other charge for exercise of
454 | rights granted under this License, and you may not initiate litigation
455 | (including a cross-claim or counterclaim in a lawsuit) alleging that
456 | any patent claim is infringed by making, using, selling, offering for
457 | sale, or importing the Program or any portion of it.
458 | 
459 |   11. Patents.
460 | 
461 |   A "contributor" is a copyright holder who authorizes use under this
462 | License of the Program or a work on which the Program is based.  The
463 | work thus licensed is called the contributor's "contributor version".
464 | 
465 |   A contributor's "essential patent claims" are all patent claims
466 | owned or controlled by the contributor, whether already acquired or
467 | hereafter acquired, that would be infringed by some manner, permitted
468 | by this License, of making, using, or selling its contributor version,
469 | but do not include claims that would be infringed only as a
470 | consequence of further modification of the contributor version.  For
471 | purposes of this definition, "control" includes the right to grant
472 | patent sublicenses in a manner consistent with the requirements of
473 | this License.
474 | 
475 |   Each contributor grants you a non-exclusive, worldwide, royalty-free
476 | patent license under the contributor's essential patent claims, to
477 | make, use, sell, offer for sale, import and otherwise run, modify and
478 | propagate the contents of its contributor version.
479 | 
480 |   In the following three paragraphs, a "patent license" is any express
481 | agreement or commitment, however denominated, not to enforce a patent
482 | (such as an express permission to practice a patent or covenant not to
483 | sue for patent infringement).  To "grant" such a patent license to a
484 | party means to make such an agreement or commitment not to enforce a
485 | patent against the party.
486 | 
487 |   If you convey a covered work, knowingly relying on a patent license,
488 | and the Corresponding Source of the work is not available for anyone
489 | to copy, free of charge and under the terms of this License, through a
490 | publicly available network server or other readily accessible means,
491 | then you must either (1) cause the Corresponding Source to be so
492 | available, or (2) arrange to deprive yourself of the benefit of the
493 | patent license for this particular work, or (3) arrange, in a manner
494 | consistent with the requirements of this License, to extend the patent
495 | license to downstream recipients.  "Knowingly relying" means you have
496 | actual knowledge that, but for the patent license, your conveying the
497 | covered work in a country, or your recipient's use of the covered work
498 | in a country, would infringe one or more identifiable patents in that
499 | country that you have reason to believe are valid.
500 | 
501 |   If, pursuant to or in connection with a single transaction or
502 | arrangement, you convey, or propagate by procuring conveyance of, a
503 | covered work, and grant a patent license to some of the parties
504 | receiving the covered work authorizing them to use, propagate, modify
505 | or convey a specific copy of the covered work, then the patent license
506 | you grant is automatically extended to all recipients of the covered
507 | work and works based on it.
508 | 
509 |   A patent license is "discriminatory" if it does not include within
510 | the scope of its coverage, prohibits the exercise of, or is
511 | conditioned on the non-exercise of one or more of the rights that are
512 | specifically granted under this License.  You may not convey a covered
513 | work if you are a party to an arrangement with a third party that is
514 | in the business of distributing software, under which you make payment
515 | to the third party based on the extent of your activity of conveying
516 | the work, and under which the third party grants, to any of the
517 | parties who would receive the covered work from you, a discriminatory
518 | patent license (a) in connection with copies of the covered work
519 | conveyed by you (or copies made from those copies), or (b) primarily
520 | for and in connection with specific products or compilations that
521 | contain the covered work, unless you entered into that arrangement,
522 | or that patent license was granted, prior to 28 March 2007.
523 | 
524 |   Nothing in this License shall be construed as excluding or limiting
525 | any implied license or other defenses to infringement that may
526 | otherwise be available to you under applicable patent law.
527 | 
528 |   12. No Surrender of Others' Freedom.
529 | 
530 |   If conditions are imposed on you (whether by court order, agreement or
531 | otherwise) that contradict the conditions of this License, they do not
532 | excuse you from the conditions of this License.  If you cannot convey a
533 | covered work so as to satisfy simultaneously your obligations under this
534 | License and any other pertinent obligations, then as a consequence you may
535 | not convey it at all.  For example, if you agree to terms that obligate you
536 | to collect a royalty for further conveying from those to whom you convey
537 | the Program, the only way you could satisfy both those terms and this
538 | License would be to refrain entirely from conveying the Program.
539 | 
540 |   13. Remote Network Interaction; Use with the GNU General Public License.
541 | 
542 |   Notwithstanding any other provision of this License, if you modify the
543 | Program, your modified version must prominently offer all users
544 | interacting with it remotely through a computer network (if your version
545 | supports such interaction) an opportunity to receive the Corresponding
546 | Source of your version by providing access to the Corresponding Source
547 | from a network server at no charge, through some standard or customary
548 | means of facilitating copying of software.  This Corresponding Source
549 | shall include the Corresponding Source for any work covered by version 3
550 | of the GNU General Public License that is incorporated pursuant to the
551 | following paragraph.
552 | 
553 |   Notwithstanding any other provision of this License, you have
554 | permission to link or combine any covered work with a work licensed
555 | under version 3 of the GNU General Public License into a single
556 | combined work, and to convey the resulting work.  The terms of this
557 | License will continue to apply to the part which is the covered work,
558 | but the work with which it is combined will remain governed by version
559 | 3 of the GNU General Public License.
560 | 
561 |   14. Revised Versions of this License.
562 | 
563 |   The Free Software Foundation may publish revised and/or new versions of
564 | the GNU Affero General Public License from time to time.  Such new versions
565 | will be similar in spirit to the present version, but may differ in detail to
566 | address new problems or concerns.
567 | 
568 |   Each version is given a distinguishing version number.  If the
569 | Program specifies that a certain numbered version of the GNU Affero General
570 | Public License "or any later version" applies to it, you have the
571 | option of following the terms and conditions either of that numbered
572 | version or of any later version published by the Free Software
573 | Foundation.  If the Program does not specify a version number of the
574 | GNU Affero General Public License, you may choose any version ever published
575 | by the Free Software Foundation.
576 | 
577 |   If the Program specifies that a proxy can decide which future
578 | versions of the GNU Affero General Public License can be used, that proxy's
579 | public statement of acceptance of a version permanently authorizes you
580 | to choose that version for the Program.
581 | 
582 |   Later license versions may give you additional or different
583 | permissions.  However, no additional obligations are imposed on any
584 | author or copyright holder as a result of your choosing to follow a
585 | later version.
586 | 
587 |   15. Disclaimer of Warranty.
588 | 
589 |   THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
590 | APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
594 | PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
595 | IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
597 | 
598 |   16. Limitation of Liability.
599 | 
600 |   IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
608 | SUCH DAMAGES.
609 | 
610 |   17. Interpretation of Sections 15 and 16.
611 | 
612 |   If the disclaimer of warranty and limitation of liability provided
613 | above cannot be given local legal effect according to their terms,
614 | reviewing courts shall apply local law that most closely approximates
615 | an absolute waiver of all civil liability in connection with the
616 | Program, unless a warranty or assumption of liability accompanies a
617 | copy of the Program in return for a fee.
618 | 
619 |                      END OF TERMS AND CONDITIONS
620 | 
621 |             How to Apply These Terms to Your New Programs
622 | 
623 |   If you develop a new program, and you want it to be of the greatest
624 | possible use to the public, the best way to achieve this is to make it
625 | free software which everyone can redistribute and change under these terms.
626 | 
627 |   To do so, attach the following notices to the program.  It is safest
628 | to attach them to the start of each source file to most effectively
629 | state the exclusion of warranty; and each file should have at least
630 | the "copyright" line and a pointer to where the full notice is found.
631 | 
632 |     <one line to give the program's name and a brief idea of what it does.>
633 |     Copyright (C) <year>  <name of author>
634 | 
635 |     This program is free software: you can redistribute it and/or modify
636 |     it under the terms of the GNU Affero General Public License as published
637 |     by the Free Software Foundation, either version 3 of the License, or
638 |     (at your option) any later version.
639 | 
640 |     This program is distributed in the hope that it will be useful,
641 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
642 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
643 |     GNU Affero General Public License for more details.
644 | 
645 |     You should have received a copy of the GNU Affero General Public License
646 |     along with this program.  If not, see <https://www.gnu.org/licenses/>.
647 | 
648 | Also add information on how to contact you by electronic and paper mail.
649 | 
650 |   If your software can interact with users remotely through a computer
651 | network, you should also make sure that it provides a way for users to
652 | get its source.  For example, if your program is a web application, its
653 | interface could display a "Source" link that leads users to an archive
654 | of the code.  There are many ways you could offer source, and different
655 | solutions will be better for different programs; see section 13 for the
656 | specific requirements.
657 | 
658 |   You should also get your employer (if you work as a programmer) or school,
659 | if any, to sign a "copyright disclaimer" for the program, if necessary.
660 | For more information on this, and how to apply and follow the GNU AGPL, see
661 | <https://www.gnu.org/licenses/>.
662 | 


--------------------------------------------------------------------------------