@flarum/cli 1.0.0 → 2.0.0-beta.1

package/lib/steps/update/js-imports.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 UpdateJSImports 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(_pathProvider: PathProvider, _paramProvider: ParamProvider): Record<string, unknown>;
+    getExposed(_paths: Paths, _paramProvider: IO): Record<string, unknown>;
 }

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

@@ -5,49 +5,45 @@ const glob_1 = require("glob");
 const mem_fs_editor_1 = require("mem-fs-editor");
 const CORE_JS_NAMESPACES = ['admin', 'common', 'forum'];
 const CORE_NAMESPACE_REGEX = new RegExp(`^(${CORE_JS_NAMESPACES.join('|')})/`);
-const IMPORT_REGEX = /(?<key>import|export)\s+(?:(?<alias>[\w,{}\s*]+)\s+from)?\s*(?:(["'])?(?<ref>[@\w\s\\/.-]+)\3?)\s*;?/gm;
+const IMPORT_REGEX = /(?<key>import|export)\s+(?:(?<alias>[\s\w*,{}]+)\s+from)?\s*(["'])?(?<ref>[\s\w./@\\-]+)\3?\s*;?/gm;
 class UpdateJSImports {
     constructor() {
         this.type = 'Use full flarum/namespace in JS imports';
         this.composable = false;
         this.exposes = [];
     }
-    async run(fs, pathProvider, _paramProvider, _phpProvider) {
-        const fsEditor = mem_fs_editor_1.create(fs);
+    async run(fs, paths, _paramProvider, _providers) {
+        const fsEditor = (0, mem_fs_editor_1.create)(fs);
         const importMap = {};
-        const jsSrcDir = pathProvider.ext('vendor/flarum/core/js/src');
+        const jsSrcDir = paths.package('vendor/flarum/core/js/src');
         const vendorRegex = new RegExp(`${jsSrcDir}/.*(js|jsx|ts|tsx)`);
         const fsVendorFilePaths = fs.all().map(file => file.path).filter(path => path && vendorRegex.test(path));
         const persistedVendorFilePaths = glob_1.glob.sync(`${jsSrcDir}/**/*.{js,jsx,ts,tsx}`);
-        [...fsVendorFilePaths, ...persistedVendorFilePaths]
-            .forEach(currPath => {
+        for (const currPath of [...fsVendorFilePaths, ...persistedVendorFilePaths]) {
             const withNamespace = currPath.slice(jsSrcDir.length + 1).replace(/\.(js|jsx|ts|tsx)$/, '');
             const noNamespace = withNamespace.replace(CORE_NAMESPACE_REGEX, '');
             importMap[`flarum/${noNamespace}`] = `flarum/${withNamespace}`;
-        });
-        const srcRegex = new RegExp(`${pathProvider.ext('js/src')}/.*(js|jsx|ts|tsx)`);
+        }
+        const srcRegex = new RegExp(`${paths.package('js/src')}/.*(js|jsx|ts|tsx)`);
         const fsSrcFilePaths = fs.all().map(file => file.path).filter(path => path && srcRegex.test(path));
-        const persistedSrcFilePaths = glob_1.glob.sync(pathProvider.ext('js/src/**/*.{js,jsx,ts,tsx}'));
-        [...fsSrcFilePaths, ...persistedSrcFilePaths]
-            .forEach(match => {
+        const persistedSrcFilePaths = glob_1.glob.sync(paths.package('js/src/**/*.{js,jsx,ts,tsx}'));
+        for (const match of [...fsSrcFilePaths, ...persistedSrcFilePaths]) {
             let fileCounted = false;
             const currContents = fsEditor.read(match);
             const newContents = currContents.replace(IMPORT_REGEX, (match, ...args) => {
                 const currImport = args[3];
                 const currImportNoAt = currImport.replace(/^@/, '');
                 const newImport = importMap[currImportNoAt] || currImport;
-                if (newImport !== currImport) {
-                    if (!fileCounted) {
-                        fileCounted = true;
-                    }
+                if (newImport !== currImport && !fileCounted) {
+                    fileCounted = true;
                 }
                 return match.replace(currImport, newImport);
             });
             fsEditor.write(match, newContents);
-        });
+        }
         return fs;
     }
-    getExposed(_pathProvider, _paramProvider) {
+    getExposed(_paths, _paramProvider) {
         return {};
     }
 }

package/lib/utils/composer.d.ts

@@ -0,0 +1,64 @@
+import { Paths } from 'boilersmith/paths';
+import { Store } from 'mem-fs';
+import { ExtensionModules } from '../steps/gen-ext-scaffolder';
+export declare type ComposerJsonSchema = {
+    name?: string;
+    description?: string;
+    type?: string;
+    keywords?: string[];
+    homepage?: string;
+    readme?: string;
+    license?: string;
+    authors?: {
+        name?: string;
+        email?: string;
+        homepage?: string;
+        role?: string;
+    }[];
+    support?: {
+        email?: string;
+        issues?: string;
+        forum?: string;
+        wiki?: string;
+        irc?: string;
+        source?: string;
+        docs?: string;
+        rss?: string;
+        chat?: string;
+    };
+    funding?: {
+        type: string;
+        url: string;
+    }[];
+    require?: Record<string, string>;
+    'require-dev'?: Record<string, string>;
+    conflict?: Record<string, string>;
+    replace?: Record<string, string>;
+    provide?: Record<string, string>;
+    suggest?: Record<string, string>;
+    autoload?: {
+        'psr-4'?: Record<string, string>;
+        classmap?: Record<string, string[]>;
+        files?: Record<string, string[]>;
+        'exclude-from-classmap'?: string[];
+    };
+    'minimum-stability'?: 'dev' | 'alpha' | 'beta' | 'RC' | 'stable';
+    'prefer-stable'?: boolean;
+    extra?: {
+        'flarum-cli'?: {
+            excludeScaffolding?: string[];
+            mainGitBranch?: string;
+            modules?: Record<ExtensionModules, boolean>;
+        };
+        'flarum-extension'?: {
+            title?: string;
+            category?: string;
+            icon?: {
+                name: string;
+                backgroundColor: string;
+                color: string;
+            };
+        };
+    };
+};
+export declare function getComposerJson(fs: Store, paths: Paths): ComposerJsonSchema;

package/lib/utils/composer.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getComposerJson = void 0;
+const mem_fs_editor_1 = require("mem-fs-editor");
+function getComposerJson(fs, paths) {
+    return (0, mem_fs_editor_1.create)(fs).readJSON(paths.package('composer.json'));
+}
+exports.getComposerJson = getComposerJson;

package/lib/utils/migration.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getNextMigrationName = void 0;
+const pad = (val, len) => String(val).padStart(len, '0');
 function getNextMigrationName(currNames, name) {
     const cleanedName = name.toLowerCase().replace(/ /g, '_');
     let number = 0;
@@ -9,13 +10,12 @@ function getNextMigrationName(currNames, name) {
         if (!match)
             continue;
         const now = new Date();
-        if (parseInt(match[1], 10) === now.getFullYear() && parseInt(match[2], 10) === now.getMonth() + 1 && parseInt(match[3], 10) === now.getDate()) {
-            number = parseInt(match[4], 10) + 1;
+        if (Number.parseInt(match[1], 10) === now.getFullYear() && Number.parseInt(match[2], 10) === now.getMonth() + 1 && Number.parseInt(match[3], 10) === now.getDate()) {
+            number = Number.parseInt(match[4], 10) + 1;
             break;
         }
     }
     const now = new Date();
-    const pad = (val, len) => String(val).padStart(len, '0');
     return `${pad(now.getFullYear(), 4)}_${pad(now.getMonth() + 1, 2)}_${pad(now.getDate(), 2)}_${pad(number, 6)}_${cleanedName}`;
 }
 exports.getNextMigrationName = getNextMigrationName;

package/lib/utils/model-name.js

@@ -2,18 +2,18 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.pluralKebabCaseModel = exports.pluralSnakeCaseModel = void 0;
 const tslib_1 = require("tslib");
-const pluralize_1 = tslib_1.__importDefault(require("pluralize"));
-const string_1 = tslib_1.__importDefault(require("string"));
+const pluralize_1 = (0, tslib_1.__importDefault)(require("pluralize"));
+const string_1 = (0, tslib_1.__importDefault)(require("string"));
 function pluralSnakeCaseModel(className) {
     let name;
-    name = string_1.default(className).underscore().toString();
-    name = pluralize_1.default(name.replace('_', ' ')).replace(' ', '_');
+    name = (0, string_1.default)(className).underscore().toString();
+    name = (0, pluralize_1.default)(name.replace('_', ' ')).replace(' ', '_');
     return name;
 }
 exports.pluralSnakeCaseModel = pluralSnakeCaseModel;
 function pluralKebabCaseModel(className) {
-    className = pluralize_1.default(className.charAt(0).toLowerCase() + className.slice(1));
-    className = string_1.default(className).dasherize().s;
+    className = (0, pluralize_1.default)(className.charAt(0).toLowerCase() + className.slice(1));
+    className = (0, string_1.default)(className).dasherize().s;
     return className;
 }
 exports.pluralKebabCaseModel = pluralKebabCaseModel;

package/lib/utils/validation.d.ts

@@ -1,9 +1,12 @@
+declare type ValidatorFunc = true | string;
 export declare class Validator {
-    static class(s: string): true | "Invalid PHP class. Must be qualified, but not fully qualified.";
-    static className(s: string): true | "Invalid PHP class name: only alphanumerical characters allowed.";
-    static routeName(s: string): true | "Invalid path name: only alphanumerical characters allowed and (._-).";
-    static commandName(s: string): true | "Invalid path name: only alphanumerical characters allowed and (._-:).";
-    static migrationName(s: string): true | "Field is required; alphanumerical characters, underscores, and spaces only!";
-    static tableName(s: string): true | "Invalid table name, must be less than 64 alphanumerical characters.";
-    static modelType(s: string): true | "Field is required; alphanumerical characters, dashes, and underscores only!";
+    static class(s: string): ValidatorFunc;
+    static optionalClass(s: string): ValidatorFunc;
+    static className(s: string): ValidatorFunc;
+    static routeName(s: string): ValidatorFunc;
+    static commandName(s: string): ValidatorFunc;
+    static migrationName(s: string): ValidatorFunc;
+    static tableName(s: string): ValidatorFunc;
+    static modelType(s: string): ValidatorFunc;
 }
+export {};

package/lib/utils/validation.js

@@ -3,25 +3,28 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Validator = void 0;
 class Validator {
     static class(s) {
-        return /^([0-9a-zA-Z]+)(\\([0-9a-zA-Z]+))*$/.test(s.trim()) || 'Invalid PHP class. Must be qualified, but not fully qualified.';
+        return /^([\dA-Za-z]+)(\\([\dA-Za-z]+))*$/.test(s.trim()) || 'Invalid PHP class. Must be qualified, but not fully qualified.';
+    }
+    static optionalClass(s) {
+        return s.length === 0 || Validator.class(s);
     }
     static className(s) {
-        return /^([0-9a-zA-Z]+)$/.test(s.trim()) || 'Invalid PHP class name: only alphanumerical characters allowed.';
+        return /^([\dA-Za-z]+)$/.test(s.trim()) || 'Invalid PHP class name: only alphanumerical characters allowed.';
     }
     static routeName(s) {
-        return /^([A-z-._0-9]+)$/.test(s.trim()) || 'Invalid path name: only alphanumerical characters allowed and (._-).';
+        return /^([\d.A-z-]+)$/.test(s.trim()) || 'Invalid path name: only alphanumerical characters allowed and (._-).';
     }
     static commandName(s) {
-        return /^([A-z-.:_0-9]+)$/.test(s.trim()) || 'Invalid path name: only alphanumerical characters allowed and (._-:).';
+        return /^([\d.:A-z-]+)$/.test(s.trim()) || 'Invalid path name: only alphanumerical characters allowed and (._-:).';
     }
     static migrationName(s) {
         return /^\w+$/.test(s.trim()) || 'Field is required; alphanumerical characters, underscores, and spaces only!';
     }
     static tableName(s) {
-        return /^[0-9,a-z,A-Z$_]{0,64}$/.test(s.trim()) || 'Invalid table name, must be less than 64 alphanumerical characters.';
+        return /^[\w$,]{0,64}$/.test(s.trim()) || 'Invalid table name, must be less than 64 alphanumerical characters.';
     }
     static modelType(s) {
-        return /^[0-9a-zA-Z_-]+$/.test(s.trim()) || 'Field is required; alphanumerical characters, dashes, and underscores only!';
+        return /^[\w-]+$/.test(s.trim()) || 'Field is required; alphanumerical characters, dashes, and underscores only!';
     }
 }
 exports.Validator = Validator;

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"1.0.0","commands":{"init":{"id":"init","description":"Create a new Flarum extension","pluginName":"@flarum/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"path","description":"Where should this command be executed?"}]},"infra:backend-testing":{"id":"infra:backend-testing","description":"Add/Update backend testing infrastructure","pluginName":"@flarum/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"path","description":"Where should this command be executed?"}]},"update:js-imports":{"id":"update:js-imports","description":"Updates JS imports from core to use proper namespaces","pluginName":"@flarum/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"path","description":"Where should this command be executed?"}]},"make:backend:api-controller":{"id":"make:backend:api-controller","description":"Generate an API controller class","pluginName":"@flarum/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"path","description":"Where should this command be executed?"}]},"make:backend:api-serializer-attributes":{"id":"make:backend:api-serializer-attributes","description":"Generate an API serializer attributes extender","pluginName":"@flarum/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"path","description":"Where should this command be executed?"}]},"make:backend:api-serializer":{"id":"make:backend:api-serializer","description":"Generate an API serializer class","pluginName":"@flarum/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"path","description":"Where should this command be executed?"}]},"make:backend:command":{"id":"make:backend:command","description":"Generate a console command class","pluginName":"@flarum/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"path","description":"Where should this command be executed?"}]},"make:backend:event-listener":{"id":"make:backend:event-listener","description":"Generate an event listener class","pluginName":"@flarum/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"path","description":"Where should this command be executed?"}]},"make:backend:handler":{"id":"make:backend:handler","description":"Generate a domain logic handler class","pluginName":"@flarum/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"path","description":"Where should this command be executed?"}]},"make:backend:integration-test":{"id":"make:backend:integration-test","description":"Generate an integration test class","pluginName":"@flarum/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"path","description":"Where should this command be executed?"}]},"make:backend:job":{"id":"make:backend:job","description":"Generate a job class","pluginName":"@flarum/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"path","description":"Where should this command be executed?"}]},"make:backend:migration":{"id":"make:backend:migration","description":"Generate a migration","pluginName":"@flarum/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"path","description":"Where should this command be executed?"}]},"make:backend:model":{"id":"make:backend:model","description":"Generate a model class","pluginName":"@flarum/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"path","description":"Where should this command be executed?"}]},"make:backend:policy":{"id":"make:backend:policy","description":"Generate a policy class","pluginName":"@flarum/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"path","description":"Where should this command be executed?"}]},"make:backend:repository":{"id":"make:backend:repository","description":"Generate a repository class","pluginName":"@flarum/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"path","description":"Where should this command be executed?"}]},"make:backend:route":{"id":"make:backend:route","description":"Generate a routes extender","pluginName":"@flarum/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"path","description":"Where should this command be executed?"}]},"make:backend:service-provider":{"id":"make:backend:service-provider","description":"Generate a service provider class","pluginName":"@flarum/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"path","description":"Where should this command be executed?"}]},"make:backend:validator":{"id":"make:backend:validator","description":"Generate a validator class","pluginName":"@flarum/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"path","description":"Where should this command be executed?"}]},"make:frontend:component":{"id":"make:frontend:component","description":"Generate a frontend component","pluginName":"@flarum/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"path","description":"Where should this command be executed?"}]},"make:frontend:modal":{"id":"make:frontend:modal","description":"Generate a modal component","pluginName":"@flarum/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"path","description":"Where should this command be executed?"}]},"make:frontend:model":{"id":"make:frontend:model","description":"Generate a model class","pluginName":"@flarum/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"path","description":"Where should this command be executed?"}]}}}
+{"version":"2.0.0-beta.1","commands":{"infra":{"id":"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.","pluginName":"@flarum/cli","pluginType":"core","aliases":[],"flags":{"monorepo":{"name":"monorepo","type":"boolean","char":"m","allowNo":false},"defaults":{"name":"defaults","type":"boolean","char":"d","description":"Assume default responses to prompts where possible.","allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[{"name":"module","description":"The name of the module to enable/update.","required":true,"options":["core","icon","js","jsCommon","css","locale","gitConf","githubActions","prettier","typescript","bundlewatch","backendTesting","editorConfig","styleci"]},{"name":"path","description":"Where should this command be executed?"}]},"init":{"id":"init","description":"Create a new Flarum extension","pluginName":"@flarum/cli","pluginType":"core","aliases":[],"flags":{"defaults":{"name":"defaults","type":"boolean","char":"d","description":"Assume default responses to prompts where possible.","allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[{"name":"path","description":"Where should this command be executed?"}]},"audit:infra":{"id":"audit:infra","description":"Check for outdated config files, infrastructure, setup, etc.","pluginName":"@flarum/cli","pluginType":"core","aliases":[],"flags":{"fix":{"name":"fix","type":"boolean","char":"f","allowNo":false},"monorepo":{"name":"monorepo","type":"boolean","char":"m","allowNo":false},"defaults":{"name":"defaults","type":"boolean","char":"d","description":"Assume default responses to prompts where possible.","allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[{"name":"path","description":"Where should this command be executed?"}]},"update:js-imports":{"id":"update:js-imports","description":"Updates JS imports from core to use proper namespaces","pluginName":"@flarum/cli","pluginType":"core","aliases":[],"flags":{"defaults":{"name":"defaults","type":"boolean","char":"d","description":"Assume default responses to prompts where possible.","allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[{"name":"path","description":"Where should this command be executed?"}]},"make:backend:api-controller":{"id":"make:backend:api-controller","description":"Generate an API controller class","pluginName":"@flarum/cli","pluginType":"core","aliases":[],"flags":{"defaults":{"name":"defaults","type":"boolean","char":"d","description":"Assume default responses to prompts where possible.","allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[{"name":"path","description":"Where should this command be executed?"}]},"make:backend:api-serializer-attributes":{"id":"make:backend:api-serializer-attributes","description":"Generate an API serializer attributes extender","pluginName":"@flarum/cli","pluginType":"core","aliases":[],"flags":{"defaults":{"name":"defaults","type":"boolean","char":"d","description":"Assume default responses to prompts where possible.","allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[{"name":"path","description":"Where should this command be executed?"}]},"make:backend:api-serializer":{"id":"make:backend:api-serializer","description":"Generate an API serializer class","pluginName":"@flarum/cli","pluginType":"core","aliases":[],"flags":{"defaults":{"name":"defaults","type":"boolean","char":"d","description":"Assume default responses to prompts where possible.","allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[{"name":"path","description":"Where should this command be executed?"}]},"make:backend:command":{"id":"make:backend:command","description":"Generate a console command class","pluginName":"@flarum/cli","pluginType":"core","aliases":[],"flags":{"defaults":{"name":"defaults","type":"boolean","char":"d","description":"Assume default responses to prompts where possible.","allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[{"name":"path","description":"Where should this command be executed?"}]},"make:backend:event-listener":{"id":"make:backend:event-listener","description":"Generate an event listener class","pluginName":"@flarum/cli","pluginType":"core","aliases":[],"flags":{"defaults":{"name":"defaults","type":"boolean","char":"d","description":"Assume default responses to prompts where possible.","allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[{"name":"path","description":"Where should this command be executed?"}]},"make:backend:handler":{"id":"make:backend:handler","description":"Generate a domain logic handler class","pluginName":"@flarum/cli","pluginType":"core","aliases":[],"flags":{"defaults":{"name":"defaults","type":"boolean","char":"d","description":"Assume default responses to prompts where possible.","allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[{"name":"path","description":"Where should this command be executed?"}]},"make:backend:integration-test":{"id":"make:backend:integration-test","description":"Generate an integration test class","pluginName":"@flarum/cli","pluginType":"core","aliases":[],"flags":{"defaults":{"name":"defaults","type":"boolean","char":"d","description":"Assume default responses to prompts where possible.","allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[{"name":"path","description":"Where should this command be executed?"}]},"make:backend:job":{"id":"make:backend:job","description":"Generate a job class","pluginName":"@flarum/cli","pluginType":"core","aliases":[],"flags":{"defaults":{"name":"defaults","type":"boolean","char":"d","description":"Assume default responses to prompts where possible.","allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[{"name":"path","description":"Where should this command be executed?"}]},"make:backend:migration":{"id":"make:backend:migration","description":"Generate a migration","pluginName":"@flarum/cli","pluginType":"core","aliases":[],"flags":{"defaults":{"name":"defaults","type":"boolean","char":"d","description":"Assume default responses to prompts where possible.","allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[{"name":"path","description":"Where should this command be executed?"}]},"make:backend:model":{"id":"make:backend:model","description":"Generate a model class","pluginName":"@flarum/cli","pluginType":"core","aliases":[],"flags":{"defaults":{"name":"defaults","type":"boolean","char":"d","description":"Assume default responses to prompts where possible.","allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[{"name":"path","description":"Where should this command be executed?"}]},"make:backend:policy":{"id":"make:backend:policy","description":"Generate a policy class","pluginName":"@flarum/cli","pluginType":"core","aliases":[],"flags":{"defaults":{"name":"defaults","type":"boolean","char":"d","description":"Assume default responses to prompts where possible.","allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[{"name":"path","description":"Where should this command be executed?"}]},"make:backend:repository":{"id":"make:backend:repository","description":"Generate a repository class","pluginName":"@flarum/cli","pluginType":"core","aliases":[],"flags":{"defaults":{"name":"defaults","type":"boolean","char":"d","description":"Assume default responses to prompts where possible.","allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[{"name":"path","description":"Where should this command be executed?"}]},"make:backend:route":{"id":"make:backend:route","description":"Generate a routes extender","pluginName":"@flarum/cli","pluginType":"core","aliases":[],"flags":{"defaults":{"name":"defaults","type":"boolean","char":"d","description":"Assume default responses to prompts where possible.","allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[{"name":"path","description":"Where should this command be executed?"}]},"make:backend:service-provider":{"id":"make:backend:service-provider","description":"Generate a service provider class","pluginName":"@flarum/cli","pluginType":"core","aliases":[],"flags":{"defaults":{"name":"defaults","type":"boolean","char":"d","description":"Assume default responses to prompts where possible.","allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[{"name":"path","description":"Where should this command be executed?"}]},"make:backend:validator":{"id":"make:backend:validator","description":"Generate a validator class","pluginName":"@flarum/cli","pluginType":"core","aliases":[],"flags":{"defaults":{"name":"defaults","type":"boolean","char":"d","description":"Assume default responses to prompts where possible.","allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[{"name":"path","description":"Where should this command be executed?"}]},"make:frontend:component":{"id":"make:frontend:component","description":"Generate a frontend component","pluginName":"@flarum/cli","pluginType":"core","aliases":[],"flags":{"defaults":{"name":"defaults","type":"boolean","char":"d","description":"Assume default responses to prompts where possible.","allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[{"name":"path","description":"Where should this command be executed?"}]},"make:frontend:modal":{"id":"make:frontend:modal","description":"Generate a modal component","pluginName":"@flarum/cli","pluginType":"core","aliases":[],"flags":{"defaults":{"name":"defaults","type":"boolean","char":"d","description":"Assume default responses to prompts where possible.","allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[{"name":"path","description":"Where should this command be executed?"}]},"make:frontend:model":{"id":"make:frontend:model","description":"Generate a model class","pluginName":"@flarum/cli","pluginType":"core","aliases":[],"flags":{"defaults":{"name":"defaults","type":"boolean","char":"d","description":"Assume default responses to prompts where possible.","allowNo":false},"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[{"name":"path","description":"Where should this command be executed?"}]}}}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@flarum/cli",
   "description": "A CLI for developing Flarum extensions",
-  "version": "1.0.0",
+  "version": "2.0.0-beta.1",
   "author": "Flarum Team",
   "bin": {
     "fl": "bin/run",
@@ -9,30 +9,39 @@
   },
   "bugs": "https://github.com/flarum/cli/issues",
   "devDependencies": {
+    "@babel/core": "^7",
     "@oclif/dev-cli": "^1.26.0",
     "@oclif/test": "^1.2.8",
     "@types/chai": "^4.2.20",
-    "@types/jest": "^26.0.24",
+    "@types/ejs": "^3.1.0",
+    "@types/jest": "^27.0.3",
     "@types/mem-fs-editor": "^7.0.0",
-    "@types/node": "^10.17.55",
+    "@types/node": "^16.11.7",
+    "@types/pick-deep": "^1.0.0",
     "@types/pluralize": "0.0.29",
     "@types/prompts": "^2.0.14",
     "@types/string": "0.0.31",
     "@types/yosay": "^0.0.29",
-    "babel-jest": "^26.6.3",
+    "@typescript-eslint/parser": "^5.8.1",
+    "babel-jest": "^27.4.5",
+    "babel-plugin-module-resolver": "^4.1.0",
     "chai": "^4.3.3",
-    "eslint": "^5.16.0",
-    "eslint-config-oclif": "^3.1.0",
-    "eslint-config-oclif-typescript": "^0.1.0",
+    "eslint": "^7.32.0",
+    "eslint-config-oclif": "^4.0.0",
+    "eslint-config-oclif-typescript": "1.0.2",
+    "eslint-import-resolver-babel-module": "^5.3.1",
+    "eslint-import-resolver-typescript": "^2.5.0",
+    "eslint-plugin-import": "^2.25.3",
     "globby": "^10.0.2",
-    "jest": "^26.6.3",
-    "jest-extended": "^0.11.5",
-    "ts-jest": "^26.5.6",
+    "jest": "^27.4.5",
+    "jest-extended": "^1.2.0",
+    "ts-jest": "^27.1.2",
     "ts-node": "^8.10.2",
-    "typescript": "^3.9.9"
+    "tsconfig-paths": "^3.12.0",
+    "typescript": "4.4.4"
   },
   "engines": {
-    "node": ">=8.0.0"
+    "node": ">=12.0.0"
   },
   "files": [
     "/bin",
@@ -48,56 +57,69 @@
     "oclif"
   ],
   "license": "MIT",
-  "main": "lib/index.js",
+  "main": "./lib/index.js",
   "oclif": {
+    "additionalHelpFlags": [
+      "-h"
+    ],
+    "additionalVersionFlags": [
+      "-v"
+    ],
     "commands": "./lib/commands",
     "bin": "flarum-cli",
     "helpClass": "./lib/help",
-    "plugins": [
-      "@oclif/plugin-help",
-      "@tiagonapoli/oclif-plugin-spaced-commands"
-    ],
+    "topicSeparator": " ",
     "topics": {
-      "make:backend": {
+      "make backend": {
         "description": "Add backend boilerplate code to an existing Flarum extension."
       },
-      "make:frontend": {
+      "make frontend": {
         "description": "Add frontend boilerplate code to an existing Flarum extension."
       },
       "make": {
         "description": "Add boilerplate code to an existing Flarum extension."
       },
-      "infra": {
-        "description": "Add/modify infrastructure for an existing Flarum extension."
+      "audit": {
+        "description": "Checks for potential errors / updatable parts of a Flarum extension."
       }
-    }
+    },
+    "plugins": [
+      "@oclif/plugin-help",
+      "@oclif/plugin-plugins",
+      "@oclif/plugin-version"
+    ]
   },
   "repository": "flarum/cli",
   "scripts": {
+    "oclif-dev": "node -r tsconfig-paths/register node_modules/.bin/oclif-dev",
     "format": "eslint . --ext .ts --config .eslintrc --fix",
     "postpack": "rm -f oclif.manifest.json",
-    "posttest": "eslint . --ext .ts --config .eslintrc",
-    "prepack": "rm -rf lib && tsc -b && oclif-dev manifest && oclif-dev readme",
+    "posttest": "eslint . --ext .ts --config .eslintrc && tsc --build --dry",
+    "prepack": "rm -rf lib && tsc --project tsconfig.build.json && yarn oclif-dev manifest && yarn oclif-dev readme",
     "test": "jest",
-    "version": "oclif-dev readme && git add README.md"
+    "version": "yarn oclif-dev readme && git add README.md"
   },
   "types": "lib/index.d.ts",
   "dependencies": {
     "@babel/preset-env": "^7.14.2",
-    "@oclif/command": "^1.8.0",
-    "@oclif/config": "^1.17.0",
-    "@oclif/plugin-autocomplete": "^0.3.0",
-    "@oclif/plugin-help": "^3.2.2",
-    "@tiagonapoli/oclif-plugin-spaced-commands": "^0.0.6",
-    "@zodash/pick": "^1.1.6",
+    "@oclif/core": "^1.0.11",
+    "@oclif/errors": "^1.3.5",
+    "@oclif/plugin-help": "^5",
+    "@oclif/plugin-plugins": "^2.0.11",
+    "@oclif/plugin-version": "^1",
     "chalk": "^2.4.2",
+    "cli-ux": "^6.0.6",
+    "ejs": "^3.1.6",
     "glob": "^7.1.6",
     "just-safe-get": "^2.1.2",
     "mem-fs": "^2.2.1",
     "mem-fs-editor": "^8.0.0",
     "modern-async": "^1.0.2",
+    "module-alias": "^2.2.2",
+    "pick-deep": "^1.0.0",
     "pluralize": "^8.0.0",
     "prompts": "^2.4.0",
+    "simple-git": "^2.48.0",
     "spdx-license-list": "^6.4.0",
     "string": "^3.3.3",
     "tslib": "^1.14.1",

package/php-subsystem/src/NodeVisitors/AddExtender.php

@@ -32,7 +32,8 @@ class AddExtender extends NodeVisitorAbstract
   {
     if ($node instanceof Node\Stmt\Return_ && $node->expr instanceof Node\Expr\Array_) {
         if (! isset($this->params['extender'])) {
-            throw new \Exception('Invalid Extender Schema');
+            $params = json_encode($this->params);
+            throw new \Exception("Invalid Extender Schema. Provided params: $params");
         }
 
       $extender = $this->getOrCreateExtender($node->expr, $this->params['extender']);

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

@@ -1,32 +0,0 @@
-name: JavaScript
-
-on:
-  push:
-    branches:
-      - main
-
-jobs:
-  build:
-    name: JS / Build
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Check out code
-        uses: actions/checkout@v2
-
-      - name: Restore npm cache
-        uses: actions/cache@v2
-        with:
-          path: ~/.npm
-          key: ${{ runner.os }}-node-${{ hashFiles('js/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-node-
-
-      # Our action will install npm, cd into `./js`, run `npm run build` and
-      # `npm run build-typings`, then commit and upload any changes
-      - name: Build production JS
-        uses: flarum/action-build@2
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          build_script: build
-          package_manager: yarn

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

@@ -1,32 +0,0 @@
-name: Lint
-
-on:
-  workflow_dispatch:
-  push:
-    paths:
-      - 'js/src/**'
-  pull_request:
-    paths:
-      - 'js/src/**'
-
-jobs:
-  prettier:
-    name: JS / Prettier
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Check out code
-        uses: actions/checkout@v2
-
-      - name: Set up Node
-        uses: actions/setup-node@v2
-        with:
-          node-version: "14"
-
-      - name: Install JS dependencies
-        run: npm i
-        working-directory: ./js
-
-      - name: Check JS formatting
-        run: npm run format-check
-        working-directory: ./js

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

@@ -1,78 +0,0 @@
-name: Tests
-
-on: [push, pull_request]
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        php: [7.3, 7.4, '8.0']
-        service: ['mysql:5.7', mariadb]
-        prefix: ['', flarum_]
-
-        include:
-          - service: 'mysql:5.7'
-            db: MySQL
-          - service: mariadb
-            db: MariaDB
-          - prefix: flarum_
-            prefixStr: (prefix)
-
-        exclude:
-          - php: 7.3
-            service: 'mysql:5.7'
-            prefix: flarum_
-          - php: 7.3
-            service: mariadb
-            prefix: flarum_
-          - php: 8.0
-            service: 'mysql:5.7'
-            prefix: flarum_
-          - php: 8.0
-            service: mariadb
-            prefix: flarum_
-
-    services:
-      mysql:
-        image: ${{ matrix.service }}
-        ports:
-          - 13306:3306
-
-    name: 'PHP ${{ matrix.php }} / ${{ matrix.db }} ${{ matrix.prefixStr }}'
-
-    steps:
-      - uses: actions/checkout@master
-
-      - name: Setup PHP
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: ${{ matrix.php }}
-          coverage: xdebug
-          extensions: curl, dom, gd, json, mbstring, openssl, pdo_mysql, tokenizer, zip
-          tools: phpunit, composer:v2
-
-      # The authentication alter is necessary because newer mysql versions use the `caching_sha2_password` driver,
-      # which isn't supported prior to PHP7.4
-      # When we drop support for PHP7.3, we should remove this from the setup.
-      - name: Create MySQL Database
-        run: |
-          sudo systemctl start mysql
-          mysql -uroot -proot -e 'CREATE DATABASE flarum_test;' --port 13306
-          mysql -uroot -proot -e "ALTER USER 'root'@'localhost' IDENTIFIED WITH mysql_native_password BY 'root';" --port 13306
-
-      - name: Install Composer dependencies
-        run: composer install
-
-      - name: Setup Composer tests
-        run: composer test:setup
-        env:
-          DB_PORT: 13306
-          DB_PASSWORD: root
-          DB_PREFIX: ${{ matrix.prefix }}
-
-      - name: Run Composer tests
-        run: composer test
-        env:
-          COMPOSER_PROCESS_TIMEOUT: 600