Mirroristas/CommunitySolidServer
2
0
Fork 0
mirror of https://github.com/CommunitySolidServer/CommunitySolidServer.git synced 2024-10-03 14:55:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix: Change YargsCliExtractor structure to avoid Components.js issues

Browse Source
This commit is contained in:
Joachim Van Herwegen
2022-04-21 10:54:06 +02:00
parent 1de1f7c12a
commit 6f4e70dbb9
6 changed files with 148 additions and 96 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/identity/interaction/FixedInteractionHandler.ts
View File

@@ -15,7 +15,7 @@ export class FixedInteractionHandler extends InteractionHandler {
/**
* @param response - @range {json}
*/
public constructor(response: unknown) {
public constructor(response: Record<string, unknown>) {
super();
this.response = JSON.stringify(response);
}

41
src/init/cli/YargsCliExtractor.ts
View File

@@ -3,7 +3,28 @@ import type { Arguments, Argv, Options } from 'yargs';
import yargs from 'yargs';
import { CliExtractor } from './CliExtractor';
export type YargsArgOptions = Record<string, Options>;
// This type exists to prevent Components.js from erroring on an unknown type
export type YargsOptions = Options;
/**
* This class exists as wrapper around a yargs Options object,
* thereby allowing us to create these in a Components.js configuration.
*
* Format details can be found at https://yargs.js.org/docs/#api-reference-optionskey-opt
*/
export class YargsParameter {
public readonly name: string;
public readonly options: YargsOptions;
/**
* @param name - Name of the parameter. Corresponds to the first parameter passed to the `yargs.options` function.
* @param options - Options for a single parameter that should be parsed. @range {json}
*/
public constructor(name: string, options: Record<string, any>) {
this.name = name;
this.options = options;
}
}
export interface CliOptions {
// Usage string printed in case of CLI errors
@@ -24,21 +45,21 @@ export interface CliOptions {
* Specific settings can be enabled through the provided options.
*/
export class YargsCliExtractor extends CliExtractor {
protected readonly yargsArgOptions: YargsArgOptions;
protected readonly yargsArgOptions: Record<string, YargsOptions>;
protected readonly yargvOptions: CliOptions;
/**
* @param parameters - Parameters that should be parsed from the CLI. @range {json}
* Format details can be found at https://yargs.js.org/docs/#api-reference-optionskey-opt
* @param parameters - Parameters that should be parsed from the CLI.
* @param options - Additional options to configure yargs. @range {json}
* @param extendedParameters - The same as @parameters. Separate variable so in Components.js
* we can have both a default set and a user-added version. @range {json}
*
* JSON parameters cannot be optional due to https://github.com/LinkedSoftwareDependencies/Components-Generator.js/issues/87
*/
public constructor(parameters: YargsArgOptions = {}, options: CliOptions = {},
extendedParameters: YargsArgOptions = {}) {
public constructor(parameters: YargsParameter[], options: CliOptions) {
super();
this.yargsArgOptions = { ...parameters, ...extendedParameters };
this.yargvOptions = options;
this.yargsArgOptions = Object.fromEntries(
parameters.map((entry): [string, YargsOptions] => [ entry.name, entry.options ]),
);
this.yargvOptions = { ...options };
}
public async handle(argv: readonly string[]): Promise<Arguments> {