@flarum/cli 1.0.0 → 2.0.0-beta.1

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", "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>;