@flarum/cli 3.0.11 → 3.0.13

package/lib/commands/upgrade/2.0.js

@@ -8,6 +8,7 @@ const import_ext_1 = tslib_1.__importDefault(require("../../steps/upgrade/twopoi
 const compat_1 = tslib_1.__importDefault(require("../../steps/upgrade/twopointoh/frontend/export-registry/compat"));
 const usage_of_lazy_modules_1 = tslib_1.__importDefault(require("../../steps/upgrade/twopointoh/frontend/code-splitting/usage-of-lazy-modules"));
 const misc_1 = tslib_1.__importDefault(require("../../steps/upgrade/twopointoh/frontend/misc"));
+const admin_extender_1 = tslib_1.__importDefault(require("../../steps/upgrade/twopointoh/frontend/admin-extender"));
 const format_1 = tslib_1.__importDefault(require("../../steps/upgrade/twopointoh/frontend/format"));
 const chalk_1 = tslib_1.__importDefault(require("chalk"));
 const misc_2 = tslib_1.__importDefault(require("../../steps/upgrade/twopointoh/backend/misc"));
@@ -17,14 +18,90 @@ const json_api_1 = tslib_1.__importDefault(require("../../steps/upgrade/twopoint
 const search_1 = tslib_1.__importDefault(require("../../steps/upgrade/twopointoh/backend/search"));
 const less_1 = tslib_1.__importDefault(require("../../steps/upgrade/twopointoh/less"));
 const phpunit_1 = tslib_1.__importDefault(require("../../steps/upgrade/twopointoh/backend/phpunit"));
+const model_factories_1 = tslib_1.__importDefault(require("../../steps/upgrade/twopointoh/backend/model-factories"));
 const core_1 = require("@oclif/core");
 const email_views_1 = tslib_1.__importDefault(require("../../steps/upgrade/twopointoh/backend/email-views"));
 const intervention_image_1 = tslib_1.__importDefault(require("../../steps/upgrade/twopointoh/backend/intervention-image"));
+const child_process_1 = require("child_process");
+const fs_1 = tslib_1.__importDefault(require("fs"));
+const os_1 = tslib_1.__importDefault(require("os"));
+const path_1 = tslib_1.__importDefault(require("path"));
+const simple_git_1 = tslib_1.__importDefault(require("simple-git"));
 class TwoPointOh extends base_command_1.default {
     constructor() {
         super(...arguments);
         this.requireExistingExtension = true;
         this.skipFinalMessage = true;
+        /**
+         * The steps this run was asked to take, in order.
+         */
+        this.scheduled = [];
+        this.checkout = null;
+    }
+    async run() {
+        try {
+            await super.run();
+        }
+        finally {
+            await this.removeCheckout();
+        }
+    }
+    async additionalPreRunChecks(extRoot) {
+        if (this.flags.check) {
+            this.checkout = await this.createCheckout(extRoot);
+        }
+    }
+    stepsPath(requested) {
+        var _a, _b;
+        return (_b = (_a = this.checkout) === null || _a === void 0 ? void 0 : _a.root) !== null && _b !== void 0 ? _b : requested;
+    }
+    genIO() {
+        var _a;
+        // A check asks nothing: there is nothing to confirm.
+        if ((_a = this.flags) === null || _a === void 0 ? void 0 : _a.check)
+            this.flags['no-interaction'] = true;
+        return super.genIO();
+    }
+    async createCheckout(extRoot) {
+        const root = fs_1.default.realpathSync(extRoot);
+        const git = (0, simple_git_1.default)(root);
+        let repo;
+        try {
+            repo = (await git.revparse(['--show-toplevel'])).trim();
+        }
+        catch (_a) {
+            this.error('--check runs the upgrade on a copy of the extension in a git worktree, so the extension must be in a git repository.', {
+                code: 'FL_ERR',
+            });
+        }
+        const commit = (await git.revparse(['HEAD'])).trim();
+        const dirty = !(await git.status()).isClean();
+        const worktree = fs_1.default.mkdtempSync(path_1.default.join(fs_1.default.realpathSync(os_1.default.tmpdir()), 'flarum-upgrade-check-'));
+        const branch = `flarum-upgrade-check/${path_1.default.basename(worktree)}`;
+        await (0, simple_git_1.default)(repo).raw(['worktree', 'add', '--quiet', '-b', branch, worktree, commit]);
+        return { repo, worktree, branch, root: path_1.default.join(worktree, path_1.default.relative(repo, root)), commit, dirty, cwd: process.cwd() };
+    }
+    /** Remove the worktree and its branch, saying so if it can't. */
+    async removeCheckout() {
+        const checkout = this.checkout;
+        if (!checkout)
+            return;
+        this.checkout = null;
+        // The steps ran from inside the worktree.
+        process.chdir(checkout.cwd);
+        try {
+            await (0, simple_git_1.default)(checkout.repo).raw(['worktree', 'remove', '--force', checkout.worktree]);
+            await (0, simple_git_1.default)(checkout.repo).raw(['branch', '-D', checkout.branch]);
+        }
+        catch (error) {
+            process.stderr.write(`The check could not remove its worktree ${checkout.worktree} and branch ${checkout.branch}: ${error.message}\n` +
+                `Remove them with: git worktree remove --force ${checkout.worktree} && git branch -D ${checkout.branch}\n`);
+        }
+    }
+    /** What a step that committed in the worktree would change, from its commit. */
+    wouldChange(sha) {
+        const show = (...args) => (0, child_process_1.execFileSync)('git', ['show', '--format=', '--no-color', '--no-ext-diff', ...args, sha], { cwd: this.checkout.worktree, encoding: 'utf8' });
+        return { files: show('--name-only').split('\n').filter(Boolean), diff: show() };
     }
     steps(steps, extRoot) {
         // Error.stackTraceLimit = Number.POSITIVE_INFINITY;
@@ -37,6 +114,7 @@ class TwoPointOh extends base_command_1.default {
             import_ext_1.default,
             usage_of_lazy_modules_1.default,
             misc_1.default,
+            admin_extender_1.default,
             // Backend
             misc_2.default,
             filesystem_1.default,
@@ -45,6 +123,7 @@ class TwoPointOh extends base_command_1.default {
             json_api_1.default,
             intervention_image_1.default,
             search_1.default,
+            model_factories_1.default,
             phpunit_1.default,
             // LESS
             less_1.default,
@@ -57,23 +136,44 @@ class TwoPointOh extends base_command_1.default {
             total++;
         });
         collection = collection.map((Step) => {
-            const step = new Step(this, extRoot, stepCount, total, this.flags['force-steps']);
+            var _a, _b;
+            const step = new Step(this, (_b = (_a = this.checkout) === null || _a === void 0 ? void 0 : _a.root) !== null && _b !== void 0 ? _b : extRoot, stepCount, total, this.flags['force-steps'] || this.flags.check);
+            step.checking = Boolean(this.flags.check);
             stepCount++;
             return step;
         });
         if (this.flags.step) {
             const step = Number.parseInt(this.flags.step, 10);
             if (step > 0 && step <= total) {
+                this.scheduled = [collection[step - 1]];
                 return steps.step(collection[step - 1]);
             }
             this.error(`Invalid step number. Please provide a number between 1 and ${total}`);
         }
+        this.scheduled = collection;
         collection.forEach((step) => {
             steps.step(step);
         });
         return steps;
     }
+    jsonReport(succeeded, error, messages) {
+        return Object.assign(Object.assign(Object.assign({}, super.jsonReport(succeeded, error, messages)), (this.checkout && { check: { commit: this.checkout.commit, uncommittedChangesLeftOut: this.checkout.dirty } })), { steps: this.scheduled.map((step) => (Object.assign({ step: step.number, title: step.type }, this.reported(step)))) });
+    }
+    /** A step's outcome, as what it would change when checking. */
+    reported(step) {
+        var _a;
+        const outcome = (_a = step.outcome) !== null && _a !== void 0 ? _a : { status: 'not-run' };
+        if (!this.checkout || outcome.status !== 'committed')
+            return outcome;
+        return Object.assign(Object.assign({ status: 'would-change' }, this.wouldChange(outcome.commit.sha)), { notes: outcome.notes, todos: outcome.todos });
+    }
     welcomeMessage() {
+        if (this.flags.check) {
+            return `
+    Checking what the Flarum 2.0 upgrade would change in your extension. The steps run on its last commit,
+    in a temporary git worktree that is removed afterwards: nothing in your extension changes.
+    `;
+        }
         const beforeProceeding = chalk_1.default.bold.red('Before proceeding:');
         const command = chalk_1.default.bold.bgYellow.black('fl update js-imports');
         const makeSure = chalk_1.default.bold.dim(`- Make sure your extend.php file directly returns an array of extenders.
@@ -90,6 +190,25 @@ class TwoPointOh extends base_command_1.default {
     `;
     }
     goodbyeMessage() {
+        if (this.checkout) {
+            const changing = this.scheduled.filter((step) => { var _a; return ((_a = step.outcome) === null || _a === void 0 ? void 0 : _a.status) === 'committed'; });
+            const lines = changing.map((step) => {
+                const { files } = this.wouldChange(step.outcome.commit.sha);
+                return `    - Step ${step.number}, ${step.type} ${chalk_1.default.dim(files.join(', '))}`;
+            });
+            return [
+                changing.length > 0
+                    ? `    ${changing.length} of the steps would change something in ${this.checkout.commit.slice(0, 7)}:`
+                    : `    None of the steps would change anything in ${this.checkout.commit.slice(0, 7)}.`,
+                ...lines,
+                this.checkout.dirty && '    Changes that were not committed were left out of the check.',
+                '',
+                '    Nothing was changed. Run with --json as well to see each diff, or without --check to make the changes.',
+                '',
+            ]
+                .filter((line) => line !== false)
+                .join('\n');
+        }
         const composer = chalk_1.default.bold.bgYellow('composer update');
         const yarn = chalk_1.default.bold.bgYellow('yarn install');
         return `    Your extension has been successfully upgraded to Flarum 2.0.
@@ -103,11 +222,18 @@ class TwoPointOh extends base_command_1.default {
 }
 exports.default = TwoPointOh;
 TwoPointOh.description = 'Upgrade an extension to Flarum 2.0';
-TwoPointOh.flags = Object.assign(Object.assign({}, base_command_1.default.flags), { step: core_1.Flags.string({
+TwoPointOh.enableJsonFlag = true;
+TwoPointOh.flags = Object.assign(Object.assign({}, base_command_1.default.flags), { json: core_1.Flags.boolean({
+        description: "Report each step's outcome, failures, notes and the @TODOs it left as JSON, for a program driving the upgrade. Implies --no-interaction.",
+        required: false,
+    }), step: core_1.Flags.string({
         description: 'Optionally specify a specific step to run',
         required: false,
     }), 'force-steps': core_1.Flags.boolean({
         description: 'Force run steps even if already ran',
         required: false,
+    }), check: core_1.Flags.boolean({
+        description: 'Report what the upgrade would change, such as on an extension already on Flarum 2.0, without changing it: the steps run on the last commit, in a temporary git worktree that is removed afterwards. Implies --force-steps and --no-interaction.',
+        required: false,
     }) });
 TwoPointOh.args = [...base_command_1.default.args];

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

@@ -1,4 +1,9 @@
 import { Scaffolder } from 'boilersmith/scaffolding/scaffolder';
+/**
+ * The SPDX text for a licence, or an empty string when it isn't a known SPDX
+ * identifier (e.g. "proprietary" or a free-form "© Some Company").
+ */
+export declare function licenseTextFor(licenseType: unknown): string;
 export declare const EXTENSION_PARAMS: readonly ["packageName", "packageDescription", "packageNamespace", "authorName", "authorEmail", "extensionName", "licenseType", "mainGitBranch", "jsPackageManager", "licenseText", "extensionId", "year", "backendDirectory", "frontendDirectory"];
 export type ExtensionParams = (typeof EXTENSION_PARAMS)[number];
 export declare const EXTENSION_MODULES: readonly ["core", "icon", "admin", "forum", "js", "jsCommon", "css", "locale", "gitConf", "githubActions", "prettier", "typescript", "bundlewatch", "frontendTesting", "backendTesting", "phpstan", "editorConfig", "styleci"];

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.genExtScaffolder = exports.EXTENSION_MODULES = exports.EXTENSION_PARAMS = void 0;
+exports.genExtScaffolder = exports.EXTENSION_MODULES = exports.EXTENSION_PARAMS = exports.licenseTextFor = void 0;
 const tslib_1 = require("tslib");
 const scaffolder_1 = require("boilersmith/scaffolding/scaffolder");
 const chalk_1 = tslib_1.__importDefault(require("chalk"));
@@ -15,6 +15,17 @@ const string_1 = tslib_1.__importDefault(require("string"));
 function assertUnreachable(_x) {
     throw new Error("Didn't expect to get here");
 }
+/**
+ * The SPDX text for a licence, or an empty string when it isn't a known SPDX
+ * identifier (e.g. "proprietary" or a free-form "© Some Company").
+ */
+function licenseTextFor(licenseType) {
+    if (typeof licenseType !== 'string' || !licenseType)
+        return '';
+    const id = [...simple_1.default].find((l) => l.toLowerCase() === licenseType.toLowerCase());
+    return id ? require(`spdx-license-list/licenses/${id}`).licenseText : '';
+}
+exports.licenseTextFor = licenseTextFor;
 exports.EXTENSION_PARAMS = [
     'packageName',
     'packageDescription',
@@ -157,7 +168,7 @@ function paramNamesToDef(name) {
             return {
                 name,
                 uses: ['licenseType'],
-                compute: async (_paths, licenseType) => licenseType && licenseType !== 'proprietary' ? require(`spdx-license-list/licenses/${licenseType}`).licenseText : '',
+                compute: async (_paths, licenseType) => licenseTextFor(licenseType),
             };
         case 'extensionId':
             return {
@@ -609,11 +620,15 @@ function moduleNameToDef(name) {
                         'autoload-dev.psr-4.${params.packageNamespace}\\Tests\\',
                         'scripts.test',
                         'scripts.test:unit',
+                        'scripts.test:unit:filter',
                         'scripts.test:integration',
+                        'scripts.test:integration:filter',
                         'scripts.test:setup',
                         'scripts-descriptions.test',
                         'scripts-descriptions.test:unit',
+                        'scripts-descriptions.test:unit:filter',
                         'scripts-descriptions.test:integration',
+                        'scripts-descriptions.test:integration:filter',
                         'scripts-descriptions.test:setup',
                         'require-dev.flarum/testing',
                     ],

package/lib/steps/monorepo/split.d.ts

@@ -8,7 +8,8 @@ export declare class MonorepoSplit implements Step<FlarumProviders> {
     composable: boolean;
     exposes: never[];
     force?: boolean;
-    constructor(force: boolean);
+    noInteraction?: boolean;
+    constructor(force: boolean, noInteraction?: boolean);
     run(fs: Store, paths: Paths, io: IO, _providers: FlarumProviders): Promise<Store>;
     getExposed(): Record<string, unknown>;
 }

package/lib/steps/monorepo/split.js

@@ -43,28 +43,43 @@ async function splitAndPush(cwd, splitExecPath, splitPath, remoteName, remoteBra
 }
 async function cleanupBranchAndRemote(cwd, name) {
     await (0, simple_git_1.default)(cwd).removeRemote(name);
-    const tmpBranch = `${name}-tmp`;
-    (0, child_process_1.execSync)(`git branch -D ${tmpBranch}`, { cwd });
+    try {
+        const tmpBranch = `${name}-tmp`;
+        (0, child_process_1.execSync)(`git branch -D ${tmpBranch}`, { cwd, stdio: 'ignore' });
+    }
+    catch (_a) {
+        // A forced split pushes the split sha straight to the remote, so it never
+        // creates the temp branch this deletes.
+    }
 }
 class MonorepoSplit {
-    constructor(force) {
+    constructor(force, noInteraction = false) {
         this.type = 'Split monorepo changes to the respective cloned repos.';
         this.composable = false;
         this.exposes = [];
         this.force = force;
+        this.noInteraction = noInteraction;
     }
     async run(fs, paths, io, _providers) {
         var _a, _b, _c, _d;
         const platform = process.platform;
+        const arch = process.arch;
         if (platform !== 'linux' && platform !== 'darwin') {
             io.error(`Your platform, "${platform}", is not supported. Split can only be run on linux and mac`, true);
             return fs;
         }
-        if (this.force && !(await io.getParam({ type: 'confirm', name: 'confirm', initial: false, message: 'Are you sure you want to force split?' }))) {
+        if (this.force &&
+            !this.noInteraction &&
+            !(await io.getParam({ type: 'confirm', name: 'confirm', initial: false, message: 'Are you sure you want to force split?' }))) {
             io.error('Decided not to force push', true);
             return fs;
         }
-        const splitExec = (0, path_1.resolve)(__dirname, `../../../bin/splitsh-lite-${platform}`);
+        // Select the appropriate binary based on platform and architecture
+        let splitExec;
+        splitExec =
+            platform === 'darwin' && arch === 'arm64'
+                ? (0, path_1.resolve)(__dirname, `../../../bin/splitsh-lite-darwin-arm64`)
+                : (0, path_1.resolve)(__dirname, `../../../bin/splitsh-lite-${platform}`);
         const target = (_a = paths.requestedDir()) !== null && _a !== void 0 ? _a : paths.package();
         await (0, simple_git_1.default)(target).pull();
         const conf = (0, monorepo_1.getMonorepoConf)(fs, paths);

package/lib/steps/stubs/backend/advanced-api-resource.js

@@ -49,7 +49,7 @@ class GenerateAdvancedApiResourceStub extends php_base_1.BasePhpStubStep {
                     type: 'multiselect',
                     message: 'Endpoints',
                     choices: [
-                        { title: 'index', value: 'index', selected: true },
+                        { title: 'index', value: 'list', selected: true },
                         { title: 'show', value: 'show', selected: true },
                         { title: 'create', value: 'create', selected: true },
                         { title: 'update', value: 'update', selected: true },

package/lib/steps/stubs/backend/model-factory.d.ts

@@ -0,0 +1,24 @@
+import { Validator } from '../../../utils/validation';
+import { BasePhpStubStep } from '../php-base';
+/**
+ * The factory a model's tests fill it from. It sits next to the model, named
+ * after it, which is where Flarum looks for a model's factory.
+ */
+export declare class GenerateModelFactoryStub extends BasePhpStubStep {
+    type: string;
+    protected schema: {
+        recommendedSubdir: string;
+        sourceFile: string;
+        params: ({
+            name: string;
+            type: string;
+            message: string;
+            validate: typeof Validator.className;
+        } | {
+            name: string;
+            type: string;
+            message: string;
+            validate?: undefined;
+        })[];
+    };
+}

package/lib/steps/stubs/backend/model-factory.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GenerateModelFactoryStub = void 0;
+const validation_1 = require("../../../utils/validation");
+const php_base_1 = require("../php-base");
+/**
+ * The factory a model's tests fill it from. It sits next to the model, named
+ * after it, which is where Flarum looks for a model's factory.
+ */
+class GenerateModelFactoryStub extends php_base_1.BasePhpStubStep {
+    constructor() {
+        super(...arguments);
+        this.type = 'Generate Model Factory Class';
+        this.schema = {
+            recommendedSubdir: '',
+            sourceFile: 'backend/model-factory.php',
+            params: [
+                {
+                    name: 'className',
+                    type: 'text',
+                    message: 'Factory class name',
+                    validate: validation_1.Validator.className,
+                },
+                {
+                    name: 'classNamespace',
+                    type: 'text',
+                    message: 'Class Namespace',
+                },
+            ],
+        };
+    }
+}
+exports.GenerateModelFactoryStub = GenerateModelFactoryStub;

package/lib/steps/upgrade/twopointoh/backend/email-views.js

@@ -3,6 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const ejs_1 = tslib_1.__importDefault(require("ejs"));
 const base_1 = require("../base");
+/** Where a view lives: `acme-thing::emails.launched` is in `.../emails/launched.blade.php`. */
+const viewFile = (view) => '/' + view.split('::').pop().replace(/\./g, '/') + '.blade.php';
 class EmailViews extends base_1.BaseUpgradeStep {
     constructor() {
         super(...arguments);
@@ -28,38 +30,28 @@ class EmailViews extends base_1.BaseUpgradeStep {
                 };
             },
             async (file, code) => {
-                if (Object.keys(this.collected).length === 0)
-                    return null;
-                const fileName = file.split('/').pop();
                 const newFiles = [];
-                Object.keys(this.collected).forEach((classFile) => {
-                    if (!this.collected[classFile]) {
-                        return;
-                    }
-                    if (!this.collected[classFile].html && !this.collected[classFile].text) {
-                        return;
+                for (const views of Object.values(this.collected)) {
+                    // A notification that has both views already has nothing to convert,
+                    // such as one already upgraded to 2.0.
+                    if (!views || Boolean(views.html) === Boolean(views.text))
+                        continue;
+                    const view = views.html || views.text;
+                    // The view's own file, by its full path: on 2.x the html and plain
+                    // views of a notification have the same file name.
+                    if (!file.endsWith(viewFile(view)))
+                        continue;
+                    const viewFileName = view.split('::')[1].split('.').pop();
+                    for (const viewType of ['text', 'html']) {
+                        const templateContent = this.fsEditor.read(__dirname + this.templates[viewType]);
+                        const viewTypePath = viewType === 'text' ? 'plain' : 'html';
+                        newFiles.push({
+                            path: file.split('/views/')[0] + '/views/email/' + viewTypePath + '/' + viewFileName + '.blade.php',
+                            code: ejs_1.default.render(templateContent, { content: code.trimEnd() }),
+                        });
                     }
-                    // if there is a text view but no html view, use the same content for both.
-                    // same for html view but no text view.
-                    ['text', 'html'].forEach((view) => {
-                        const viewType = view;
-                        const viewPath = this.collected[classFile][viewType] || this.collected[classFile][viewType === 'html' ? 'text' : 'html'];
-                        const viewFileName = viewPath.split('::')[1].split('.').pop();
-                        if (fileName === `${viewFileName}.blade.php`) {
-                            const templateContent = this.fsEditor.read(__dirname + this.templates[viewType]);
-                            const viewTypePath = viewType === 'text' ? 'plain' : 'html';
-                            newFiles.push({
-                                path: file.split('/views/')[0] + '/views/email/' + viewTypePath + '/' + viewFileName + '.blade.php',
-                                code: ejs_1.default.render(templateContent, { content: code.trimEnd() }),
-                            });
-                        }
-                    });
-                });
-                return {
-                    updated: code,
-                    delete: newFiles.length > 0,
-                    newFiles,
-                };
+                }
+                return newFiles.length > 0 ? { updated: code, delete: true, newFiles } : null;
             },
         ];
     }

package/lib/steps/upgrade/twopointoh/backend/extension-models.d.ts

@@ -0,0 +1,30 @@
+import { PhpProvider } from '../../../../providers/php-provider';
+export type ExtensionModel = {
+    file: string;
+    class: string;
+    table: string;
+    hasFactory: boolean;
+};
+export type Column = {
+    name: string;
+    type: string;
+    nullable: boolean;
+    autoIncrement: boolean;
+    references: string | null;
+    default?: {
+        value: unknown;
+    };
+    values?: string[];
+};
+/**
+ * The extension's models, each with its table, and the models that have, or
+ * are given, a factory, by table: core's and the extension's.
+ */
+export declare function extensionModels(root: string, php: PhpProvider): {
+    models: ExtensionModel[];
+    byTable: Record<string, string>;
+};
+/**
+ * The tables the extension's migrations leave, by name.
+ */
+export declare function migrationTables(root: string, php: PhpProvider): Record<string, Column[]>;

package/lib/steps/upgrade/twopointoh/backend/extension-models.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.migrationTables = exports.extensionModels = void 0;
+const tslib_1 = require("tslib");
+const fs_1 = tslib_1.__importDefault(require("fs"));
+const path_1 = tslib_1.__importDefault(require("path"));
+const globby_1 = tslib_1.__importDefault(require("globby"));
+const model_name_1 = require("../../../../utils/model-name");
+const read = (root, pattern) => Object.fromEntries(globby_1.default.sync(pattern, { cwd: root }).map((file) => [file, fs_1.default.readFileSync(path_1.default.join(root, file), 'utf8')]));
+/**
+ * The extension's models, each with its table, and the models that have, or
+ * are given, a factory, by table: core's and the extension's.
+ */
+function extensionModels(root, php) {
+    const result = php.run('upgrade.2-0.models', { data: { files: read(root, 'src/**/*.php') } });
+    // A model without $table has the one Eloquent names after its class.
+    const models = result.models.map((model) => {
+        var _a;
+        return (Object.assign(Object.assign({}, model), { table: (_a = model.table) !== null && _a !== void 0 ? _a : (0, model_name_1.pluralSnakeCaseModel)(model.class.split('\\').pop()) }));
+    });
+    return {
+        models,
+        byTable: Object.assign(Object.assign({}, result.core), Object.fromEntries(models.map((model) => [model.table, model.class]))),
+    };
+}
+exports.extensionModels = extensionModels;
+/**
+ * The tables the extension's migrations leave, by name.
+ */
+function migrationTables(root, php) {
+    const migrations = Object.fromEntries(Object.entries(read(root, 'migrations/*.php')).map(([file, code]) => [path_1.default.basename(file), code]));
+    return php.run('upgrade.2-0.migrations-schema', { data: { migrations } }).tables;
+}
+exports.migrationTables = migrationTables;

package/lib/steps/upgrade/twopointoh/backend/json-api.d.ts

@@ -7,6 +7,12 @@ export default class JsonApi extends BaseUpgradeStep {
     before(file: string, code: string, _advanced: AdvancedContent): void;
     replacements(file: string): Replacement[];
     targets(): string[];
+    /**
+     * 2.0's user resource has avatarSrcset next to avatarUrl, and browsers
+     * prefer it, so code that only sets the URL still shows a user's uploaded
+     * avatar on most screens.
+     */
+    flagAvatarUrl(): Replacement;
     gitCommit(): GitCommit;
     pauseMessage(): string;
 }

package/lib/steps/upgrade/twopointoh/backend/json-api.js

@@ -41,6 +41,7 @@ class JsonApi extends base_1.BaseUpgradeStep {
             return [];
         let collected = null;
         return [
+            this.flagAvatarUrl(),
             async (file, code) => {
                 const output = this.php.run('upgrade.2-0.json-api', { file, code });
                 collected = output.collected;
@@ -85,6 +86,19 @@ class JsonApi extends base_1.BaseUpgradeStep {
     targets() {
         return ['src/**/*', 'extend.php'];
     }
+    /**
+     * 2.0's user resource has avatarSrcset next to avatarUrl, and browsers
+     * prefer it, so code that only sets the URL still shows a user's uploaded
+     * avatar on most screens.
+     */
+    flagAvatarUrl() {
+        return (file, code) => {
+            if (/["']avatarUrl["']/.test(code)) {
+                this.leaveTodo(file, "It sets avatarUrl. 2.0's API also has avatarSrcset, which browsers prefer over the URL: set it too, or a user's uploaded avatar still shows.");
+            }
+            return null;
+        };
+    }
     gitCommit() {
         return {
             message: 'chore(2.0): JSON:API changes',

package/lib/steps/upgrade/twopointoh/backend/misc.d.ts

@@ -4,5 +4,11 @@ export default class MiscBackendChanges extends BaseUpgradeStep {
     replacements(file: string): Replacement[];
     targets(): string[];
     gitCommit(): GitCommit;
+    /**
+     * Since Laravel 11, changing a column drops every attribute the change
+     * leaves out, so a migration's ->change() must repeat the whole column
+     * definition. Only the author knows the column's full definition.
+     */
+    flagColumnChanges(): Replacement;
     pauseMessage(): string;
 }

package/lib/steps/upgrade/twopointoh/backend/misc.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const base_1 = require("../base");
 const chalk_1 = tslib_1.__importDefault(require("chalk"));
+const MODIFYING_COLUMNS = 'https://laravel.com/docs/11.x/upgrade#modifying-columns';
 class MiscBackendChanges extends base_1.BaseUpgradeStep {
     constructor() {
         super(...arguments);
@@ -11,6 +12,9 @@ class MiscBackendChanges extends base_1.BaseUpgradeStep {
     replacements(file) {
         if (!file.endsWith('.php'))
             return [];
+        if (file.startsWith('migrations/')) {
+            return [this.flagColumnChanges()];
+        }
         return [
             (file, code) => ({
                 updated: this.php.run('upgrade.2-0.misc', { file, code }).code,
@@ -18,7 +22,7 @@ class MiscBackendChanges extends base_1.BaseUpgradeStep {
         ];
     }
     targets() {
-        return ['extend.php', 'src/**/*'];
+        return ['extend.php', 'src/**/*', 'migrations/**/*.php'];
     }
     gitCommit() {
         return {
@@ -26,17 +30,25 @@ class MiscBackendChanges extends base_1.BaseUpgradeStep {
             description: 'Miscellaneous backend changes',
         };
     }
+    /**
+     * Since Laravel 11, changing a column drops every attribute the change
+     * leaves out, so a migration's ->change() must repeat the whole column
+     * definition. Only the author knows the column's full definition.
+     */
+    flagColumnChanges() {
+        return (file, code) => {
+            if (/->\s*change\s*\(\s*\)/.test(code)) {
+                this.leaveTodo(file, `It changes a column with ->change(), which now drops every attribute the change leaves out: repeat the column's whole definition. ${MODIFYING_COLUMNS}`);
+            }
+            return null;
+        };
+    }
     pauseMessage() {
         const link = 'https://docs.flarum.org/2.x/extend/update-2_0#miscellaneous-1';
         const readMore = chalk_1.default.dim(`Read more: ${link}`);
-        const requiresManualChangeLink = 'https://laravel.com/docs/11.x/upgrade#modifying-columns';
         return `Various breaking backend changes have been made in 2.0. The tool has attempted to update your code accordingly.
                      Please review the changes and ensure everything is correct.
-                     ${readMore}
-
-                     Additionally, check every reference to a column definition change in your migrations, and make sure
-                     they are using the entire column definition. For more details, see:
-                     ${chalk_1.default.underline(requiresManualChangeLink)}`;
+                     ${readMore}`;
     }
 }
 exports.default = MiscBackendChanges;