diff --git a/packages/args/LICENSE b/packages/args/LICENSE new file mode 100644 index 0000000000..8dada3edaf --- /dev/null +++ b/packages/args/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/packages/args/api-extractor.json b/packages/args/api-extractor.json new file mode 100644 index 0000000000..94972e6bed --- /dev/null +++ b/packages/args/api-extractor.json @@ -0,0 +1,3 @@ +{ + "extends": "../../api-extractor.json" +} diff --git a/packages/args/package.json b/packages/args/package.json new file mode 100644 index 0000000000..3052a8126e --- /dev/null +++ b/packages/args/package.json @@ -0,0 +1,74 @@ +{ + "name": "@thi.ng/args", + "version": "0.0.1", + "description": "TODO", + "module": "./index.js", + "main": "./lib/index.js", + "umd:main": "./lib/index.umd.js", + "typings": "./index.d.ts", + "repository": { + "type": "git", + "url": "https://github.com/thi-ng/umbrella.git" + }, + "homepage": "https://github.com/thi-ng/umbrella/tree/master/packages/args#readme", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/postspectacular" + }, + { + "type": "patreon", + "url": "https://patreon.com/thing_umbrella" + } + ], + "author": "Karsten Schmidt ", + "license": "Apache-2.0", + "scripts": { + "build": "yarn clean && yarn build:es6 && node ../../scripts/bundle-module", + "build:release": "yarn clean && yarn build:es6 && node ../../scripts/bundle-module all", + "build:es6": "tsc --declaration", + "build:test": "rimraf build && tsc -p test/tsconfig.json", + "build:check": "tsc --isolatedModules --noEmit", + "test": "mocha test", + "cover": "nyc mocha test && nyc report --reporter=lcov", + "clean": "rimraf *.js *.d.ts *.map .nyc_output build coverage doc lib", + "doc:readme": "ts-node -P ../../tools/tsconfig.json ../../tools/src/readme.ts", + "doc:ae": "mkdir -p .ae/doc .ae/temp && node_modules/.bin/api-extractor run --local --verbose", + "doc": "node_modules/.bin/typedoc --out doc --theme ../../tools/doc/typedoc-theme src/index.ts", + "pub": "yarn build:release && yarn publish --access public", + "tool:foo": "ts-node -P tools/tsconfig.json tools/index.ts" + }, + "devDependencies": { + "@istanbuljs/nyc-config-typescript": "^1.0.1", + "@microsoft/api-extractor": "^7.12.1", + "@types/mocha": "^8.2.0", + "@types/node": "^14.14.14", + "mocha": "^8.2.1", + "nyc": "^15.1.0", + "ts-node": "^9.1.1", + "typedoc": "^0.20.4", + "typescript": "^4.1.3" + }, + "dependencies": { + "@thi.ng/api": "^6.13.6", + "@thi.ng/checks": "^2.7.13", + "@thi.ng/errors": "^1.2.26", + "@thi.ng/strings": "^1.12.0" + }, + "files": [ + "*.js", + "*.d.ts", + "lib" + ], + "keywords": [ + "typescript" + ], + "publishConfig": { + "access": "public" + }, + "sideEffects": false, + "thi.ng": { + "status": "alpha", + "year": 2021 + } +} diff --git a/packages/args/src/api.ts b/packages/args/src/api.ts new file mode 100644 index 0000000000..63e6243d1a --- /dev/null +++ b/packages/args/src/api.ts @@ -0,0 +1,31 @@ +import type { Fn, IObjectOf } from "@thi.ng/api"; + +export interface ArgSpec { + alias?: string; + desc?: string | string[]; + hint?: string; + optional?: boolean; + default?: T; +} + +export type Args> = { + [id in keyof T]: T[id] extends boolean + ? ArgSpec & { flag: true } + : T[id] extends any[] + ? T[id] extends string[] + ? ArgSpec & { coerce?: Fn; multi: true } + : ArgSpec & { coerce: Fn; multi: true } + : T[id] extends string + ? ArgSpec & { coerce?: Fn } + : ArgSpec & { coerce: Fn }; +}; + +export interface ParseResult { + result: T; + index: number; +} + +export interface UsageOpts { + lineWidth: number; + colWidth: number; +} diff --git a/packages/args/src/args.ts b/packages/args/src/args.ts new file mode 100644 index 0000000000..454c8dfe01 --- /dev/null +++ b/packages/args/src/args.ts @@ -0,0 +1,33 @@ +import type { ArgSpec } from "./api"; +import { int, ints, json, oneOf } from "./coerce"; + +export const argFlag = (spec: Partial>) => ({ + flag: true, + ...spec, +}); + +export const argInt = (spec: Partial>) => ({ + coerce: int, + hint: "INT", + ...spec, +}); + +export const argInts = (spec: Partial>) => ({ + coerce: ints, + hint: "INT", + multi: true, + ...spec, +}); + +export const argJSON = (spec: Partial>) => ({ + coerce: json, + hint: "JSON", + ...spec, +}); + +export const argEnum = (opts: string[], spec: Partial>) => ({ + coerce: oneOf(opts), + hint: "ID", + ...spec, + desc: `${spec.desc}: ${opts.map((x) => `'${x}'`).join(", ")}`, +}); diff --git a/packages/args/src/coerce.ts b/packages/args/src/coerce.ts new file mode 100644 index 0000000000..0517467374 --- /dev/null +++ b/packages/args/src/coerce.ts @@ -0,0 +1,10 @@ +import { illegalArgs } from "@thi.ng/errors"; + +export const int = (xs: string) => parseInt(xs); + +export const ints = (xs: string[]) => xs.map((x) => parseInt(x)); + +export const json = (x: string): T => JSON.parse(x); + +export const oneOf = (xs: string[]) => (x: string) => + xs.includes(x) ? x : illegalArgs(`invalid option: ${x}`); diff --git a/packages/args/src/index.ts b/packages/args/src/index.ts new file mode 100644 index 0000000000..81a1dd961a --- /dev/null +++ b/packages/args/src/index.ts @@ -0,0 +1,5 @@ +export * from "./api"; +export * from "./args"; +export * from "./coerce"; +export * from "./parse"; +export * from "./usage"; diff --git a/packages/args/src/parse.ts b/packages/args/src/parse.ts new file mode 100644 index 0000000000..3e93fec820 --- /dev/null +++ b/packages/args/src/parse.ts @@ -0,0 +1,74 @@ +import type { Fn, IObjectOf, Nullable } from "@thi.ng/api"; +import { isArray } from "@thi.ng/checks"; +import { illegalArgs } from "@thi.ng/errors"; +import type { Args, ArgSpec, ParseResult } from "./api"; + +export const parseArgs = >( + specs: Args, + argv: string[], + i = 2 +): ParseResult => { + const acc: any = {}; + const aliases = Object.entries(specs).reduce( + (acc, [k, v]) => (v.alias ? ((acc[v.alias] = k), acc) : acc), + >{} + ); + let key: Nullable; + let spec: Nullable< + ArgSpec & { + coerce?: Fn; + multi?: boolean; + flag?: boolean; + } + >; + for (; i < argv.length; ) { + const a = argv[i]; + if (!key) { + if (a[0] === "-") { + if (a[1] === "-") { + if (a === "--") break; + key = a.substr(2); + } else { + key = aliases[a.substr(1)]; + !key && illegalArgs(`unknown alias: ${a}`); + } + spec = specs[key]; + if (!spec) illegalArgs(key); + if (spec.flag) { + acc[key] = true; + key = null; + } + i++; + } + } else { + if (a[0] === "-") illegalArgs(`missing value for: ${key}`); + if (spec!.multi) { + isArray(acc[key]) ? acc[key].push(a) : (acc[key] = [a]); + } else { + acc[key] = a; + } + key = null; + i++; + } + } + key && illegalArgs(`missing value for: ${key}`); + for (let id in specs) { + spec = specs[id]; + if (acc[id] === undefined) { + if (spec.default !== undefined) { + acc[id] = spec.default; + } else if (spec.optional === false) { + illegalArgs(`missing arg: ${id}`); + } + } else { + if (spec.coerce) { + try { + acc[id] = spec.coerce(acc[id]); + } catch (e) { + throw new Error(`arg '${id}': ${e.message}`); + } + } + } + } + return { result: acc, index: i }; +}; diff --git a/packages/args/src/usage.ts b/packages/args/src/usage.ts new file mode 100644 index 0000000000..0ea784ea34 --- /dev/null +++ b/packages/args/src/usage.ts @@ -0,0 +1,47 @@ +import type { IObjectOf } from "@thi.ng/api"; +import { format, padRight, repeat } from "@thi.ng/strings"; +import type { Args, UsageOpts } from "./api"; + +export const wordWrap = (opts: UsageOpts) => (str: string) => { + let ln = 0; + let curr: string[] = []; + const res: string[] = []; + const num = opts.lineWidth - opts.colWidth; + for (let w of str.split(" ")) { + if (ln + w.length + 1 <= num) { + curr.push(w); + ln += w.length + (ln > 0 ? 1 : 0); + } else { + res.push(curr.join(" ")); + curr = [w]; + ln = w.length; + } + } + ln && res.push(curr.join(" ")); + return res + .map((l, i) => (i > 0 ? repeat(" ", opts.colWidth) : "") + l) + .join("\n"); +}; + +export const usage = >( + specs: Args, + opts: Partial = {} +) => { + opts = { lineWidth: 72, colWidth: 32, ...opts }; + return Object.keys(specs) + .sort() + .map((id) => { + const spec = specs[id]; + const hint = spec.hint ? " " + spec.hint.toUpperCase() : ""; + const alias = spec.alias ? `-${spec.alias}${hint}, ` : ""; + id = `--${id}${hint}`; + const res: string = format( + [padRight(opts.colWidth!), wordWrap(opts)], + `${alias}${id}`, + (spec.optional === false ? "[required] " : "") + + (spec.desc || "") + ); + return res; + }) + .join("\n"); +}; diff --git a/packages/args/test/index.ts b/packages/args/test/index.ts new file mode 100644 index 0000000000..7237caed03 --- /dev/null +++ b/packages/args/test/index.ts @@ -0,0 +1,6 @@ +// import * as assert from "assert"; +// import { } from "../src"; + +describe("args", () => { + it("tests pending"); +}); diff --git a/packages/args/test/tsconfig.json b/packages/args/test/tsconfig.json new file mode 100644 index 0000000000..f6e63560dd --- /dev/null +++ b/packages/args/test/tsconfig.json @@ -0,0 +1,11 @@ +{ + "extends": "../../../tsconfig.json", + "compilerOptions": { + "outDir": "../build", + "module": "commonjs" + }, + "include": [ + "./**/*.ts", + "../src/**/*.ts" + ] +} diff --git a/packages/args/tpl.readme.md b/packages/args/tpl.readme.md new file mode 100644 index 0000000000..c1a3304490 --- /dev/null +++ b/packages/args/tpl.readme.md @@ -0,0 +1,50 @@ +# ${pkg.banner} + +[![npm version](https://img.shields.io/npm/v/${pkg.name}.svg)](https://www.npmjs.com/package/${pkg.name}) +![npm downloads](https://img.shields.io/npm/dm/${pkg.name}.svg) +[![Twitter Follow](https://img.shields.io/twitter/follow/thing_umbrella.svg?style=flat-square&label=twitter)](https://twitter.com/thing_umbrella) + +This project is part of the +[@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo. + + + +## About + +${pkg.description} + +${status} + +${supportPackages} + +${relatedPackages} + +${blogPosts} + +## Installation + +${pkg.install} + +${pkg.size} + +## Dependencies + +${pkg.deps} + +${examples} + +## API + +${docLink} + +TODO + +## Authors + +${authors} + +${pkg.cite} + +## License + +© ${copyright} // ${license} diff --git a/packages/args/tsconfig.json b/packages/args/tsconfig.json new file mode 100644 index 0000000000..bd6481a5a6 --- /dev/null +++ b/packages/args/tsconfig.json @@ -0,0 +1,9 @@ +{ + "extends": "../../tsconfig.json", + "compilerOptions": { + "outDir": "." + }, + "include": [ + "./src/**/*.ts" + ] +}