@flarum/cli 2.0.0-beta.11 → 2.0.0-beta.14

package/lib/commands/audit/infra.js

@@ -4,16 +4,38 @@ const tslib_1 = require("tslib");
 const base_command_1 = (0, tslib_1.__importDefault)(require("../../base-command"));
 const gen_ext_scaffolder_1 = require("../../steps/gen-ext-scaffolder");
 const core_1 = require("@oclif/core");
+const yarn_1 = require("../../steps/misc/yarn");
+const composer_1 = require("../../steps/misc/composer");
+const npm_1 = require("../../steps/misc/npm");
 class AuditInfra extends base_command_1.default {
-    steps(stepManager) {
+    steps(stepManager, extRoot) {
         this.dry = !this.flags.fix;
-        const mapPaths = this.flags.monorepo ? this.monorepoPaths({
-            includeCore: true,
-            includeExtensions: true,
-            includePhpPackages: false,
-            includeJSPackages: false,
-        }) : [];
-        stepManager.step((0, gen_ext_scaffolder_1.genExtScaffolder)().genAuditStep(!this.flags.fix), {}, [], {}, mapPaths);
+        const mapPaths = this.flags.monorepo
+            ? this.monorepoPaths({
+                includeCore: true,
+                includeExtensions: true,
+                includePhpPackages: false,
+                includeJSPackages: false,
+            })
+            : [];
+        stepManager.namedStep('audit', (0, gen_ext_scaffolder_1.genExtScaffolder)().genAuditStep(!this.flags.fix), {}, [], {}, mapPaths);
+        if (!this.flags.monorepo && !this.dry) {
+            const packageManager = this.jsPackageManager(extRoot);
+            stepManager.step(packageManager === 'npm' ? new npm_1.NpmInstall() : new yarn_1.YarnInstall(), { optional: true, confirmationMessage: `Run \`${packageManager !== null && packageManager !== void 0 ? packageManager : 'yarn'}\`? (recommended)`, default: true }, [
+                {
+                    sourceStep: 'audit',
+                    exposedName: '__succeeded',
+                    dontRunIfFalsy: true,
+                },
+            ]);
+            stepManager.step(new composer_1.ComposerInstall(), { optional: true, confirmationMessage: 'Run `composer update`? (recommended)', default: true }, [
+                {
+                    sourceStep: 'audit',
+                    exposedName: '__succeeded',
+                    dontRunIfFalsy: true,
+                },
+            ]);
+        }
         return stepManager;
     }
     async additionalPreRunChecks(extRoot) {

package/lib/commands/infra.d.ts

@@ -13,8 +13,8 @@ export default class Infra extends BaseCommand {
         name: string;
         description: string;
         required: boolean;
-        options: ("core" | "icon" | "js" | "jsCommon" | "css" | "locale" | "gitConf" | "githubActions" | "prettier" | "typescript" | "bundlewatch" | "backendTesting" | "editorConfig" | "styleci")[];
+        options: ("core" | "js" | "icon" | "admin" | "forum" | "jsCommon" | "css" | "locale" | "gitConf" | "githubActions" | "prettier" | "typescript" | "bundlewatch" | "backendTesting" | "editorConfig" | "styleci")[];
     })[];
-    protected steps(stepManager: StepManager<FlarumProviders>): StepManager<FlarumProviders>;
+    protected steps(stepManager: StepManager<FlarumProviders>, extRoot: string): StepManager<FlarumProviders>;
     protected additionalPreRunChecks(extRoot: string): Promise<void>;
 }

package/lib/commands/infra.js

@@ -4,23 +4,26 @@ const tslib_1 = require("tslib");
 const composer_1 = require("../steps/misc/composer");
 const base_command_1 = (0, tslib_1.__importDefault)(require("../base-command"));
 const gen_ext_scaffolder_1 = require("../steps/gen-ext-scaffolder");
+const npm_1 = require("../steps/misc/npm");
 const yarn_1 = require("../steps/misc/yarn");
 const core_1 = require("@oclif/core");
 class Infra extends base_command_1.default {
-    steps(stepManager) {
+    steps(stepManager, extRoot) {
         const module = this.args.module;
-        const mapPaths = this.flags.monorepo ? this.monorepoPaths({
-            includeCore: true,
-            includeExtensions: true,
-            includePhpPackages: false,
-            includeJSPackages: false,
-        }) : [];
-        stepManager
-            .namedStep('infra', (0, gen_ext_scaffolder_1.genExtScaffolder)().genInfraStep(this.args.module), {}, [], {}, mapPaths);
+        const mapPaths = this.flags.monorepo
+            ? this.monorepoPaths({
+                includeCore: true,
+                includeExtensions: true,
+                includePhpPackages: false,
+                includeJSPackages: false,
+            })
+            : [];
+        stepManager.namedStep('infra', (0, gen_ext_scaffolder_1.genExtScaffolder)().genInfraStep(this.args.module), {}, [], {}, mapPaths);
         const JS_MODULES = ['js', 'prettier', 'typescript'];
         const PHP_MODULES = ['backendTesting'];
+        const packageManager = this.jsPackageManager(extRoot);
         if (!this.flags.monorepo && JS_MODULES.includes(module)) {
-            stepManager.step(new yarn_1.YarnInstall(), { optional: true, confirmationMessage: 'Run `yarn`? (recommended)', default: true }, [
+            stepManager.step(packageManager === 'npm' ? new npm_1.NpmInstall() : new yarn_1.YarnInstall(), { optional: true, confirmationMessage: `Run \`${packageManager !== null && packageManager !== void 0 ? packageManager : 'yarn'}\`? (recommended)`, default: true }, [
                 {
                     sourceStep: 'infra',
                     exposedName: '__succeeded',
@@ -47,9 +50,12 @@ class Infra extends base_command_1.default {
 exports.default = Infra;
 Infra.description = 'Add/Update infrastructure to the latest scaffolding for some module in an extension. For example, you can use this to add/update TypeScript, backend testing, GitHub Actions, and other features.';
 Infra.flags = Object.assign({ monorepo: core_1.Flags.boolean({ char: 'm', default: false }) }, base_command_1.default.flags);
-Infra.args = [{
+Infra.args = [
+    {
         name: 'module',
         description: 'The name of the module to enable/update.',
         required: true,
         options: [...gen_ext_scaffolder_1.EXTENSION_MODULES],
-    }, ...base_command_1.default.args];
+    },
+    ...base_command_1.default.args,
+];

package/lib/commands/init.d.ts

@@ -11,7 +11,7 @@ export default class Init extends BaseCommand {
         description: string;
     }[];
     protected requireExistingExtension: boolean;
-    protected steps(stepManager: StepManager<FlarumProviders>): StepManager<FlarumProviders>;
+    protected steps(stepManager: StepManager<FlarumProviders>, extRoot: string): StepManager<FlarumProviders>;
     protected welcomeMessage(): string;
     protected goodbyeMessage(): string;
     protected additionalPreRunChecks(extRoot: string): Promise<void>;

package/lib/commands/init.js

@@ -7,17 +7,19 @@ const base_command_1 = (0, tslib_1.__importDefault)(require("../base-command"));
 const yosay_1 = (0, tslib_1.__importDefault)(require("yosay"));
 const gen_ext_scaffolder_1 = require("../steps/gen-ext-scaffolder");
 const git_1 = require("../steps/misc/git");
+const npm_1 = require("../steps/misc/npm");
 class Init extends base_command_1.default {
     constructor() {
         super(...arguments);
         this.requireExistingExtension = false;
     }
-    steps(stepManager) {
+    steps(stepManager, extRoot) {
+        const packageManager = this.jsPackageManager(extRoot);
         return stepManager
             .namedStep('gitInit', new git_1.GitInit(), { optional: true, confirmationMessage: 'Run `git init`? (recommended)', default: true })
             .namedStep('skeleton', (0, gen_ext_scaffolder_1.genExtScaffolder)().genInitStep())
             .step(new composer_1.ComposerInstall(), { optional: true, confirmationMessage: 'Run `composer install`? (recommended)', default: true })
-            .step(new yarn_1.YarnInstall(), { optional: true, confirmationMessage: 'Run `yarn install`? (recommended)', default: true }, [
+            .step(packageManager === 'npm' ? new npm_1.NpmInstall() : new yarn_1.YarnInstall(), { optional: true, confirmationMessage: `Run \`${packageManager !== null && packageManager !== void 0 ? packageManager : 'yarn'}\`? (recommended)`, default: true }, [
             {
                 sourceStep: 'skeleton',
                 exposedName: 'modules.js',

package/lib/commands/make/backend/api-controller.js

@@ -7,8 +7,7 @@ const route_1 = require("../../../steps/extenders/route");
 const gen_ext_scaffolder_1 = require("../../../steps/gen-ext-scaffolder");
 class ApiController extends base_command_1.default {
     steps(stepManager) {
-        return stepManager
-            .atomicGroup(stepManager => {
+        return stepManager.atomicGroup((stepManager) => {
             stepManager
                 .namedStep('apiController', new api_controller_1.GenerateApiControllerStub(this.STUB_PATH, (0, gen_ext_scaffolder_1.genExtScaffolder)()))
                 .step(new route_1.GenerateRoutesExtender(), { optional: true, confirmationMessage: 'Generate corresponding extender?', default: true }, [

package/lib/commands/make/backend/api-serializer-attributes.js

@@ -5,8 +5,7 @@ const base_command_1 = (0, tslib_1.__importDefault)(require("../../../base-comma
 const api_serializer_1 = require("../../../steps/extenders/api-serializer");
 class ApiSerializerAttribute extends base_command_1.default {
     steps(stepManager) {
-        return stepManager
-            .step(new api_serializer_1.GenerateApiSerializerAttributesExtender());
+        return stepManager.step(new api_serializer_1.GenerateApiSerializerAttributesExtender());
     }
 }
 exports.default = ApiSerializerAttribute;

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

@@ -7,8 +7,7 @@ const console_command_1 = require("../../../steps/extenders/console-command");
 const gen_ext_scaffolder_1 = require("../../../steps/gen-ext-scaffolder");
 class Command extends base_command_1.default {
     steps(stepManager) {
-        return stepManager
-            .atomicGroup(stepManager => {
+        return stepManager.atomicGroup((stepManager) => {
             stepManager
                 .namedStep('command', new command_1.GenerateCommandStub(this.STUB_PATH, (0, gen_ext_scaffolder_1.genExtScaffolder)()))
                 .step(new console_command_1.GenerateConsoleCommandExtender(), { optional: true, confirmationMessage: 'Generate corresponding extender?', default: true }, [

package/lib/commands/make/backend/event-listener.js

@@ -7,8 +7,7 @@ const event_1 = require("../../../steps/extenders/event");
 const gen_ext_scaffolder_1 = require("../../../steps/gen-ext-scaffolder");
 class EventListener extends base_command_1.default {
     steps(stepManager) {
-        return stepManager
-            .atomicGroup(stepManager => {
+        return stepManager.atomicGroup((stepManager) => {
             stepManager
                 .namedStep('listener', new event_listener_1.GenerateEventListenerStub(this.STUB_PATH, (0, gen_ext_scaffolder_1.genExtScaffolder)()))
                 .step(new event_1.GenerateEventListenerExtender(), { optional: true, confirmationMessage: 'Generate corresponding extender?', default: true }, [

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

@@ -7,11 +7,8 @@ const handler_1 = require("../../../steps/stubs/backend/handler");
 const gen_ext_scaffolder_1 = require("../../../steps/gen-ext-scaffolder");
 class ApiController extends base_command_1.default {
     steps(stepManager) {
-        return stepManager
-            .atomicGroup(stepManager => {
-            stepManager
-                .namedStep('handlerCommand', new handler_command_1.GenerateHandlerCommandStub(this.STUB_PATH, (0, gen_ext_scaffolder_1.genExtScaffolder)()))
-                .step(new handler_1.GenerateHandlerStub(this.STUB_PATH, (0, gen_ext_scaffolder_1.genExtScaffolder)()), {}, [
+        return stepManager.atomicGroup((stepManager) => {
+            stepManager.namedStep('handlerCommand', new handler_command_1.GenerateHandlerCommandStub(this.STUB_PATH, (0, gen_ext_scaffolder_1.genExtScaffolder)())).step(new handler_1.GenerateHandlerStub(this.STUB_PATH, (0, gen_ext_scaffolder_1.genExtScaffolder)()), {}, [
                 {
                     sourceStep: 'handlerCommand',
                     exposedName: 'className',

package/lib/commands/make/backend/integration-test.js

@@ -6,10 +6,8 @@ const base_command_1 = (0, tslib_1.__importDefault)(require("../../../base-comma
 const integration_test_1 = require("../../../steps/stubs/backend/integration-test");
 class IntegrationTest extends base_command_1.default {
     steps(stepManager) {
-        return stepManager
-            .atomicGroup(stepManager => {
-            stepManager
-                .namedStep('test', new integration_test_1.GenerateIntegrationTestStub(this.STUB_PATH, (0, gen_ext_scaffolder_1.genExtScaffolder)()));
+        return stepManager.atomicGroup((stepManager) => {
+            stepManager.namedStep('test', new integration_test_1.GenerateIntegrationTestStub(this.STUB_PATH, (0, gen_ext_scaffolder_1.genExtScaffolder)()));
         });
     }
 }

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

@@ -6,8 +6,7 @@ const base_command_1 = (0, tslib_1.__importDefault)(require("../../../base-comma
 const migration_1 = require("../../../steps/stubs/backend/migration");
 class Migration extends base_command_1.default {
     steps(stepManager) {
-        return stepManager
-            .step(new migration_1.GenerateMigrationStub(this.STUB_PATH, (0, gen_ext_scaffolder_1.genExtScaffolder)()));
+        return stepManager.step(new migration_1.GenerateMigrationStub(this.STUB_PATH, (0, gen_ext_scaffolder_1.genExtScaffolder)()));
     }
 }
 exports.default = Migration;

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

@@ -18,8 +18,7 @@ const route_1 = require("../../../steps/extenders/route");
 const gen_ext_scaffolder_1 = require("../../../steps/gen-ext-scaffolder");
 class Model extends base_command_1.default {
     steps(stepManager) {
-        return stepManager
-            .atomicGroup(stepManager => {
+        return stepManager.atomicGroup((stepManager) => {
             stepManager
                 .namedStep('model', new model_1.GenerateModelStub(this.STUB_PATH, (0, gen_ext_scaffolder_1.genExtScaffolder)()))
                 .step(new migration_1.GenerateMigrationStub(this.STUB_PATH, (0, gen_ext_scaffolder_1.genExtScaffolder)()), { optional: true, confirmationMessage: 'Generate corresponding Migration?', default: true }, [

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

@@ -7,8 +7,7 @@ const policy_2 = require("../../../steps/extenders/policy");
 const gen_ext_scaffolder_1 = require("../../../steps/gen-ext-scaffolder");
 class Policy extends base_command_1.default {
     steps(stepManager) {
-        return stepManager
-            .atomicGroup(stepManager => {
+        return stepManager.atomicGroup((stepManager) => {
             stepManager
                 .namedStep('policy', new policy_1.GeneratePolicyStub(this.STUB_PATH, (0, gen_ext_scaffolder_1.genExtScaffolder)()))
                 .step(new policy_2.GeneratePolicyExtender(), { optional: true, confirmationMessage: 'Generate corresponding extender?', default: true }, [

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

@@ -5,8 +5,7 @@ const base_command_1 = (0, tslib_1.__importDefault)(require("../../../base-comma
 const route_1 = require("../../../steps/extenders/route");
 class Route extends base_command_1.default {
     steps(stepManager) {
-        return stepManager
-            .step(new route_1.GenerateRoutesExtender());
+        return stepManager.step(new route_1.GenerateRoutesExtender());
     }
 }
 exports.default = Route;

package/lib/commands/make/backend/service-provider.js

@@ -7,8 +7,7 @@ const service_provider_2 = require("../../../steps/extenders/service-provider");
 const gen_ext_scaffolder_1 = require("../../../steps/gen-ext-scaffolder");
 class ServiceProvider extends base_command_1.default {
     steps(stepManager) {
-        return stepManager
-            .atomicGroup(stepManager => {
+        return stepManager.atomicGroup((stepManager) => {
             stepManager
                 .namedStep('provider', new service_provider_1.GenerateServiceProviderStub(this.STUB_PATH, (0, gen_ext_scaffolder_1.genExtScaffolder)()))
                 .step(new service_provider_2.GenerateServiceProviderExtender(), { optional: true, confirmationMessage: 'Generate corresponding extender?', default: true }, [

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

@@ -7,11 +7,8 @@ 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(this.STUB_PATH, (0, gen_ext_scaffolder_1.genExtScaffolder)()))
-                .step(new model_2.GenerateModelDefinition(), {}, [
+        return stepManager.atomicGroup((stepManager) => {
+            stepManager.namedStep('model', new model_1.GenerateModelStub(this.STUB_PATH, (0, gen_ext_scaffolder_1.genExtScaffolder)())).step(new model_2.GenerateModelDefinition(), {}, [
                 {
                     sourceStep: 'model',
                     exposedName: 'frontend',

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

@@ -0,0 +1,15 @@
+import { StepManager } from 'boilersmith/step-manager';
+import BaseCommand from '../../base-command';
+import { FlarumProviders } from '../../providers';
+export default class Create extends BaseCommand {
+    static description: string;
+    static flags: {
+        config: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+    };
+    static args: {
+        name: string;
+        description: string;
+    }[];
+    protected requireExistingExtension: boolean;
+    protected steps(stepManager: StepManager<FlarumProviders>): StepManager<FlarumProviders>;
+}

package/lib/commands/monorepo/create.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const base_command_1 = (0, tslib_1.__importDefault)(require("../../base-command"));
+const core_1 = require("@oclif/core");
+const create_1 = require("../../steps/monorepo/create");
+const gen_ext_scaffolder_1 = require("../../steps/gen-ext-scaffolder");
+class Create extends base_command_1.default {
+    constructor() {
+        super(...arguments);
+        this.requireExistingExtension = false;
+    }
+    steps(stepManager) {
+        return stepManager.step(new create_1.MonorepoCreate((0, gen_ext_scaffolder_1.genExtScaffolder)(), this.flags.config));
+    }
+}
+exports.default = Create;
+Create.description = 'Create a monorepo of Flarum extensions.';
+Create.flags = Object.assign({ config: core_1.Flags.string({ char: 'c', required: false }) }, base_command_1.default.flags);
+Create.args = [...base_command_1.default.args];

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

@@ -5,8 +5,7 @@ const js_imports_1 = require("../../steps/update/js-imports");
 const base_command_1 = (0, tslib_1.__importDefault)(require("../../base-command"));
 class UpdateJsImports extends base_command_1.default {
     steps(stepManager) {
-        return stepManager
-            .step(new js_imports_1.UpdateJSImports());
+        return stepManager.step(new js_imports_1.UpdateJSImports());
     }
     async additionalPreRunChecks(extRoot) {
         await this.ensureComposerInstallRan(extRoot);

package/lib/help.js

@@ -12,7 +12,7 @@ function prepTopic(topic) {
     return Object.assign({}, topic, { name: chalk_1.default.green(topic.name.replace(COLON_REGEX, ' ')) });
 }
 function colorHeaders(text) {
-    return text.replace(/(TOPICS|TOPIC|DESCRIPTION|USAGE|COMMANDS|VERSION|ARGUMENTS|OPTIONS)/g, match => {
+    return text.replace(/(TOPICS|TOPIC|DESCRIPTION|USAGE|COMMANDS|VERSION|ARGUMENTS|OPTIONS)/g, (match) => {
         return chalk_1.default.yellow(match);
     });
 }

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

@@ -1,6 +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 const EXTENSION_PARAMS: readonly ["packageName", "packageDescription", "packageNamespace", "authorName", "authorEmail", "extensionName", "licenseType", "mainGitBranch", "jsPackageManager", "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 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>;