@flarum/cli 1.0.0 → 2.0.0-beta.4

package/lib/steps/gen-ext-scaffolder.js

@@ -0,0 +1,510 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.genExtScaffolder = exports.EXTENSION_MODULES = exports.EXTENSION_PARAMS = void 0;
+const tslib_1 = require("tslib");
+const scaffolder_1 = require("boilersmith/scaffolding/scaffolder");
+const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
+const mem_fs_editor_1 = require("mem-fs-editor");
+const node_path_1 = require("node:path");
+const simple_git_1 = (0, tslib_1.__importDefault)(require("simple-git"));
+const simple_1 = (0, tslib_1.__importDefault)(require("spdx-license-list/simple"));
+const composer_1 = require("../utils/composer");
+function assertUnreachable(_x) {
+    throw new Error("Didn't expect to get here");
+}
+exports.EXTENSION_PARAMS = [
+    'packageName',
+    'packageDescription',
+    'packageNamespace',
+    'authorName',
+    'authorEmail',
+    'extensionName',
+    'licenseType',
+    'mainGitBranch',
+    'licenseText',
+    'packageNamespaceEscapedSlash',
+    'extensionId',
+    'year',
+    'backendDirectory',
+    'frontendDirectory',
+];
+function paramNamesToDef(name) {
+    switch (name) {
+        case 'packageName':
+            return {
+                prompt: {
+                    name,
+                    type: 'text',
+                    message: `Package ${chalk_1.default.dim('(vendor/extension-name)')}`,
+                    validate: s => /^([\dA-Za-z-]{2,})\/([\dA-Za-z-]{2,})$/.test(s.trim()) || 'Invalid package name format',
+                    format: s => s.toLowerCase(),
+                },
+                getCurrVal: async (fs, paths) => {
+                    const json = (0, composer_1.getComposerJson)(fs, paths);
+                    return json === null || json === void 0 ? void 0 : json.name;
+                },
+            };
+        case 'packageDescription':
+            return {
+                prompt: {
+                    name,
+                    type: 'text',
+                    message: 'Package description',
+                },
+                getCurrVal: async (fs, paths) => {
+                    var _a;
+                    const json = (0, composer_1.getComposerJson)(fs, paths);
+                    return (_a = json === null || json === void 0 ? void 0 : json.description) !== null && _a !== void 0 ? _a : '';
+                },
+            };
+        case 'packageNamespace':
+            return {
+                prompt: {
+                    name,
+                    type: 'text',
+                    message: `Package namespace ${chalk_1.default.dim('(Vendor\\ExtensionName)')}`,
+                    validate: s => /^([\dA-Za-z]+)\\([\dA-Za-z]+)$/.test(s.trim()) || 'Invalid namespace format',
+                    format: (str) => str &&
+                        str
+                            .split('\\')
+                            .map(s => s[0].toUpperCase() + s.slice(1))
+                            .join('\\'),
+                },
+                getCurrVal: async (fs, paths) => {
+                    var _a, _b, _c, _d, _e;
+                    const json = (0, composer_1.getComposerJson)(fs, paths);
+                    const namespace = (_e = ((_d = (_c = Object.keys((_b = (_a = json === null || json === void 0 ? void 0 : json.autoload) === null || _a === void 0 ? void 0 : _a['psr-4']) !== null && _b !== void 0 ? _b : {})) === null || _c === void 0 ? void 0 : _c[0]) !== null && _d !== void 0 ? _d : '')) === null || _e === void 0 ? void 0 : _e.slice(0, -1);
+                    return namespace || '';
+                },
+            };
+        case 'authorName':
+            return {
+                prompt: {
+                    name,
+                    type: 'text',
+                    message: 'Author name',
+                },
+                getCurrVal: async (fs, paths) => {
+                    var _a, _b, _c;
+                    const json = (0, composer_1.getComposerJson)(fs, paths);
+                    return (_c = (_b = (_a = json.authors) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.name) !== null && _c !== void 0 ? _c : '';
+                },
+            };
+        case 'authorEmail':
+            return {
+                prompt: {
+                    name,
+                    type: 'text',
+                    message: 'Author email',
+                    validate: s => !s || /^[\w!#$%&*+./=?^`{|}~’-]+@[\dA-Za-z-]+(?:\.[\dA-Za-z-]+)*$/.test(s) || 'Invalid email format',
+                },
+                getCurrVal: async (fs, paths) => {
+                    var _a, _b, _c;
+                    const json = (0, composer_1.getComposerJson)(fs, paths);
+                    return (_c = (_b = (_a = json.authors) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.email) !== null && _c !== void 0 ? _c : '';
+                },
+            };
+        case 'extensionName':
+            return {
+                prompt: {
+                    name,
+                    type: 'text',
+                    message: 'Extension name',
+                    validate: str => Boolean(str.trim()) || 'The extension name is required',
+                    format: str => str
+                        .split(' ')
+                        .map((s) => (s.length > 3 ? s[0].toUpperCase() + s.slice(1) : s))
+                        .join(' '),
+                },
+                getCurrVal: async (fs, paths) => {
+                    var _a, _b, _c;
+                    const json = (0, composer_1.getComposerJson)(fs, paths);
+                    if (json.name === 'flarum/core')
+                        return 'Core';
+                    return (_c = (_b = (_a = json === null || json === void 0 ? void 0 : json.extra) === null || _a === void 0 ? void 0 : _a['flarum-extension']) === null || _b === void 0 ? void 0 : _b.title) !== null && _c !== void 0 ? _c : '';
+                },
+            };
+        case 'licenseType':
+            return {
+                prompt: {
+                    name,
+                    type: 'autocomplete',
+                    message: 'License',
+                    choices: [...simple_1.default].map(e => ({ title: e, value: e })),
+                },
+                getCurrVal: async (fs, paths) => {
+                    var _a;
+                    const json = (0, composer_1.getComposerJson)(fs, paths);
+                    return (_a = json === null || json === void 0 ? void 0 : json.license) !== null && _a !== void 0 ? _a : '';
+                },
+            };
+        case 'licenseText':
+            return {
+                name,
+                uses: ['licenseType'],
+                compute: async (_paths, licenseType) => (licenseType ? require(`spdx-license-list/licenses/${licenseType}`).licenseText : ''),
+            };
+        case 'packageNamespaceEscapedSlash':
+            return {
+                name,
+                uses: ['packageNamespace'],
+                compute: async (_paths, packageNamespace) => packageNamespace.replace('\\', '\\\\'),
+            };
+        case 'extensionId':
+            return {
+                name,
+                uses: ['packageName'],
+                compute: async (_paths, packageName) => packageName.replace(/(flarum-ext-)|(flarum-)/, '').replace('/', '-'),
+            };
+        case 'year':
+            return {
+                name,
+                uses: [],
+                compute: async () => new Date().getFullYear().toString(),
+            };
+        case 'mainGitBranch':
+            return {
+                prompt: {
+                    name,
+                    type: 'text',
+                    message: `Main git branch ${chalk_1.default.dim('(JS will automatically build when changes are pushed to GitHub on this branch)')}`,
+                    // See https://stackoverflow.com/a/12093994/11091039
+                    validate: s => /^(?!.*\/\.)(?!.*\.\.)(?!\/)(?!.*\/\/)(?!.*@{)(?!.*\\)[^\000-\037 *:?[^~\177]+(?<!\.lock)(?<!\/)(?<!\.)$/.test(s.trim()) || 'Invalid git branch',
+                    initial: 'main',
+                },
+                getCurrVal: async () => {
+                    var _a;
+                    return (_a = (await (0, simple_git_1.default)().getConfig('init.defaultBranch')).value) !== null && _a !== void 0 ? _a : 'main';
+                },
+            };
+        case 'backendDirectory':
+            return {
+                name,
+                uses: [],
+                compute: async (paths) => {
+                    const monorepoPath = paths.monorepo();
+                    return monorepoPath ? paths.package().replace(monorepoPath, '.') : '.';
+                },
+            };
+        case 'frontendDirectory':
+            return {
+                name,
+                uses: [],
+                compute: async (paths) => {
+                    const monorepoPath = paths.monorepo();
+                    return monorepoPath ? paths.package().replace(monorepoPath, '.') + '/js' : './js';
+                },
+            };
+    }
+    return assertUnreachable(name);
+}
+exports.EXTENSION_MODULES = [
+    'core',
+    'icon',
+    'js',
+    'jsCommon',
+    'css',
+    'locale',
+    'gitConf',
+    'githubActions',
+    'prettier',
+    'typescript',
+    'bundlewatch',
+    'backendTesting',
+    'editorConfig',
+    'styleci',
+];
+function moduleNameToDef(name) {
+    switch (name) {
+        case 'core':
+            return {
+                name,
+                updatable: false,
+                togglable: false,
+                shortDescription: 'Core Functionality',
+                filesToReplace: [
+                    'extend.php',
+                    'README.md',
+                    'LICENSE.md',
+                    { path: 'js/src/admin/index.js', needsOtherModules: ['js'] },
+                    { path: 'js/src/forum/index.js', needsOtherModules: ['js'] },
+                    { path: 'js/src/common/index.js', needsOtherModules: ['js', 'jsCommon'] },
+                ],
+                jsonToAugment: {
+                    'composer.json': [
+                        'name',
+                        'description',
+                        'keywords',
+                        'type',
+                        'license',
+                        'require.flarum/core',
+                        'authors',
+                        'autoload.psr-4.${params.packageNamespaceEscapedSlash}\\',
+                        'extra.flarum-extension.title',
+                        'extra.flarum-extension.category',
+                    ],
+                },
+                needsTemplateParams: [
+                    'packageName',
+                    'packageNamespace',
+                    'packageNamespaceEscapedSlash',
+                    'packageDescription',
+                    'extensionName',
+                    'licenseType',
+                    'licenseText',
+                    'authorName',
+                    'authorEmail',
+                    'extensionId',
+                    'year',
+                ],
+            };
+        case 'icon':
+            return {
+                name,
+                updatable: false,
+                togglable: false,
+                shortDescription: 'Extension Icon',
+                filesToReplace: [],
+                jsonToAugment: {
+                    'composer.json': ['extra.flarum-extension.icon.name', 'extra.flarum-extension.icon.color', 'extra.flarum-extension.icon.backgroundColor'],
+                },
+                needsTemplateParams: [],
+            };
+        case 'js':
+            return {
+                name,
+                updatable: true,
+                togglable: true,
+                defaultEnabled: true,
+                shortDescription: 'Javascript',
+                longDescription: "Files, tools, and scripts to build Flarum's frontend.",
+                dependsOn: [],
+                filesToReplace: ['js/webpack.config.js', 'js/admin.js', 'js/forum.js'],
+                jsonToAugment: {
+                    'js/package.json': [
+                        'name',
+                        'private',
+                        'devDependencies.flarum-webpack-config',
+                        'devDependencies.webpack',
+                        'devDependencies.webpack-cli',
+                        'scripts.dev',
+                        'scripts.build',
+                        'scripts.analyze',
+                    ],
+                },
+                needsTemplateParams: ['packageName'],
+            };
+        case 'jsCommon':
+            return {
+                name,
+                updatable: false,
+                togglable: true,
+                defaultEnabled: true,
+                shortDescription: 'JS common code',
+                longDescription: 'Shared code between the forum and the admin frontends',
+                dependsOn: ['js'],
+                filesToReplace: [],
+                jsonToAugment: {},
+                needsTemplateParams: [],
+            };
+        case 'css':
+            return {
+                name,
+                updatable: false,
+                togglable: true,
+                defaultEnabled: true,
+                shortDescription: 'CSS',
+                longDescription: "LESS starter files for Flarum's frontend styling.",
+                dependsOn: [],
+                filesToReplace: ['less/admin.less', 'less/forum.less'],
+                jsonToAugment: {},
+                needsTemplateParams: [],
+            };
+        case 'locale':
+            return {
+                name,
+                updatable: false,
+                togglable: true,
+                defaultEnabled: true,
+                shortDescription: 'Locale',
+                longDescription: 'Translation starter files.',
+                dependsOn: [],
+                filesToReplace: ['locale/en.yml'],
+                jsonToAugment: {},
+                needsTemplateParams: [],
+            };
+        case 'gitConf':
+            return {
+                name,
+                updatable: true,
+                togglable: true,
+                defaultEnabled: true,
+                shortDescription: 'Git Configuration',
+                longDescription: 'Git config files (e.g. .gitignore, .gitattributes).',
+                dependsOn: [],
+                filesToReplace: [{ path: 'gitignore', destPath: '.gitignore' }, '.gitattributes'],
+                jsonToAugment: {},
+                needsTemplateParams: [],
+            };
+        case 'githubActions':
+            return {
+                name,
+                updatable: true,
+                togglable: true,
+                defaultEnabled: true,
+                shortDescription: 'GitHub Actions CI',
+                longDescription: 'Automatically run checks via GitHub Actions CI. Free for open source projects.',
+                dependsOn: [],
+                filesToReplace: [
+                    { path: '.github/workflows/frontend.yml', monorepoPath: '.github/workflows/${params.extensionId}-frontend.yml' },
+                    { path: '.github/workflows/backend.yml', monorepoPath: '.github/workflows/${params.extensionId}-backend.yml' },
+                ],
+                jsonToAugment: {},
+                needsTemplateParams: ['frontendDirectory', 'backendDirectory', 'mainGitBranch', 'extensionId', 'extensionName'],
+            };
+        case 'prettier':
+            return {
+                name,
+                updatable: true,
+                togglable: true,
+                defaultEnabled: true,
+                shortDescription: 'Auto-format frontend code with Prettier.',
+                dependsOn: ['js'],
+                filesToReplace: [],
+                jsonToAugment: {
+                    'js/package.json': ['prettier', 'devDependencies.prettier', 'devDependencies.@flarum/prettier-config', 'scripts.format', 'scripts.format-check'],
+                },
+                needsTemplateParams: [],
+            };
+        case 'typescript':
+            return {
+                name,
+                updatable: true,
+                togglable: true,
+                defaultEnabled: true,
+                shortDescription: 'Support TypeScript in frontend code.',
+                dependsOn: ['js'],
+                filesToReplace: ['js/tsconfig.json'],
+                jsonToAugment: {
+                    'js/package.json': [
+                        'prettier',
+                        'devDependencies.flarum-tsconfig',
+                        'devDependencies.typescript',
+                        'devDependencies.typescript-coverage-report',
+                        'scripts.check-typings',
+                        'scripts.check-typings-coverage',
+                    ],
+                },
+                needsTemplateParams: [],
+            };
+        case 'bundlewatch':
+            return {
+                name,
+                updatable: true,
+                togglable: true,
+                defaultEnabled: false,
+                shortDescription: 'Enable Bundlewatch Checks',
+                dependsOn: ['js'],
+                filesToReplace: [],
+                jsonToAugment: {},
+                needsTemplateParams: [],
+            };
+        case 'backendTesting':
+            return {
+                name,
+                updatable: true,
+                togglable: true,
+                defaultEnabled: true,
+                shortDescription: 'Backend PHP unit and integration testing via PHPUnit.',
+                dependsOn: [],
+                filesToReplace: [
+                    'tests/phpunit.integration.xml',
+                    'tests/phpunit.unit.xml',
+                    'tests/fixtures/.gitkeep',
+                    'tests/integration/setup.php',
+                    'tests/unit/.gitkeep',
+                ],
+                jsonToAugment: {
+                    'composer.json': [
+                        'autoload-dev.psr-4.${params.packageNamespaceEscapedSlash}\\Tests\\',
+                        'scripts.test',
+                        'scripts.test:unit',
+                        'scripts.test:integration',
+                        'scripts.test:setup',
+                        'scripts-descriptions.test',
+                        'scripts-descriptions.test:unit',
+                        'scripts-descriptions.test:integration',
+                        'scripts-descriptions.test:setup',
+                        'require-dev.flarum/testing',
+                    ],
+                },
+                needsTemplateParams: ['packageNamespaceEscapedSlash'],
+            };
+        case 'editorConfig':
+            return {
+                name,
+                updatable: true,
+                togglable: true,
+                defaultEnabled: true,
+                shortDescription: 'EditorConfig setup',
+                dependsOn: [],
+                filesToReplace: ['.editorconfig'],
+                jsonToAugment: {},
+                needsTemplateParams: [],
+            };
+        case 'styleci':
+            return {
+                name,
+                updatable: true,
+                togglable: true,
+                defaultEnabled: true,
+                shortDescription: 'StyleCI config file',
+                dependsOn: [],
+                filesToReplace: [
+                    { path: '.styleci.yml', monorepoPath: '.styleci.yml' },
+                ],
+                jsonToAugment: {},
+                needsTemplateParams: [],
+            };
+    }
+    return assertUnreachable(name);
+}
+let cached;
+function genExtScaffolder() {
+    if (cached)
+        return cached;
+    const moduleStatusCache = {
+        get: async (module, fs, paths) => {
+            var _a, _b, _c, _d;
+            const json = (0, composer_1.getComposerJson)(fs, paths);
+            return !module.togglable || ((_d = (_c = (_b = (_a = json === null || json === void 0 ? void 0 : json.extra) === null || _a === void 0 ? void 0 : _a['flarum-cli']) === null || _b === void 0 ? void 0 : _b.modules) === null || _c === void 0 ? void 0 : _c[module.name]) !== null && _d !== void 0 ? _d : module.defaultEnabled);
+        },
+        set: async (module, enabled, fs, paths) => {
+            const json = {
+                extra: {
+                    'flarum-cli': {
+                        modules: {
+                            [module.name]: enabled,
+                        },
+                    },
+                },
+            };
+            (0, mem_fs_editor_1.create)(fs).extendJSON(paths.package('composer.json'), json, undefined, 4);
+        },
+    };
+    const excludeScaffoldingFunc = (fs, paths) => {
+        var _a, _b, _c;
+        const json = (0, composer_1.getComposerJson)(fs, paths);
+        return (_c = (_b = (_a = json === null || json === void 0 ? void 0 : json.extra) === null || _a === void 0 ? void 0 : _a['flarum-cli']) === null || _b === void 0 ? void 0 : _b.excludeScaffolding) !== null && _c !== void 0 ? _c : [];
+    };
+    const scaffolder = new scaffolder_1.Scaffolder((0, node_path_1.resolve)(__dirname, '../../boilerplate/skeleton/extension'), moduleStatusCache, excludeScaffoldingFunc);
+    for (const name of exports.EXTENSION_MODULES) {
+        scaffolder.registerModule(moduleNameToDef(name));
+    }
+    for (const name of exports.EXTENSION_PARAMS) {
+        scaffolder.registerTemplateParam(paramNamesToDef(name));
+    }
+    cached = scaffolder;
+    return scaffolder;
+}
+exports.genExtScaffolder = genExtScaffolder;

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

@@ -1,15 +1,15 @@
 import { Store } from 'mem-fs';
-import { ParamProvider } from '../../provider/param-provider';
-import { PathProvider } from '../../provider/path-provider';
-import { PhpProvider } from '../../provider/php-provider';
-import { Step } from '../step-manager';
-export declare abstract class BaseJsStep implements Step {
+import { IO } from 'boilersmith/io';
+import { Paths } from 'boilersmith/paths';
+import { Step } from 'boilersmith/step-manager';
+import { FlarumProviders } from '../../providers';
+export declare abstract class BaseJsStep implements Step<FlarumProviders> {
     abstract type: string;
     composable: boolean;
-    run(fs: Store, pathProvider: PathProvider, paramProvider: ParamProvider, _phpProvider: PhpProvider): Promise<Store>;
-    protected abstract getDefinition(paramProvider: ParamProvider): Promise<string>;
-    protected abstract getImports(frontend: string, pathProvider: PathProvider, paramProvider: ParamProvider): Promise<string>;
+    run(fs: Store, paths: Paths, io: IO, _providers: FlarumProviders): Promise<Store>;
+    protected abstract getDefinition(io: IO): Promise<string>;
+    protected abstract getImports(frontend: string, paths: Paths, io: IO): Promise<string>;
     protected importPath(frontend: string, classNamespace: string): string;
     exposes: never[];
-    getExposed(_pathProvider: PathProvider, _paramProvider: ParamProvider): Record<string, unknown>;
+    getExposed(_paths: Paths, _paramProvider: IO): Record<string, unknown>;
 }

package/lib/steps/js/base.js

@@ -1,37 +1,38 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseJsStep = void 0;
-const glob_1 = require("glob");
+const tslib_1 = require("tslib");
+const globby_1 = (0, tslib_1.__importDefault)(require("globby"));
 const mem_fs_editor_1 = require("mem-fs-editor");
-const IMPORTS_REGEX = /((^import\s+(?:([\w,{}\s*]+)\s+from)?\s*(?:(?:["'])?([@\w\s\\/.-]+)\3?(?:["'])?)\s*;?\s*)*)(.*)/m;
-const INIT_REGEX = /^(app\.initializers\.add\('[^']+',\s*\(\)\s*=>\s*\{)$/m;
+const IMPORTS_REGEX = /((^import\s+(?:([\s\w*,{}]+)\s+from)?\s*["']?([\s\w./@\\-]+)\3?["']?\s*;?\s*)*)(.*)/m;
+const INIT_REGEX = /^(app\.initializers\.add\('[^']+',\s*\(\)\s*=>\s*{)$/m;
 class BaseJsStep {
     constructor() {
         this.composable = true;
         this.exposes = [];
     }
-    async run(fs, pathProvider, paramProvider, _phpProvider) {
-        const fsEditor = mem_fs_editor_1.create(fs);
-        const frontend = await paramProvider.get({ name: 'frontend', type: 'text' });
+    async run(fs, paths, io, _providers) {
+        const fsEditor = (0, mem_fs_editor_1.create)(fs);
+        const frontend = await io.getParam({ name: 'frontend', type: 'text' });
         let frontends = [frontend];
         if (frontend === 'common') {
             frontends = ['admin', 'forum'];
         }
-        frontends.forEach(frontend => {
-            const fsSrcFilePaths = glob_1.glob.sync(pathProvider.ext(`js/src/${frontend}/*.{js,jsx,ts,tsx}`));
+        for (const frontend of frontends) {
+            const fsSrcFilePaths = globby_1.default.sync(paths.package(`js/src/${frontend}/*.{js,jsx,ts,tsx}`));
             fsSrcFilePaths.forEach(async (match) => {
                 /**
                  * @TODO look into using https://esprima.org/ instead
                  */
                 const currContents = fsEditor.read(match);
-                const imports = await this.getImports(frontend, pathProvider, paramProvider);
-                const definition = await this.getDefinition(paramProvider);
+                const imports = await this.getImports(frontend, paths, io);
+                const definition = await this.getDefinition(io);
                 const newContents = currContents
                     .replace(INIT_REGEX, `$1\n  ${definition}\n`)
                     .replace(IMPORTS_REGEX, `$1${imports}\n\n$5`);
                 fsEditor.write(match, newContents);
             });
-        });
+        }
         return fs;
     }
     importPath(frontend, classNamespace) {
@@ -39,7 +40,7 @@ class BaseJsStep {
         path = path.replace(`../${frontend}/`, './');
         return path;
     }
-    getExposed(_pathProvider, _paramProvider) {
+    getExposed(_paths, _paramProvider) {
         return {};
     }
 }

package/lib/steps/js/model.d.ts

@@ -1,10 +1,10 @@
-import { ParamProvider } from '../../provider/param-provider';
-import { PathProvider } from '../../provider/path-provider';
+import { IO } from 'boilersmith/io';
+import { Paths } from 'boilersmith/paths';
 import { BaseJsStep } from './base';
 export declare class GenerateModelDefinition extends BaseJsStep {
     type: string;
-    protected getDefinition(paramProvider: ParamProvider): Promise<string>;
-    protected getImports(frontend: string, pathProvider: PathProvider, paramProvider: ParamProvider): Promise<string>;
+    protected getDefinition(io: IO): Promise<string>;
+    protected getImports(frontend: string, paths: Paths, io: IO): Promise<string>;
     exposes: never[];
-    getExposed(_pathProvider: PathProvider, _paramProvider: ParamProvider): Record<string, unknown>;
+    getExposed(_paths: Paths, _paramProvider: IO): Record<string, unknown>;
 }

package/lib/steps/js/model.js

@@ -8,24 +8,19 @@ class GenerateModelDefinition extends base_1.BaseJsStep {
         this.type = 'Generate JS Model Definition';
         this.exposes = [];
     }
-    async getDefinition(paramProvider) {
-        const className = await paramProvider.get({ name: 'className', type: 'text' });
-        let modelType = await paramProvider.get({ name: 'modelType', type: 'text' });
-        if (modelType.includes('-')) {
-            modelType = `['${modelType}']`;
-        }
-        else {
-            modelType = `.${modelType}`;
-        }
+    async getDefinition(io) {
+        const className = await io.getParam({ name: 'className', type: 'text' });
+        let modelType = await io.getParam({ name: 'modelType', type: 'text' });
+        modelType = modelType.includes('-') ? `['${modelType}']` : `.${modelType}`;
         return `app.store.models${modelType} = ${className};`;
     }
-    async getImports(frontend, pathProvider, paramProvider) {
-        const className = await paramProvider.get({ name: 'className', type: 'text' });
-        const classNamespace = await paramProvider.get({ name: 'classNamespace', type: 'text' });
+    async getImports(frontend, paths, io) {
+        const className = await io.getParam({ name: 'className', type: 'text' });
+        const classNamespace = await io.getParam({ name: 'classNamespace', type: 'text' });
         const importPath = this.importPath(frontend, classNamespace);
         return `import ${className} from '${importPath}';`;
     }
-    getExposed(_pathProvider, _paramProvider) {
+    getExposed(_paths, _paramProvider) {
         return {};
     }
 }

package/lib/steps/misc/composer.d.ts

@@ -1,12 +1,11 @@
 import { Store } from 'mem-fs';
-import { ParamProvider } from '../../provider/param-provider';
-import { PathProvider } from '../../provider/path-provider';
-import { PhpProvider } from '../../provider/php-provider';
-import { Step } from '../step-manager';
+import { IO } from 'boilersmith/io';
+import { Paths } from 'boilersmith/paths';
+import { DefaultProviders, Step } from 'boilersmith/step-manager';
 export declare class ComposerInstall implements Step {
     type: string;
     composable: boolean;
-    run(fs: Store, pathProvider: PathProvider, _paramProvider: ParamProvider, _phpProvider: PhpProvider): Promise<Store>;
+    run(fs: Store, paths: Paths, _paramProvider: IO, _providers: DefaultProviders): Promise<Store>;
     exposes: never[];
-    getExposed(): {};
+    getExposed(): Record<string, unknown>;
 }