@flarum/cli 2.0.2 → 3.0.1

package/lib/steps/locale/base.js

@@ -0,0 +1,97 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setNested = exports.LocaleStep = void 0;
+const tslib_1 = require("tslib");
+const mem_fs_editor_1 = require("mem-fs-editor");
+const path_1 = require("path");
+const yaml_1 = tslib_1.__importDefault(require("yaml"));
+class LocaleStep {
+    getExposed() {
+        return {};
+    }
+    constructor(scaffolder) {
+        this.type = 'Generate key-value locale pair';
+        this.composable = true;
+        this.exposes = [];
+        this.scaffolder = scaffolder;
+    }
+    async run(fs, paths, io, _providers) {
+        const fsEditor = (0, mem_fs_editor_1.create)(fs);
+        this.params = await this.compileParams(fs, paths, io);
+        let path;
+        if (fsEditor.exists(paths.package('resources/locale/en.yml'))) {
+            path = paths.package('resources/locale/en.yml');
+        }
+        else {
+            path = paths.package('locale/en.yml');
+            // Ensure locale/en.yml exists
+            if (!fsEditor.exists(path)) {
+                const stubFilePath = (0, path_1.resolve)(__dirname, `../../../boilerplate/skeleton/extension/locale/en.yml`);
+                fsEditor.copyTpl(stubFilePath, path, { params: this.params });
+            }
+        }
+        const doc = yaml_1.default.parseDocument(fsEditor.read(path));
+        const key = this.params.key.split('.')[0] === this.params.extensionId ? this.params.key : `${this.params.extensionId}.${this.params.key}`;
+        const keys = key.split('.');
+        const keyPath = [];
+        try {
+            // eslint-disable-next-line guard-for-in
+            for (const i in keys) {
+                const k = keys[i];
+                if (doc.hasIn(keyPath) && doc.getIn(keyPath) !== null) {
+                    keyPath.push(k);
+                }
+                else {
+                    const remainingKeyPath = keys.slice(Number.parseInt(i, 10));
+                    const remainingAsNestedObject = {};
+                    setNested(remainingKeyPath.join('.'), this.params.value, remainingAsNestedObject);
+                    doc.setIn(keyPath, remainingAsNestedObject);
+                    break;
+                }
+            }
+            if (keyPath.join('.') === key) {
+                doc.setIn(keyPath, this.params.value);
+            }
+        }
+        catch (_a) {
+            // Do nothing
+        }
+        fsEditor.write(path, doc.toString({
+            lineWidth: 200,
+        }));
+        return fs;
+    }
+    async compileParams(fs, paths, io) {
+        const params = {};
+        params.extensionId = await this.scaffolder.templateParamVal('extensionId', fs, paths, io);
+        params.key = await io.getParam({
+            name: 'key',
+            type: 'text',
+            message: 'The nested key of the locale (e.g. `forum.custom_modal.title`).',
+        });
+        params.value = await io.getParam({
+            name: 'value',
+            type: 'text',
+            message: 'The value of the locale.',
+        });
+        return params;
+    }
+}
+exports.LocaleStep = LocaleStep;
+/**
+ * nested key format, e.g: forum.custom_model.title
+ * obj: forum: { custom_modal: title: '' }
+ */
+function setNested(key, value, object) {
+    const keys = key.split('.');
+    let current = object;
+    for (let i = 0; i < keys.length - 1; i++) {
+        const k = keys[i];
+        if (!current[k]) {
+            current[k] = {};
+        }
+        current = current[k];
+    }
+    current[keys[keys.length - 1]] = value;
+}
+exports.setNested = setNested;

package/lib/steps/misc/git.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GitInit = void 0;
 const tslib_1 = require("tslib");
