@flarum/cli 1.0.0 → 2.0.0-beta.12

package/lib/commands/make/backend/validator.d.ts

@@ -1,13 +1,14 @@
-import { StepManager } from '../../../steps/step-manager';
+import { StepManager } from 'boilersmith/step-manager';
+import { FlarumProviders } from '../../../providers';
 import BaseCommand from '../../../base-command';
 export default class Validator extends BaseCommand {
     static description: string;
     static flags: {
-        [x: string]: import("@oclif/command/lib/flags").IFlag<any>;
+        [x: string]: import("@oclif/core/lib/interfaces").CompletableFlag<any>;
     };
     static args: {
         name: string;
         description: string;
     }[];
-    protected steps(stepManager: StepManager): StepManager;
+    protected steps(stepManager: StepManager<FlarumProviders>): StepManager<FlarumProviders>;
 }

package/lib/commands/make/backend/validator.js

@@ -1,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-const base_command_1 = tslib_1.__importDefault(require("../../../base-command"));
+const gen_ext_scaffolder_1 = require("../../../steps/gen-ext-scaffolder");
+const base_command_1 = (0, tslib_1.__importDefault)(require("../../../base-command"));
 const validator_1 = require("../../../steps/stubs/backend/validator");
 class Validator extends base_command_1.default {
     steps(stepManager) {
-        return stepManager.step(new validator_1.GenerateValidatorStub());
+        return stepManager.step(new validator_1.GenerateValidatorStub(this.STUB_PATH, (0, gen_ext_scaffolder_1.genExtScaffolder)()));
     }
 }
 exports.default = Validator;

package/lib/commands/make/frontend/component.d.ts

@@ -1,13 +1,14 @@
-import { StepManager } from '../../../steps/step-manager';
+import { StepManager } from 'boilersmith/step-manager';
+import { FlarumProviders } from '../../../providers';
 import BaseCommand from '../../../base-command';
 export default class Component extends BaseCommand {
     static description: string;
     static flags: {
-        [x: string]: import("@oclif/command/lib/flags").IFlag<any>;
+        [x: string]: import("@oclif/core/lib/interfaces").CompletableFlag<any>;
     };
     static args: {
         name: string;
         description: string;
     }[];
-    protected steps(stepManager: StepManager): StepManager;
+    protected steps(stepManager: StepManager<FlarumProviders>): StepManager<FlarumProviders>;
 }

package/lib/commands/make/frontend/component.js

@@ -1,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-const base_command_1 = tslib_1.__importDefault(require("../../../base-command"));
+const gen_ext_scaffolder_1 = require("../../../steps/gen-ext-scaffolder");
+const base_command_1 = (0, tslib_1.__importDefault)(require("../../../base-command"));
 const component_1 = require("../../../steps/stubs/frontend/component");
 class Component extends base_command_1.default {
     steps(stepManager) {
-        return stepManager.step(new component_1.GenerateComponentStub());
+        return stepManager.step(new component_1.GenerateComponentStub(this.STUB_PATH, (0, gen_ext_scaffolder_1.genExtScaffolder)()));
     }
 }
 exports.default = Component;

package/lib/commands/make/frontend/modal.d.ts

@@ -1,13 +1,14 @@
-import { StepManager } from '../../../steps/step-manager';
+import { StepManager } from 'boilersmith/step-manager';
+import { FlarumProviders } from '../../../providers';
 import BaseCommand from '../../../base-command';
 export default class Modal extends BaseCommand {
     static description: string;
     static flags: {
-        [x: string]: import("@oclif/command/lib/flags").IFlag<any>;
+        [x: string]: import("@oclif/core/lib/interfaces").CompletableFlag<any>;
     };
     static args: {
         name: string;
         description: string;
     }[];
-    protected steps(stepManager: StepManager): StepManager;
+    protected steps(stepManager: StepManager<FlarumProviders>): StepManager<FlarumProviders>;
 }

