@flarum/cli 2.0.0-beta.12 → 2.0.0-beta.15

package/README.md

@@ -11,33 +11,47 @@ A CLI for developing Flarum extensions</p>
 <img width=720 src="https://sycho9.github.io/flarum-cli.svg" alt="terminal_example">
 </p>
 
-<!-- toc -->
-* [Introduction](#introduction)
-* [Installation](#installation)
-* [Usage](#usage)
-* [Commands](#commands)
-<!-- tocstop -->
+- [Introduction](#introduction)
+- [Installation](#installation)
+- [Updating](#updating)
+- [Usage](#usage)
+- [Commands](#commands)
 
-# Introduction
-One of our core values is ***Framework First***, Flarum is as much a framework for extension development as it is a forum platform.
+## Introduction
+
+One of our core values is **_Framework First_**, Flarum is as much a framework for extension development as it is a forum platform.
 
 This tool was built to simplify the development of Flarum extensions by automating some repetitive and menial tasks. It allows to generate boilerplate skeleton for a new extension, common backend classes and frontend components, extenders, as well as other maintenance tasks.
 
-# Installation
+## Installation
+
 <!-- installation -->
+
 ```sh-session
 $ npm install -g @flarum/cli
 ```
+
 <!-- installationstop -->
 
-# Usage
+## Updating
+
+<!-- updating -->
+
+```sh-session
+$ npm update -g @flarum/cli
+```
+
+<!-- updatingstop -->
+
+## Usage
+
 <!-- usage -->
 ```sh-session
 $ npm install -g @flarum/cli
 $ flarum-cli COMMAND
 running command...
 $ flarum-cli (-v|--version|version)
-@flarum/cli/2.0.0-beta.12 linux-x64 node-v16.13.0
+@flarum/cli/2.0.0-beta.15 linux-x64 node-v16.14.0
 $ flarum-cli --help [COMMAND]
 USAGE
   $ flarum-cli COMMAND
@@ -59,29 +73,117 @@ or
 flarum-cli --help
 ```
 
-# Commands
-* `flarum-cli help [COMMAND]`
-* `flarum-cli infra backend-testing [PATH]`
-* `flarum-cli init [PATH]`
-* `flarum-cli make backend api-controller [PATH]`
-* `flarum-cli make backend api-serializer [PATH]`
-* `flarum-cli make backend api-serializer-attributes [PATH]`
-* `flarum-cli make backend command [PATH]`
-* `flarum-cli make backend event-listener [PATH]`
-* `flarum-cli make backend handler [PATH]`
-* `flarum-cli make backend integration-test [PATH]`
-* `flarum-cli make backend job [PATH]`
-* `flarum-cli make backend migration [PATH]`
-* `flarum-cli make backend model [PATH]`
-* `flarum-cli make backend policy [PATH]`
-* `flarum-cli make backend repository [PATH]`
-* `flarum-cli make backend route [PATH]`
-* `flarum-cli make backend service-provider [PATH]`
-* `flarum-cli make backend validator [PATH]`
-* `flarum-cli make frontend component [PATH]`
-* `flarum-cli make frontend modal [PATH]`
-* `flarum-cli make frontend model [PATH]`
-* `flarum-cli update js-imports [PATH]`
+## Commands
+
+The CLI has different types of commands for different tasks:
+
+**Initialisation**
+
+- `flarum-cli init [PATH]`: Generates a blank extension skeleton, including all recommended infrastructure.
+
+**Infrastructure**: See the [infrastructure](#infrastructure-modules) section for more information.
+
+- `flarum-cli infra [MODULE] [PATH]`: Adds (or updates) infrastructure for some part of extension infrastructure. You can see all available modules by running `fl-dev infra --help`.
+
+**Audit**: These commands help you make sure your extension is up to date.
+
+- `flarum-cli audit infra [--monorepo] [--fix]` Check that infrastructure files are up to date for all enabled modules.
+
+**Backend Boilerplate Generation**: Generates different types of backend classes and/or extenders, ready to be used.
+
+- `flarum-cli make backend api-controller [PATH]`
+- `flarum-cli make backend api-serializer [PATH]`
+- `flarum-cli make backend api-serializer-attributes [PATH]`
+- `flarum-cli make backend command [PATH]`
+- `flarum-cli make backend event-listener [PATH]`
+- `flarum-cli make backend handler [PATH]`
+- `flarum-cli make backend integration-test [PATH]`
+- `flarum-cli make backend job [PATH]`
+- `flarum-cli make backend migration [PATH]`
+- `flarum-cli make backend model [PATH]`
+- `flarum-cli make backend policy [PATH]`
+- `flarum-cli make backend repository [PATH]`
+- `flarum-cli make backend route [PATH]`
+- `flarum-cli make backend service-provider [PATH]`
+- `flarum-cli make backend validator [PATH]`
+
+**Frontend Boilerplate Generation**: Generate frontend components/classes, ready to be used.
+
+- `flarum-cli make frontend component [PATH]`
+- `flarum-cli make frontend modal [PATH]`
+- `flarum-cli make frontend model [PATH]`
+
+**Code Updates**: These commands help update extensions for newer versions of Flarum.
+
+- `flarum-cli update js-imports [PATH]`: Adds admin/forum/common namespaces to all JS imports from flarum core.
+
+_And of course, you can always use the help command to see a list of all available commands with their descriptions:_
+
+- `flarum-cli help [COMMAND]`
+
+All commands can use a `--no-interaction` flag to proceed with default values for prompts when possible.
+
+## 🔥 The Most Powerful Commands
+
+Of all the aforementioned commands, the two most powerful ones that will make a huge difference, are the extension initialisation command and the backend **model** generation command. The former obviously allows to kickstart the extension with the recommended skeleton from the Core Dev team, while the latter not only creates the backend model, it allows to create all the classes related to the model, from just its name:
+
+- Table migration
+- Policy
+- API Serializer
+- CRUD API Controllers
+- CRUD Handlers
+- Repository
+- Validator
+- Routes
+- Related Extenders
+
+[center]
+![terminal_example](https://sycho9.github.io/flarum-cli.svg)
+![example_project_with_model_command](https://lh3.googleusercontent.com/-fUnfqQ7rwyo/YQVwwm0sa0I/AAAAAAAAFfE/-o9B30M2gE8y6d3NWaVgBhYa8xEwqLuNwCLcBGAsYHQ/s16000/Screenshot%2Bfrom%2B2021-07-31%2B16-46-38.png)
+[/center]
+
+## Infrastructure Modules
+
+If you maintain more than just a few extensions, keeping the infrastructure up to date can be very tedious.
+We heavily value developer experience, and make it a point to support automated testing, static analysis, formatting, and other tools
+that help you work more happily and efficiently. However, all this means that there's a lot of config files to keep track of.
+
+The idea behind Flarum CLI's infrastructure modules is simple: the config for some feature is associated with a "module".
+For example, the "typescript" module includes:
+
+- The `js/tsconfig.json` file
+- Dependency reqs for `typescript`, `typescript-coverage-report`, and `flarum-tsconfig` in the `package.json` file.
+- Script configuration to check type safety and type coverage in the `package.json` file.
+
+So to enable the `typescript` module, all Flarum CLI has to do is update those files and JSON config keys to the latest version.
+
+Please note that running `flarum-cli infra` or `flarum-cli audit infra --fix` will only add new files/keys and overwrite existing ones; it will not delete old files or config keys.
+
+Also, we strongly recommend carefully looking over the changes made by these commands before committing them: they should work the vast majority of the time, but there could be some corner cases.
+
+### Excluding Files
+
+Sometimes, you'll want to customize some of these configuration files, and prevent `flarum-cli infra [MODULE]` or `flarum-cli audit infra --fix` from overriding your changes. You can also exclude any files from these updates by adding their relative path to the "extra.flarum-cli.excludeScaffolding" key's array in your extension's `composer.json` file. For example, if you wanted to exclude your tsconfig file from any updates by the infra system, your `composer.json` should look as follows:
+
+```json
+{
+  ...
+  "extra": {
+    "flarum-cli": {
+      "excludeScaffolding": [
+        "js/tsconfig.json"
+      ],
+      "excludeScaffoldingConfigKeys": {
+        "composer.json": [
+          "scripts.test:setup"
+        ],
+      ...
+    },
+    ...
+  }
+  ...
+}
+```
 
 ## For Maintainers
 
@@ -99,7 +201,7 @@ The base command is implemented at [src/base-command.ts](https://github.com/flar
 3. Confirm we are in the right directory
 4. Confirm that files will be overwritten / clear files as needed
 5. Run a set of registered steps
-6. Tell the user which steps ran
+6. Tell the user which steps ran, or display any errors
 7. Show a goodbye message
 
 Actual functionality is implemented at the step layer.
@@ -117,7 +219,7 @@ More documentation (and functionality!) will be added later.
 
 #### What are steps?
 
-Steps represent granular operations. Some are bigger and some are smaller, but they include:
+Steps represent meaningful, granular operations. Some are bigger and some are smaller, but they include:
 
 - Initializing an extension from boilerplate
 - Updating some part of an extension from boilerplate (like adding backend testing)
@@ -132,9 +234,10 @@ If some subtask might be needed by multiple commands, that should be a step too.
 The actual logic of a step is implemented in the async `run` method. This method takes:
 
 - An in-memory filesystem object (through `mem-fs`)
-- A path provider, which is a class that can be used to get paths relative to the extension root, the working directory, the requested directory, and the CLI's boilerplate directory
-- A param provider, which can be used to prompt the user for parameters. We'll discuss this more soon.
-- A "php provider", which can be used to interact with the PHP subsystem to add extenders to extend.php.
+- A paths object, which is a class that can be used to get paths relative to the extension root, the working directory, the requested directory (if the command was run with the `path` arg specified), and the monorepo directory (if in a subdirectory of a monorepo).
+- An `io` instance, which can be used to prompt the user for input or display outputs / errors.
+- An object of "providers", which represent additional functionality. For Flarum commands, these are:
+  - A "php provider", which can be used to interact with the PHP subsystem to add extenders to extend.php.
 
 Steps should modify the in-memory filesystem with their changes and return it.
 
@@ -159,7 +262,6 @@ Sharing parameters is done via the following process:
   - What the param is consumed at
   - If the param value is falsy, should the consumer step run at all? Useful for variable dependencies.
 
-
 For example:
 
 ```ts
@@ -195,7 +297,6 @@ For example:
   .run(new Paths({...}), new PromptsIO(), {php: new PhpProvider(...)});
 ```
 
-
 #### Step Composability and Atomic Groups
 
 As noted above, steps should work by modifying and returning an in-memory filesystem.
@@ -214,8 +315,6 @@ Steps for generating extenders should use `src/steps/extenders/base`, where all
 
 Steps for generating templates from php stubs should use `src/steps/stubs/php-base`, where they just need to describe what stub file they use, which params they need, and a recommended namespace where the generated file should be placed.
 
-Steps for `infra` operations (copying over some portion of the default skeleton, for operations like adding/updating backend testing or TypeScript config) shouls use `src/steps/infra/base`, where all they need to indicate is a list of files from the boilerplate they copy over, and an object describing which JSON config keys should be copied from the boilerplate to the extension for various JSON files.
-
 ### Testing
 
 Most of this architecture was driven by TDD and BDD development, allowing for a highly decoupled system.
@@ -225,3 +324,37 @@ Any additions of steps, modifications of providers, or changes of functionality
 The 3 base step types actually provide a simple interface to generate test cases. See the relevant test files for more info.
 
 Since commands directly affect the filesystem, unit tests for them aren't really possible. It would also be quite complex to unit test all commands in addition to all steps. For this reason, commands should be manually tested, but unit tests are not currently required.
+
+### Monorepo Support
+
+Flarum CLI was designed with monorepos in mind.
+When registering a step, you can provide it an array of subdirectories to run it in.
+For each of these subdirectories, an instance of the step will run with the `paths` object returning the subdirectory as `package()`, and the original root directory as `monorepo()`.
+
+A monorepo should have a `flarum-monorepo.json` file in the root directory with the following (optional) keys:
+
+- `packages.core`: a path to Flarum Core, if present.
+- `packages.extensions`: an array of paths to Flarum extensions.
+- `packages.composer`: an array of paths to non-extension PHP Composer packages published on Packagist.
+- `packages.npm`: an array of paths to non-extension JS/TS packages published on NPM.
+
+### Scaffolding Generation
+
+One powerful use-case of Flarum CLI is creating new extensions, and keeping infrastructure in sync for existing extensions.
+For example, if managing 100 extensions, making sure the prettier config is consistent for all of them can be very tedious. Additionally, it can be annoying to have to add TypeScript config to every extension, and it's easy to make mistakes.
+
+For this purpose, Flarum CLI's `Scaffolder` system formalizes the concepts of initializing and updating extension infrastructure.
+
+At the core level, there's a boilerplate directory (`boilerplate/skeleton/extension`) that contains the scaffolding for a new extension.
+
+The scaffolder receives a set of modules, which represent some aspect of infrastructure (e.g. JS, TypeScript, Backend Testing, etc).
+Modules can be updatable (e.g. TypeScript) or not (e.g. the core setup of an `extend.php` file).
+They can also be togglable (e.g. JS), or not, in which case they are always on.
+
+Modules own files in the scaffolding directory, as well as keys in JSON config files. Every file and key must belong to at least one module. If any keys in a JSON config file belong to a module, all keys must belong to a module; if no keys are owned, the config file is treated like any other file.
+
+Modules also have template params, which are used as variables in the scaffolding.
+
+There's a lot more features and guaruntees than that, see the `Module` interface for more information.
+
+The main benefit to this system is that given this scaffolding / module setup, it is possible to generate steps to initialize a new extension, update/add a module to an existing extension, or audit an extension for any outdated infrastructure. This is how the `init`, `infra`, and `audit infra` commands are implemented.

package/bin/run

@@ -1,6 +1,7 @@
 #!/usr/bin/env node
+const { resolve } = require('path');
 
-require('module-alias').addAlias('boilersmith', `${__dirname}/../lib/boilersmith`);
+require('module-alias').addAlias('boilersmith', resolve(__dirname, '..', 'lib', 'boilersmith'));
 
 const oclif = require('@oclif/core');
 

package/boilerplate/skeleton/extension/.gitattributes

@@ -14,5 +14,6 @@ js/dist/* -diff
 js/dist/* linguist-generated
 js/dist-typings/* linguist-generated
 js/yarn.lock -diff
+js/package-lock.json -diff
 
 * text=auto eol=lf

package/boilerplate/skeleton/extension/.github/workflows/backend.yml

@@ -12,4 +12,4 @@ jobs:
     with:
       enable_backend_testing: <%= modules.backendTesting %>
 
-      backend_directory: <%= params.backendDirectory %>
+      backend_directory: <%= params.backendDirectory %>

package/boilerplate/skeleton/extension/.github/workflows/frontend.yml

@@ -15,6 +15,8 @@ jobs:
       enable_typescript: <%= modules.typescript %>
 
       frontend_directory: <%= params.frontendDirectory %>
+      backend_directory: <%= params.backendDirectory %>
+      js_package_manager: <%= params.jsPackageManager %>
       main_git_branch: <%= params.mainGitBranch %>
     secrets:
-      bundlewatch_github_token: ${{ secrets.BUNDLEWATCH_GITHUB_TOKEN }}
+      bundlewatch_github_token: ${{ secrets.BUNDLEWATCH_GITHUB_TOKEN }}

package/boilerplate/skeleton/extension/LICENSE.md

@@ -1 +1 @@
-<%= params.licenseText %>
+<%- params.licenseText %>

package/boilerplate/skeleton/extension/composer.json

@@ -7,7 +7,7 @@
     "type": "flarum-extension",
     "license": "<%= params.licenseType %>",
     "require": {
-        "flarum/core": "^1.0.0"
+        "flarum/core": "^1.2.0"
     },
     "require-dev": {
         "flarum/testing": "^1.0.0"
@@ -56,5 +56,7 @@
         "test:unit": "Runs all unit tests.",
         "test:integration": "Runs all integration tests.",
         "test:setup": "Sets up a database for use with integration tests. Execute this only once."
-    }
+    },
+    "minimum-stability": "dev",
+    "prefer-stable": true
 }

package/boilerplate/skeleton/extension/js/package.json

@@ -17,9 +17,12 @@
   "scripts": {
     "dev": "webpack --mode development --watch",
     "build": "webpack --mode production",
-    "analyze": "cross-env ANALYZER=true yarn build",
+    "analyze": "cross-env ANALYZER=true <%= params.jsPackageManager %> run build",
     "format": "prettier --write src",
     "format-check": "prettier --check src",
+    "clean-typings": "npx rimraf dist-typings && mkdir dist-typings",
+    "build-typings": "<%= params.jsPackageManager %> run clean-typings && [ -e src/@types ] && cp -r src/@types dist-typings/@types && tsc && <%= params.jsPackageManager %> run post-build-typings",
+    "post-build-typings": "find dist-typings -type f -name '*.d.ts' -print0 | xargs -0 sed -i 's,../src/@types,@types,g'",
     "check-typings": "tsc --noEmit --emitDeclarationOnly false",
     "check-typings-coverage": "typescript-coverage-report"
   }

package/boilerplate/skeleton/extension/tests/phpunit.integration.xml

@@ -19,6 +19,7 @@
     <testsuites>
         <testsuite name="Flarum Integration Tests">
             <directory suffix="Test.php">./integration</directory>
+             <exclude>./integration/tmp</exclude>
         </testsuite>
     </testsuites>
 </phpunit>

package/lib/base-command.d.ts

@@ -23,7 +23,7 @@ export default abstract class BaseCommand extends Command {
     protected welcomeMessage(): string;
     protected goodbyeMessage(): string;
     protected additionalPreRunChecks(_extRoot: string): Promise<void>;
-    protected abstract steps(stepManager: StepManager<FlarumProviders>): StepManager<FlarumProviders>;
+    protected abstract steps(stepManager: StepManager<FlarumProviders>, extRoot: string): StepManager<FlarumProviders>;
     protected genIO(): IO;
     protected monorepoPaths(options: {
         includeCore: boolean;
@@ -31,7 +31,9 @@ export default abstract class BaseCommand extends Command {
         includePhpPackages: boolean;
         includeJSPackages: boolean;
     }): string[];
+    protected isFlarumMonorepo(path: string): boolean;
     protected isFlarumCore(path: string): boolean;
+    protected jsPackageManager(currDir: string): 'yarn' | 'npm' | null;
     protected getFlarumExtensionRoot(currDir: string): Promise<{
         path: string;
         type: LocationType;

package/lib/base-command.js

@@ -4,16 +4,18 @@ exports.LocationType = void 0;
 const tslib_1 = require("tslib");
 const core_1 = require("@oclif/core");
 const cli_ux_1 = (0, tslib_1.__importDefault)(require("cli-ux"));
-const node_path_1 = require("node:path");
+const path_1 = require("path");
 const globby_1 = (0, tslib_1.__importDefault)(require("globby"));
-const node_child_process_1 = require("node:child_process");
-const node_fs_1 = require("node:fs");
+const child_process_1 = require("child_process");
+const fs_1 = require("fs");
 const io_1 = require("boilersmith/io");
 const step_manager_1 = require("boilersmith/step-manager");
 const paths_1 = require("boilersmith/paths");
 const php_provider_1 = require("./providers/php-provider");
 const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
 const errors_1 = require("@oclif/errors");
+const monorepo_1 = require("./utils/monorepo");
+const mem_fs_1 = require("mem-fs");
 var LocationType;
 (function (LocationType) {
     LocationType[LocationType["FLARUM_EXTENSION"] = 0] = "FLARUM_EXTENSION";
@@ -23,7 +25,7 @@ var LocationType;
 class BaseCommand extends core_1.Command {
     constructor() {
         super(...arguments);
-        this.STUB_PATH = (0, node_path_1.resolve)(__dirname, '../boilerplate/stubs/');
+        this.STUB_PATH = (0, path_1.resolve)(__dirname, '../boilerplate/stubs/');
         this.dry = false;
         this.requireExistingExtension = true;
     }
@@ -51,10 +53,9 @@ class BaseCommand extends core_1.Command {
             requestedDir: path,
             package: extRoot,
         });
-        const phpProvider = new php_provider_1.PhpSubsystemProvider((0, node_path_1.resolve)(__dirname, '../php-subsystem/index.php'));
-        const out = await this.steps(new step_manager_1.StepManager())
-            .run(paths, this.genIO(), { php: phpProvider }, this.dry);
-        const errorMessages = out.messages.filter(m => m.type === 'error');
+        const phpProvider = new php_provider_1.PhpSubsystemProvider((0, path_1.resolve)(__dirname, '../php-subsystem/index.php'));
+        const out = await this.steps(new step_manager_1.StepManager(), extRoot).run(paths, this.genIO(), { php: phpProvider }, this.dry);
+        const errorMessages = out.messages.filter((m) => m.type === 'error');
         this.log('\n\n');
         if (out.succeeded && errorMessages.length === 0) {
             this.log(chalk_1.default.bold(chalk_1.default.underline(chalk_1.default.green('Success! The following steps were completed:'))));
@@ -66,7 +67,7 @@ class BaseCommand extends core_1.Command {
             }
             this.log(chalk_1.default.bold(chalk_1.default.yellow('The steps that completed were:')));
         }
-        else if (out.error === 'EEXIT: 0') {
+        else if (out.error.startsWith('EEXIT:')) {
             this.log(chalk_1.default.bold(chalk_1.default.underline(chalk_1.default.red('Exiting.'))));
             if (out.stepsRan.length > 0) {
                 this.log(chalk_1.default.bold(chalk_1.default.yellow('Before the exit, the following steps were completed:')));
@@ -86,7 +87,7 @@ class BaseCommand extends core_1.Command {
         for (const stepName of out.stepsRan)
             this.log(`- ${chalk_1.default.dim(stepName)}`);
         this.log('');
-        const nonErrorMessages = out.messages.filter(m => m.type !== 'error');
+        const nonErrorMessages = out.messages.filter((m) => m.type !== 'error');
         if (nonErrorMessages.length > 0) {
             this.log('');
             this.log('The following messages were generated during execution:');
@@ -118,45 +119,53 @@ class BaseCommand extends core_1.Command {
         return new io_1.PromptsIO({}, [], this.flags['no-interaction'], errors_1.exit);
     }
     monorepoPaths(options) {
+        var _a, _b;
         try {
-            const monorepoConfig = (0, node_fs_1.readFileSync)((0, node_path_1.resolve)(process.cwd(), 'flarum-monorepo.json'));
-            const contents = JSON.parse(monorepoConfig.toString());
+            const monorepoConfig = (0, monorepo_1.getMonorepoConf)((0, mem_fs_1.create)(), new paths_1.NodePaths({ package: process.cwd() }));
             return [
-                ...(options.includeCore ? [contents.packages.core] : []),
-                ...(options.includeExtensions ? contents.packages.extensions : []),
-                ...(options.includePhpPackages ? contents.packages.composerPackages : []),
-                ...(options.includeJSPackages ? contents.packages.npmPackages : []),
+                ...(options.includeCore && monorepoConfig.packages.core ? [(0, monorepo_1.corePath)(monorepoConfig.packages.core.name)] : []),
+                ...(options.includeExtensions ? monorepoConfig.packages.extensions : []).map((ext) => (0, monorepo_1.extensionPath)(ext.name)),
+                ...(options.includePhpPackages ? (_a = monorepoConfig.packages.composer) !== null && _a !== void 0 ? _a : [] : []).map((lib) => (0, monorepo_1.composerPath)(lib.name)),
+                ...(options.includeJSPackages ? (_b = monorepoConfig.packages.npm) !== null && _b !== void 0 ? _b : [] : []).map((lib) => (0, monorepo_1.npmPath)(lib.name)),
             ];
         }
-        catch (_a) {
+        catch (_c) {
             this.error('Could not run monorepo command: `flarum-monorepo.json` file is missing or invalid.');
         }
     }
+    isFlarumMonorepo(path) {
+        return (0, fs_1.existsSync)((0, path_1.resolve)(path, 'flarum-monorepo.json'));
+    }
     isFlarumCore(path) {
         try {
-            const composerJsonPath = (0, node_path_1.resolve)(path, 'composer.json');
-            const val = JSON.parse((0, node_fs_1.readFileSync)(composerJsonPath, 'utf8'));
+            const composerJsonPath = (0, path_1.resolve)(path, 'composer.json');
+            const val = JSON.parse((0, fs_1.readFileSync)(composerJsonPath, 'utf8'));
             return val.name === 'flarum/core';
         }
         catch (_a) {
             return false;
         }
     }
+    jsPackageManager(currDir) {
+        if (!(0, fs_1.existsSync)((0, path_1.resolve)(currDir, 'js')))
+            return null;
+        return (0, fs_1.existsSync)((0, path_1.resolve)(currDir, 'js/yarn.lock')) ? 'yarn' : 'npm';
+    }
     async getFlarumExtensionRoot(currDir) {
-        let currPath = (0, node_path_1.resolve)(currDir);
+        let currPath = (0, path_1.resolve)(currDir);
         while (currPath !== '/') {
-            if ((0, node_fs_1.existsSync)((0, node_path_1.resolve)(currPath, 'flarum-monorepo.json'))) {
+            if ((0, fs_1.existsSync)((0, path_1.resolve)(currPath, 'flarum-monorepo.json'))) {
                 return { path: currPath, type: LocationType.FLARUM_MONOREPO };
             }
-            if ((0, node_fs_1.existsSync)((0, node_path_1.resolve)(currPath, 'composer.json')) && (0, node_fs_1.existsSync)((0, node_path_1.resolve)(currPath, 'extend.php'))) {
+            if ((0, fs_1.existsSync)((0, path_1.resolve)(currPath, 'composer.json')) && (0, fs_1.existsSync)((0, path_1.resolve)(currPath, 'extend.php'))) {
                 return { path: currPath, type: LocationType.FLARUM_EXTENSION };
             }
             if (this.isFlarumCore(currPath)) {
                 return { path: currPath, type: LocationType.FLARUM_CORE };
             }
-            currPath = (0, node_path_1.resolve)(currPath, '..');
+            currPath = (0, path_1.resolve)(currPath, '..');
         }
-        this.error(`${(0, node_path_1.resolve)(currDir)} is not located in a valid Flarum package!
+        this.error(`${(0, path_1.resolve)(currDir)} is not located in a valid Flarum package!
 - Flarum extensions must contain (at a minimum) 'extend.php' and 'composer.json' files.
 - Flarum core must contain a 'composer.json' file with the name 'flarum/core'.
 - Flarum monorepos must have a valid 'flarum-monorepo.json' file`);
@@ -165,14 +174,14 @@ class BaseCommand extends core_1.Command {
         const verify = await this.genIO().getParam({
             name: 'verify',
             type: 'confirm',
-            message: `Work in Flarum package located at ${(0, node_path_1.resolve)(extRoot)}?`,
+            message: `Work in Flarum package located at ${(0, path_1.resolve)(extRoot)}?`,
             initial: true,
         });
         if (!verify)
             this.exit();
     }
     async ensureComposerInstallRan(extRoot) {
-        if ((0, node_fs_1.existsSync)((0, node_path_1.resolve)(extRoot, 'vendor/flarum/core/composer.json')))
+        if ((0, fs_1.existsSync)((0, path_1.resolve)(extRoot, 'vendor/flarum/core/composer.json')))
             return;
         this.log("This command requires `composer install` to have been ran in your extension's root directory.");
         const composer = await this.genIO().getParam({
@@ -183,7 +192,7 @@ class BaseCommand extends core_1.Command {
         });
         if (composer) {
             cli_ux_1.default.action.start('Installing composer packages');
-            (0, node_child_process_1.execSync)('composer install', { cwd: extRoot });
+            (0, child_process_1.execSync)('composer install', { cwd: extRoot });
             cli_ux_1.default.action.stop();
         }
         else {
@@ -197,7 +206,7 @@ class BaseCommand extends core_1.Command {
      */
     async confirmOverrideFiles(dir, pattern, confirmationMessage) {
         const paths = Array.isArray(pattern) ? pattern : [pattern];
-        const files = await (0, globby_1.default)(paths.map(p => (0, node_path_1.resolve)(dir, p)));
+        const files = await (0, globby_1.default)(paths.map((p) => (0, path_1.resolve)(dir, p)));
         const empty = files.length === 0 || (files.length === 1 && files[0] === '.git');
         if (empty)
             return false;
@@ -212,13 +221,17 @@ class BaseCommand extends core_1.Command {
         return true;
     }
     async deleteFiles(dir, pattern) {
-        const pathsToDelete = await (0, globby_1.default)((0, node_path_1.resolve)(dir, pattern));
-        pathsToDelete.forEach(node_fs_1.unlinkSync);
+        const pathsToDelete = await (0, globby_1.default)((0, path_1.resolve)(dir, pattern));
+        pathsToDelete.forEach(fs_1.unlinkSync);
     }
 }
 exports.default = BaseCommand;
 BaseCommand.flags = {
-    'no-interaction': core_1.Flags.boolean({ char: 'n', description: 'Do not ask any interactive questions, assume defaults. When impossible, error.', default: false }),
+    'no-interaction': core_1.Flags.boolean({
+        char: 'n',
+        description: 'Do not ask any interactive questions, assume defaults. When impossible, error.',
+        default: false,
+    }),
     help: core_1.Flags.help({ char: 'h' }),
 };
 BaseCommand.args = [

package/lib/boilersmith/io.d.ts

@@ -1,6 +1,11 @@
-import { PromptObject } from 'prompts';
+import { PromptObject, PromptType } from 'prompts';
+declare type BooleanPromptType = PromptType & ('confirm' | 'toggle');
+declare type StringPromptType = PromptType & ('text' | 'password' | 'invisible' | 'autocomplete');
+declare type DatePromptType = PromptType & 'date';
+declare type ListPromptType = PromptType & 'list';
 export declare type ParamDef<N extends string = string> = Omit<PromptObject<N>, 'name'> & {
     name: N;
+    message: string;
 };
 export declare type Message = {
     type: 'info' | 'warning' | 'error';
@@ -11,7 +16,19 @@ export interface IO {
     /**
      * Prompt the user for some input data.
      */
-    getParam<T>(param: ParamDef): Promise<T>;
+    getParam(param: ParamDef & {
+        type: BooleanPromptType;
+    }, noCache?: boolean): Promise<boolean>;
+    getParam(param: ParamDef & {
+        type: StringPromptType;
+    }, noCache?: boolean): Promise<string>;
+    getParam(param: ParamDef & {
+        type: DatePromptType;
+    }, noCache?: boolean): Promise<Date>;
+    getParam(param: ParamDef & {
+        type: ListPromptType;
+    }, noCache?: boolean): Promise<string[]>;
+    getParam<T>(param: ParamDef, noCache?: boolean): Promise<T>;
     /**
      * Check if some data has already been prompted for.
      */
@@ -32,13 +49,16 @@ export interface IO {
 declare type OnCancel = () => void;
 export declare class PromptsIO implements IO {
     supportsAnsiColor: boolean;
-    private cache;
-    private messages;
-    private noInteraction;
-    private onCancel?;
-    private prev?;
+    protected cache: Map<string, unknown>;
+    protected messages: Message[];
+    protected noInteraction: boolean;
+    protected onCancel?: OnCancel;
+    protected prev?: {
+        val: any;
+        prompt: ParamDef;
+    };
     constructor(initial?: Record<string, unknown>, messages?: Message[], noInteraction?: boolean, onCancel?: OnCancel);
-    getParam<T>(paramDef: ParamDef): Promise<T>;
+    getParam<T>(paramDef: ParamDef, noCache?: boolean): Promise<T>;
     hasCached(name: string): boolean;
     /**
      * @internal