-const simple_git_1 = (0, tslib_1.__importDefault)(require("simple-git"));
+const simple_git_1 = tslib_1.__importDefault(require("simple-git"));
 class GitInit {
     constructor() {
         this.type = 'Run git init';

package/lib/steps/monorepo/create.d.ts

@@ -5,6 +5,8 @@ import { Step } from 'boilersmith/step-manager';
 import { FlarumProviders } from '../../providers';
 import { Scaffolder } from 'boilersmith/scaffolding/scaffolder';
 import { ExtensionModules, ExtensionParams } from '../gen-ext-scaffolder';
+import { CommitResult } from 'simple-git';
+export declare function commitAll(cwd: string, message: string | string[]): Promise<CommitResult>;
 export declare class MonorepoCreate implements Step<FlarumProviders> {
     type: string;
     composable: boolean;

package/lib/steps/monorepo/create.js

@@ -1,16 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MonorepoCreate = void 0;
+exports.MonorepoCreate = exports.commitAll = void 0;
 const tslib_1 = require("tslib");
 /* eslint-disable no-await-in-loop */
 const child_process_1 = require("child_process");
 const monorepo_1 = require("../../utils/monorepo");
 const cond_format_1 = require("boilersmith/utils/cond-format");
-const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
 const fs_1 = require("fs");
 const path_1 = require("path");
 const os_1 = require("os");
-const simple_git_1 = (0, tslib_1.__importDefault)(require("simple-git"));
+const simple_git_1 = tslib_1.__importDefault(require("simple-git"));
 const mem_fs_editor_1 = require("mem-fs-editor");
 const commit_async_1 = require("boilersmith/utils/commit-async");
 const validation_1 = require("../../utils/validation");
@@ -97,8 +97,9 @@ async function getMonorepoConf(io, monorepoConfPath) {
 }
 async function commitAll(cwd, message) {
     await (0, simple_git_1.default)(cwd).add('.');
-    await (0, simple_git_1.default)(cwd).commit(message);
+    return (0, simple_git_1.default)(cwd).commit(message);
 }
+exports.commitAll = commitAll;
 class MonorepoCreate {
     constructor(scaffolder, monorepoConfPath) {
         this.type = 'Create a monorepo of Flarum extensions';

package/lib/steps/monorepo/split.js

@@ -4,7 +4,7 @@ exports.MonorepoSplit = void 0;
 const tslib_1 = require("tslib");
 const child_process_1 = require("child_process");
 const path_1 = require("path");
-const simple_git_1 = (0, tslib_1.__importDefault)(require("simple-git"));
+const simple_git_1 = tslib_1.__importDefault(require("simple-git"));
 const monorepo_1 = require("../../utils/monorepo");
 async function addRemote(cwd, name, remote) {
     try {

package/lib/steps/stubs/backend/advanced-api-resource.d.ts

@@ -0,0 +1,13 @@
+import { IO } from 'boilersmith/io';
+import { Paths } from 'boilersmith/paths';
+import { BasePhpStubStep } from '../php-base';
+import { Store } from 'mem-fs';
+import { StubGenerationSchema } from 'boilersmith/steps/stub-base';
+export declare class GenerateAdvancedApiResourceStub extends BasePhpStubStep {
+    type: string;
+    protected additionalExposes: string[];
+    protected additionalImplicitParams: string[];
+    protected phpClassParams: string[];
+    protected schema: StubGenerationSchema;
+    protected compileParams(fs: Store, paths: Paths, io: IO): Promise<Record<string, unknown>>;
+}

package/lib/steps/stubs/backend/advanced-api-resource.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GenerateAdvancedApiResourceStub = void 0;
+const tslib_1 = require("tslib");
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
+const validation_1 = require("../../../utils/validation");
+const model_name_1 = require("../../../utils/model-name");
+const php_base_1 = require("../php-base");
+class GenerateAdvancedApiResourceStub extends php_base_1.BasePhpStubStep {
+    constructor() {
+        super(...arguments);
+        this.type = 'Generate Api Resource Class';
+        this.additionalExposes = ['className', 'modelClass', 'modelClassName', 'modelType'];
+        this.additionalImplicitParams = ['modelType'];
+        this.phpClassParams = ['modelClass'];
+        this.schema = {
+            recommendedSubdir: 'Api/Resource',
+            sourceFile: 'backend/advanced-api-resource.php',
+            params: [
+                {
+                    name: 'className',
+                    type: 'text',
+                    message: 'Resource class name',
+                    validate: validation_1.Validator.className,
+                },
+                {
+                    name: 'classNamespace',
+                    type: 'text',
+                    message: 'Class Namespace',
+                },
+                {
+                    name: 'modelClass',
+                    type: 'text',
+                    message: `Model Class (${chalk_1.default.dim('Vendor\\Path\\Model')})`,
+                    validate: validation_1.Validator.class,
+                },
+                {
+                    name: 'modelClassName',
+                    type: 'text',
+                    message: 'Model class name',
+                },
+                {
+                    name: 'modelType',
+                    type: 'text',
+                    message: 'Model type',
+                },
+                {
+                    name: 'endpoints',
+                    type: 'multiselect',
+                    message: 'Endpoints',
+                    choices: [
+                        { title: 'index', value: 'index', selected: true },
+                        { title: 'show', value: 'show', selected: true },
+                        { title: 'create', value: 'create', selected: true },
+                        { title: 'update', value: 'update', selected: true },
+                        { title: 'delete', value: 'delete', selected: true },
+                    ],
+                },
+                {
+                    name: 'relations',
+                    type: 'multiselect',
+                    message: 'Relations',
+                },
+            ],
+        };
+    }
+    async compileParams(fs, paths, io) {
+        const params = await super.compileParams(fs, paths, io);
+        const interfaceMap = {
+            list: 'Resource\\Contracts\\Listable',
+            show: 'Resource\\Contracts\\Findable',
+            create: 'Resource\\Contracts\\Creatable',
+            update: 'Resource\\Contracts\\Updatable',
+            delete: 'Resource\\Contracts\\Deletable',
+        };
+        params.modelType || (params.modelType = (0, model_name_1.pluralKebabCaseModel)(params.modelClassName));
+        params.interfaces = params.endpoints.map((endpoint) => interfaceMap[endpoint]);
+        return params;
+    }
+}
+exports.GenerateAdvancedApiResourceStub = GenerateAdvancedApiResourceStub;

package/lib/steps/stubs/backend/{api-serializer.d.ts → api-resource.d.ts}

@@ -3,7 +3,7 @@ import { Paths } from 'boilersmith/paths';
 import { Validator } from '../../../utils/validation';
 import { BasePhpStubStep } from '../php-base';
 import { Store } from 'mem-fs';
-export declare class GenerateApiSerializerStub extends BasePhpStubStep {
+export declare class GenerateApiResourceStub extends BasePhpStubStep {
     type: string;
     protected additionalExposes: string[];
     protected additionalImplicitParams: string[];

package/lib/steps/stubs/backend/{api-serializer.js → api-resource.js}

@@ -1,26 +1,26 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GenerateApiSerializerStub = void 0;
+exports.GenerateApiResourceStub = void 0;
 const tslib_1 = require("tslib");
-const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
 const validation_1 = require("../../../utils/validation");
 const model_name_1 = require("../../../utils/model-name");
 const php_base_1 = require("../php-base");
-class GenerateApiSerializerStub extends php_base_1.BasePhpStubStep {
+class GenerateApiResourceStub extends php_base_1.BasePhpStubStep {
     constructor() {
         super(...arguments);
-        this.type = 'Generate Api Serializer Class';
-        this.additionalExposes = ['className', 'modelClass', 'modelClassName'];
+        this.type = 'Generate Api Resource Class';
+        this.additionalExposes = ['className', 'modelClass', 'modelClassName', 'modelType'];
         this.additionalImplicitParams = ['modelType'];
         this.phpClassParams = ['modelClass'];
         this.schema = {
-            recommendedSubdir: 'Api/Serializer',
-            sourceFile: 'backend/api-serializer.php',
+            recommendedSubdir: 'Api/Resource',
+            sourceFile: 'backend/api-resource.php',
             params: [
                 {
                     name: 'className',
                     type: 'text',
-                    message: 'Serializer class name',
+                    message: 'Resource class name',
                     validate: validation_1.Validator.className,
                 },
                 {
@@ -53,4 +53,4 @@ class GenerateApiSerializerStub extends php_base_1.BasePhpStubStep {
         return params;
     }
 }
-exports.GenerateApiSerializerStub = GenerateApiSerializerStub;
+exports.GenerateApiResourceStub = GenerateApiResourceStub;

package/lib/steps/stubs/backend/command.d.ts

@@ -1,22 +1,8 @@
-import { Validator } from '../../../utils/validation';
 import { BasePhpStubStep } from '../php-base';
+import { StubGenerationSchema } from 'boilersmith/steps/stub-base';
 export declare class GenerateCommandStub extends BasePhpStubStep {
     type: string;
     protected additionalExposes: never[];
     protected phpClassParams: never[];
-    protected schema: {
-        recommendedSubdir: string;
-        sourceFile: string;
-        params: ({
-            name: string;
-            type: string;
-            message: string;
-            validate: typeof Validator.className;
-        } | {
-            name: string;
-            type: string;
-            message: string;
-            validate?: undefined;
-        })[];
-    };
+    protected schema: StubGenerationSchema;
 }

package/lib/steps/stubs/backend/command.js

@@ -2,9 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GenerateCommandStub = void 0;
 const tslib_1 = require("tslib");
-const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
 const validation_1 = require("../../../utils/validation");
 const php_base_1 = require("../php-base");
+const string_1 = tslib_1.__importDefault(require("string"));
 class GenerateCommandStub extends php_base_1.BasePhpStubStep {
     constructor() {
         super(...arguments);
@@ -31,11 +32,23 @@ class GenerateCommandStub extends php_base_1.BasePhpStubStep {
                     type: 'text',
                     message: `Command name (${chalk_1.default.dim('namespace:command')})`,
                     validate: validation_1.Validator.commandName,
+                    initial: (_prev, params) => {
+                        const extensionId = params.get('extensionId');
+                        const command = (0, string_1.default)(params.get('className'))
+                            .underscore()
+                            .dasherize()
+                            .toString()
+                            .replace(/-command$/, '');
+                        return `${extensionId}:${command}`;
+                    },
                 },
                 {
                     name: 'commandDescription',
                     type: 'text',
                     message: 'Command description',
+                    initial: (_prev, params) => (0, string_1.default)(params.get('className'))
+                        .humanize()
+                        .toString(),
                 },
             ],
         };

package/lib/steps/stubs/backend/{api-controller.d.ts → controller.d.ts}

@@ -1,9 +1,9 @@
 import { Validator } from '../../../utils/validation';
 import { BasePhpStubStep } from '../php-base';
-export declare class GenerateApiControllerStub extends BasePhpStubStep {
+export declare class GenerateControllerStub extends BasePhpStubStep {
     type: string;
-    protected additionalExposes: never[];
-    protected phpClassParams: string[];
+    protected additionalExposes: string[];
+    protected phpClassParams: never[];
     protected schema: {
         recommendedSubdir: string;
         sourceFile: string;
@@ -13,14 +13,12 @@ export declare class GenerateApiControllerStub extends BasePhpStubStep {
             message: string;
             validate: typeof Validator.className;
             choices?: undefined;
-            optional?: undefined;
         } | {
             name: string;
             type: string;
             message: string;
             validate?: undefined;
             choices?: undefined;
-            optional?: undefined;
         } | {
             name: string;
             type: string;
@@ -30,14 +28,6 @@ export declare class GenerateApiControllerStub extends BasePhpStubStep {
                 value: string;
             }[];
             validate?: undefined;
-            optional?: undefined;
-        } | {
-            name: string;
-            type: string;
-            message: string;
-            validate: typeof Validator.optionalClass;
-            optional: boolean;
-            choices?: undefined;
         })[];
     };
 }

package/lib/steps/stubs/backend/controller.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GenerateControllerStub = void 0;
+const validation_1 = require("../../../utils/validation");
+const php_base_1 = require("../php-base");
+class GenerateControllerStub extends php_base_1.BasePhpStubStep {
+    constructor() {
+        super(...arguments);
+        this.type = 'Generate Controller Class';
+        this.additionalExposes = ['frontend'];
+        this.phpClassParams = [];
+        this.schema = {
+            recommendedSubdir: 'Controller',
+            sourceFile: 'backend/controller.php',
+            params: [
+                {
+                    name: 'className',
+                    type: 'text',
+                    message: 'Controller class name',
+                    validate: validation_1.Validator.className,
+                },
+                {
+                    name: 'classNamespace',
+                    type: 'text',
+                    message: 'Class Namespace',
+                },
+                {
+                    name: 'frontend',
+                    type: 'autocomplete',
+                    message: 'Controller type/frontend',
+                    choices: ['forum', 'admin', 'api'].map((type) => ({
+                        title: type,
+                        value: type.toLowerCase(),
+                    })),
+                },
+            ],
+        };
+    }
+}
+exports.GenerateControllerStub = GenerateControllerStub;

package/lib/steps/stubs/backend/event-listener.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GenerateEventListenerStub = void 0;
 const tslib_1 = require("tslib");
-const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
 const validation_1 = require("../../../utils/validation");
 const php_base_1 = require("../php-base");
 class GenerateEventListenerStub extends php_base_1.BasePhpStubStep {

package/lib/steps/stubs/backend/filter.d.ts

@@ -0,0 +1,8 @@
+import { BasePhpStubStep } from '../php-base';
+import { StubGenerationSchema } from 'boilersmith/steps/stub-base';
+export declare class GenerateFilterStub extends BasePhpStubStep {
+    type: string;
+    protected additionalExposes: string[];
+    phpClassParams: string[];
+    protected schema: StubGenerationSchema;
+}

package/lib/steps/stubs/backend/filter.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GenerateFilterStub = void 0;
+const tslib_1 = require("tslib");
+const validation_1 = require("../../../utils/validation");
+const php_base_1 = require("../php-base");
+const string_1 = tslib_1.__importDefault(require("string"));
+class GenerateFilterStub extends php_base_1.BasePhpStubStep {
+    constructor() {
+        super(...arguments);
+        this.type = 'Generate a filter Class';
+        this.additionalExposes = ['filterClass'];
+        this.phpClassParams = ['filterClass'];
+        this.schema = {
+            recommendedSubdir: 'Search',
+            sourceFile: 'backend/filter.php',
+            params: [
+                {
+                    name: 'className',
+                    type: 'text',
+                    message: 'Filter class name',
+                    validate: validation_1.Validator.className,
+                },
+                {
+                    name: 'classNamespace',
+                    type: 'text',
+                    message: 'Class Namespace',
+                },
+                {
+                    name: 'filterKey',
+                    type: 'text',
+                    message: 'Filter key',
+                    validate: validation_1.Validator.alphaNumeric,
+                    initial: (_prev, params) => (0, string_1.default)(params.get('className'))
+                        .underscore()
+                        .camelize()
+                        .toString()
+                        .replace(/Filter$/, ''),
+                },
+            ],
+        };
+    }
+}
+exports.GenerateFilterStub = GenerateFilterStub;

package/lib/steps/stubs/backend/handler-command.d.ts

@@ -1,33 +1,8 @@
-import { Validator } from '../../../utils/validation';
 import { BasePhpStubStep } from '../php-base';
+import { StubGenerationSchema } from 'boilersmith/steps/stub-base';
 export declare class GenerateHandlerCommandStub extends BasePhpStubStep {
     type: string;
     protected additionalExposes: string[];
     protected phpClassParams: never[];
-    protected schema: {
-        recommendedSubdir: string;
-        sourceFile: string;
-        params: ({
-            name: string;
-            type: string;
-            message: string;
-            validate: typeof Validator.className;
-            choices?: undefined;
-        } | {
-            name: string;
-            type: string;
-            message: string;
-            validate?: undefined;
-            choices?: undefined;
-        } | {
-            name: string;
-            type: string;
-            message: string;
-            choices: {
-                title: string;
-                value: string;
-            }[];
-            validate?: undefined;
-        })[];
-    };
+    protected schema: StubGenerationSchema;
 }

package/lib/steps/stubs/backend/handler-command.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GenerateHandlerCommandStub = void 0;
 const tslib_1 = require("tslib");
-const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
 const validation_1 = require("../../../utils/validation");
 const php_base_1 = require("../php-base");
 class GenerateHandlerCommandStub extends php_base_1.BasePhpStubStep {
@@ -33,6 +33,7 @@ class GenerateHandlerCommandStub extends php_base_1.BasePhpStubStep {
                     choices: ['None', 'Create', 'Update', 'Delete'].map((type) => ({
                         title: type,
                         value: type.toLowerCase(),
+                        selected: type === 'None',
                     })),
                 },
             ],

package/lib/steps/stubs/backend/handler.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.GenerateHandlerStub = void 0;
 const tslib_1 = require("tslib");
 /* eslint-disable no-warning-comments */
-const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
 const validation_1 = require("../../../utils/validation");
 const php_base_1 = require("../php-base");
 class GenerateHandlerStub extends php_base_1.BasePhpStubStep {

package/lib/steps/stubs/backend/integration-test.js

@@ -25,11 +25,6 @@ class GenerateIntegrationTestStub extends php_base_1.BasePhpStubStep {
                     type: 'text',
                     message: 'Class Namespace',
                 },
-                {
-                    name: 'extensionId',
-                    type: 'text',
-                    message: 'Extension Id',
-                },
             ],
         };
     }

package/lib/steps/stubs/backend/mail-driver.d.ts

@@ -0,0 +1,7 @@
+import { BasePhpStubStep } from '../php-base';
+import { StubGenerationSchema } from 'boilersmith/steps/stub-base';
+export declare class GenerateMailDriverStub extends BasePhpStubStep {
+    type: string;
+    additionalExposes: string[];
+    protected schema: StubGenerationSchema;
+}

package/lib/steps/stubs/backend/mail-driver.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GenerateMailDriverStub = void 0;
+const validation_1 = require("../../../utils/validation");
+const php_base_1 = require("../php-base");
+class GenerateMailDriverStub extends php_base_1.BasePhpStubStep {
+    constructor() {
+        super(...arguments);
+        this.type = 'Generate Mail Driver';
+        this.additionalExposes = ['className'];
+        this.schema = {
+            recommendedSubdir: 'Mail',
+            sourceFile: 'backend/mail-driver.php',
+            params: [
+                {
+                    name: 'className',
+                    type: 'text',
+                    message: 'Mail driver class name',
+                    validate: validation_1.Validator.className,
+                },
+                {
+                    name: 'classNamespace',
+                    type: 'text',
+                    message: 'Class Namespace',
+                },
+            ],
+        };
+    }
+}
+exports.GenerateMailDriverStub = GenerateMailDriverStub;

package/lib/steps/stubs/backend/middleware.d.ts

@@ -0,0 +1,22 @@
+import { Validator } from '../../../utils/validation';
+import { BasePhpStubStep } from '../php-base';
+export declare class GenerateMiddlewareStub extends BasePhpStubStep {
+    type: string;
+    protected additionalExposes: string[];
+    protected phpClassParams: never[];
+    protected schema: {
+        recommendedSubdir: string;
+        sourceFile: string;
+        params: ({
+            name: string;
+            type: string;
+            message: string;
+            validate: typeof Validator.className;
+        } | {
+            name: string;
+            type: string;
+            message: string;
+            validate?: undefined;
+        })[];
+    };
+}