package/lib/commands/make/frontend/modal.js

@@ -1,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-const base_command_1 = tslib_1.__importDefault(require("../../../base-command"));
+const gen_ext_scaffolder_1 = require("../../../steps/gen-ext-scaffolder");
+const base_command_1 = (0, tslib_1.__importDefault)(require("../../../base-command"));
 const modal_1 = require("../../../steps/stubs/frontend/modal");
 class Modal extends base_command_1.default {
     steps(stepManager) {
-        return stepManager.step(new modal_1.GenerateModalStub());
+        return stepManager.step(new modal_1.GenerateModalStub(this.STUB_PATH, (0, gen_ext_scaffolder_1.genExtScaffolder)()));
     }
 }
 exports.default = Modal;

package/lib/commands/make/frontend/model.d.ts

@@ -1,13 +1,14 @@
-import { StepManager } from '../../../steps/step-manager';
+import { StepManager } from 'boilersmith/step-manager';
 import BaseCommand from '../../../base-command';
+import { FlarumProviders } from '../../../providers';
 export default class Model extends BaseCommand {
     static description: string;
     static flags: {
-        [x: string]: import("@oclif/command/lib/flags").IFlag<any>;
+        [x: string]: import("@oclif/core/lib/interfaces").CompletableFlag<any>;
     };
     static args: {
         name: string;
         description: string;
     }[];
-    protected steps(stepManager: StepManager): StepManager;
+    protected steps(stepManager: StepManager<FlarumProviders>): StepManager<FlarumProviders>;
 }

package/lib/commands/make/frontend/model.js

@@ -1,15 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-const base_command_1 = tslib_1.__importDefault(require("../../../base-command"));
+const base_command_1 = (0, tslib_1.__importDefault)(require("../../../base-command"));
 const model_1 = require("../../../steps/stubs/frontend/model");
 const model_2 = require("../../../steps/js/model");
+const gen_ext_scaffolder_1 = require("../../../steps/gen-ext-scaffolder");
 class Model extends base_command_1.default {
     steps(stepManager) {
         return stepManager
             .atomicGroup(stepManager => {
             stepManager
-                .namedStep('model', new model_1.GenerateModelStub())
+                .namedStep('model', new model_1.GenerateModelStub(this.STUB_PATH, (0, gen_ext_scaffolder_1.genExtScaffolder)()))
                 .step(new model_2.GenerateModelDefinition(), {}, [
                 {
                     sourceStep: 'model',

package/lib/commands/update/js-imports.d.ts

@@ -1,14 +1,15 @@
-import { StepManager } from '../../steps/step-manager';
+import { StepManager } from 'boilersmith/step-manager';
 import BaseCommand from '../../base-command';
+import { FlarumProviders } from '../../providers';
 export default class UpdateJsImports extends BaseCommand {
     static description: string;
     static flags: {
-        [x: string]: import("@oclif/command/lib/flags").IFlag<any>;
+        [x: string]: import("@oclif/core/lib/interfaces").CompletableFlag<any>;
     };
     static args: {
         name: string;
         description: string;
     }[];
-    protected steps(stepManager: StepManager): StepManager;
+    protected steps(stepManager: StepManager<FlarumProviders>): StepManager<FlarumProviders>;
     protected additionalPreRunChecks(extRoot: string): Promise<void>;
 }

package/lib/commands/update/js-imports.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const js_imports_1 = require("../../steps/update/js-imports");
-const base_command_1 = tslib_1.__importDefault(require("../../base-command"));
+const base_command_1 = (0, tslib_1.__importDefault)(require("../../base-command"));
 class UpdateJsImports extends base_command_1.default {
     steps(stepManager) {
         return stepManager

package/lib/help.d.ts

@@ -1,9 +1,8 @@
-import { Command, Topic } from '@oclif/config';
-import { Help as HelpDefault } from '@oclif/plugin-help';
+import { Interfaces, Help as HelpDefault } from '@oclif/core';
 export default class Help extends HelpDefault {
     protected formatRoot(): string;
-    protected formatCommand(command: Command): string;
-    protected formatCommands(commands: Command[]): string;
-    protected formatTopic(topic: Topic): string;
-    protected formatTopics(topics: Topic[]): string;
+    protected formatCommand(command: Interfaces.Command): string;
+    protected formatCommands(commands: Interfaces.Command[]): string;
+    protected formatTopic(topic: Interfaces.Topic): string;
+    protected formatTopics(topics: Interfaces.Topic[]): string;
 }

package/lib/help.js

@@ -1,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-const plugin_help_1 = require("@oclif/plugin-help");
-const chalk_1 = tslib_1.__importDefault(require("chalk"));
+const core_1 = require("@oclif/core");
+const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
 const COLON_REGEX = /:/g;
 function prepCommand(command) {
-    return Object.assign({}, command, { id: chalk_1.default.green(command.id.replace(COLON_REGEX, ' ')) });
+    var _a, _b;
+    return Object.assign({}, command, { id: chalk_1.default.green((_b = (_a = command.id) === null || _a === void 0 ? void 0 : _a.replace(COLON_REGEX, ' ')) !== null && _b !== void 0 ? _b : '') });
 }
 function prepTopic(topic) {
     return Object.assign({}, topic, { name: chalk_1.default.green(topic.name.replace(COLON_REGEX, ' ')) });
@@ -15,7 +16,7 @@ function colorHeaders(text) {
         return chalk_1.default.yellow(match);
     });
 }
-class Help extends plugin_help_1.Help {
+class Help extends core_1.Help {
     formatRoot() {
         return colorHeaders(super.formatRoot());
     }

package/lib/index.d.ts

@@ -1 +1 @@
-export { run } from '@oclif/command';
+export { run } from '@oclif/core';

package/lib/index.js

@@ -1,4 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-var command_1 = require("@oclif/command");
-Object.defineProperty(exports, "run", { enumerable: true, get: function () { return command_1.run; } });
+exports.run = void 0;
+var core_1 = require("@oclif/core");
+Object.defineProperty(exports, "run", { enumerable: true, get: function () { return core_1.run; } });

package/lib/providers/index.d.ts

@@ -0,0 +1,5 @@
+import { DefaultProviders } from 'boilersmith/step-manager';
+import { PhpProvider } from './php-provider';
+export interface FlarumProviders extends DefaultProviders {
+    php: PhpProvider;
+}

package/lib/providers/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/{provider → providers}/php-provider.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PhpSubsystemProvider = exports.ParamTypeType = exports.ExpressionType = void 0;
-const child_process_1 = require("child_process");
+const node_child_process_1 = require("node:child_process");
 var ExpressionType;
 (function (ExpressionType) {
     ExpressionType["SCALAR"] = "scalar";
@@ -24,7 +24,7 @@ class PhpSubsystemProvider {
             op: 'extender.add',
             params: extenderDef,
         });
-        const res = child_process_1.execSync(`php ${this.phpPath}`, { input });
+        const res = (0, node_child_process_1.execSync)(`php ${this.phpPath}`, { input });
         if (!res) {
             throw new Error(`The PHP subsystem returned an invalid value: ${res}`);
         }

package/lib/steps/extenders/api-serializer.js

@@ -2,10 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GenerateApiSerializerAttributesExtender = void 0;
 const tslib_1 = require("tslib");
-/* eslint-disable no-template-curly-in-string */
-const chalk_1 = tslib_1.__importDefault(require("chalk"));
+const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
 const validation_1 = require("../../utils/validation");
-const php_provider_1 = require("../../provider/php-provider");
+const php_provider_1 = require("../../providers/php-provider");
 const base_1 = require("./base");
 class GenerateApiSerializerAttributesExtender extends base_1.BaseExtenderStep {
     constructor() {

package/lib/steps/extenders/base.d.ts

@@ -1,24 +1,24 @@
 import { Store } from 'mem-fs';
-import { PromptObject } from 'prompts';
-import { ParamProvider } from '../../provider/param-provider';
-import { PathProvider } from '../../provider/path-provider';
-import { ExtenderDef, PhpProvider } from '../../provider/php-provider';
-import { Step } from '../step-manager';
-interface UserProvidedParam extends Omit<PromptObject, 'type'> {
+import { ParamDef, IO } from 'boilersmith/io';
+import { Paths } from 'boilersmith/paths';
+import { ExtenderDef } from '../../providers/php-provider';
+import { Step } from 'boilersmith/step-manager';
+import { FlarumProviders } from '../../providers';
+interface UserProvidedParam extends Omit<ParamDef, 'type'> {
     type: string;
 }
 export interface ExtenderGenerationSchema {
     extenderDef: ExtenderDef;
     params: UserProvidedParam[];
 }
-export declare abstract class BaseExtenderStep implements Step {
+export declare abstract class BaseExtenderStep implements Step<FlarumProviders> {
     abstract type: string;
     protected abstract schema: ExtenderGenerationSchema;
     composable: boolean;
     exposes: never[];
-    getExposed(): {};
+    getExposed(): Record<string, unknown>;
     protected params: Record<string, unknown>;
-    run(fs: Store, pathProvider: PathProvider, paramProvider: ParamProvider, phpProvider: PhpProvider): Promise<Store>;
-    protected compileParams(paramProvider: ParamProvider): Promise<Record<string, unknown>>;
+    run(fs: Store, paths: Paths, io: IO, providers: FlarumProviders): Promise<Store>;
+    protected compileParams(io: IO): Promise<Record<string, unknown>>;
 }
 export {};

package/lib/steps/extenders/base.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseExtenderStep = void 0;
 const mem_fs_editor_1 = require("mem-fs-editor");
-const clone_and_fill_1 = require("../../utils/clone-and-fill");
+const clone_and_fill_1 = require("boilersmith/utils/clone-and-fill");
 class BaseExtenderStep {
     constructor() {
         this.composable = true;
@@ -11,21 +11,21 @@ class BaseExtenderStep {
     getExposed() {
         return {};
     }
-    async run(fs, pathProvider, paramProvider, phpProvider) {
-        const fsEditor = mem_fs_editor_1.create(fs);
-        this.params = await this.compileParams(paramProvider);
-        const filledExtenderDef = clone_and_fill_1.cloneAndFill(this.schema.extenderDef, this.params);
-        const currExtendPhp = fsEditor.read(pathProvider.ext('extend.php'));
-        const newExtendPhp = phpProvider.withExtender(currExtendPhp, filledExtenderDef);
-        fsEditor.write(pathProvider.ext('extend.php'), newExtendPhp);
+    async run(fs, paths, io, providers) {
+        const fsEditor = (0, mem_fs_editor_1.create)(fs);
+        this.params = await this.compileParams(io);
+        const filledExtenderDef = (0, clone_and_fill_1.cloneAndFill)(this.schema.extenderDef, this.params);
+        const currExtendPhp = fsEditor.read(paths.package('extend.php'));
+        const newExtendPhp = providers.php.withExtender(currExtendPhp, filledExtenderDef);
+        fsEditor.write(paths.package('extend.php'), newExtendPhp);
         return fs;
     }
-    async compileParams(paramProvider) {
+    async compileParams(io) {
         const params = {};
         const paramDefs = this.schema.params;
-        for (let i = 0; i < paramDefs.length; i++) {
+        for (const paramDef of paramDefs) {
             // eslint-disable-next-line no-await-in-loop
-            params[paramDefs[i].name] = await paramProvider.get(paramDefs[i]);
+            params[paramDef.name] = await io.getParam(paramDef);
         }
         return params;
     }

package/lib/steps/extenders/console-command.js

@@ -2,11 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GenerateConsoleCommandExtender = void 0;
 const tslib_1 = require("tslib");
-/* eslint-disable no-template-curly-in-string */
 const validation_1 = require("../../utils/validation");
-const php_provider_1 = require("../../provider/php-provider");
+const php_provider_1 = require("../../providers/php-provider");
 const base_1 = require("./base");
-const chalk_1 = tslib_1.__importDefault(require("chalk"));
+const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
 class GenerateConsoleCommandExtender extends base_1.BaseExtenderStep {
     constructor() {
         super(...arguments);

package/lib/steps/extenders/event.js

@@ -2,11 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GenerateEventListenerExtender = void 0;
 const tslib_1 = require("tslib");
-/* eslint-disable no-template-curly-in-string */
 const validation_1 = require("../../utils/validation");
-const php_provider_1 = require("../../provider/php-provider");
+const php_provider_1 = require("../../providers/php-provider");
 const base_1 = require("./base");
-const chalk_1 = tslib_1.__importDefault(require("chalk"));
+const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
 class GenerateEventListenerExtender extends base_1.BaseExtenderStep {
     constructor() {
         super(...arguments);

package/lib/steps/extenders/policy.js

@@ -2,11 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GeneratePolicyExtender = void 0;
 const tslib_1 = require("tslib");
-/* eslint-disable no-template-curly-in-string */
 const validation_1 = require("../../utils/validation");
-const php_provider_1 = require("../../provider/php-provider");
+const php_provider_1 = require("../../providers/php-provider");
 const base_1 = require("./base");
-const chalk_1 = tslib_1.__importDefault(require("chalk"));
+const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
 class GeneratePolicyExtender extends base_1.BaseExtenderStep {
     constructor() {
         super(...arguments);

package/lib/steps/extenders/route.js

@@ -2,11 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GenerateRoutesExtender = void 0;
 const tslib_1 = require("tslib");
-/* eslint-disable no-template-curly-in-string */
 const validation_1 = require("../../utils/validation");
-const php_provider_1 = require("../../provider/php-provider");
+const php_provider_1 = require("../../providers/php-provider");
 const base_1 = require("./base");
-const chalk_1 = tslib_1.__importDefault(require("chalk"));
+const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
 class GenerateRoutesExtender extends base_1.BaseExtenderStep {
     constructor() {
         super(...arguments);

package/lib/steps/extenders/service-provider.js

@@ -2,11 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GenerateServiceProviderExtender = void 0;
 const tslib_1 = require("tslib");
-/* eslint-disable no-template-curly-in-string */
 const validation_1 = require("../../utils/validation");
-const php_provider_1 = require("../../provider/php-provider");
+const php_provider_1 = require("../../providers/php-provider");
 const base_1 = require("./base");
-const chalk_1 = tslib_1.__importDefault(require("chalk"));
+const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
 class GenerateServiceProviderExtender extends base_1.BaseExtenderStep {
     constructor() {
         super(...arguments);

package/lib/steps/gen-ext-scaffolder.d.ts

@@ -0,0 +1,6 @@
+import { Scaffolder } from 'boilersmith/scaffolding/scaffolder';
+export declare const EXTENSION_PARAMS: readonly ["packageName", "packageDescription", "packageNamespace", "authorName", "authorEmail", "extensionName", "licenseType", "mainGitBranch", "licenseText", "packageNamespaceEscapedSlash", "extensionId", "year", "backendDirectory", "frontendDirectory"];
+export declare type ExtensionParams = typeof EXTENSION_PARAMS[number];
+export declare const EXTENSION_MODULES: readonly ["core", "icon", "admin", "forum", "js", "jsCommon", "css", "locale", "gitConf", "githubActions", "prettier", "typescript", "bundlewatch", "backendTesting", "editorConfig", "styleci"];
+export declare type ExtensionModules = typeof EXTENSION_MODULES[number];
+export declare function genExtScaffolder(): Scaffolder<ExtensionParams, ExtensionModules>;