@flarum/cli 3.0.11 → 3.0.13

package/lib/steps/upgrade/twopointoh/step-failures.d.ts

@@ -0,0 +1,32 @@
+export type Failure = {
+    file: string;
+    reason: string;
+};
+/**
+ * The files a single upgrade step could not transform.
+ *
+ * A step runs over every matching file in an extension, and any one of them
+ * can defeat it — a parser that doesn't recognise some syntax, a transformer
+ * meeting a shape it wasn't written for. Collecting those instead of throwing
+ * at the first means the author is told about all of them at once, and fixes
+ * them in one pass rather than rediscovering them one re-run at a time.
+ */
+export declare class StepFailures {
+    private failures;
+    record(file: string, error: unknown): void;
+    any(): boolean;
+    count(): number;
+    /**
+     * The failures as data, for a program driving the upgrade.
+     */
+    list(): Failure[];
+    /**
+     * The failures, formatted for the author: which file, and why.
+     */
+    report(): string;
+    /**
+     * The message alone. A stack trace is about our internals, not about the
+     * code being upgraded, so it isn't what the author needs to see.
+     */
+    private static reasonFor;
+}

package/lib/steps/upgrade/twopointoh/step-failures.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StepFailures = void 0;
+const tslib_1 = require("tslib");
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
+/**
+ * The files a single upgrade step could not transform.
+ *
+ * A step runs over every matching file in an extension, and any one of them
+ * can defeat it — a parser that doesn't recognise some syntax, a transformer
+ * meeting a shape it wasn't written for. Collecting those instead of throwing
+ * at the first means the author is told about all of them at once, and fixes
+ * them in one pass rather than rediscovering them one re-run at a time.
+ */
+class StepFailures {
+    constructor() {
+        this.failures = [];
+    }
+    record(file, error) {
+        this.failures.push({ file, reason: StepFailures.reasonFor(error) });
+    }
+    any() {
+        return this.failures.length > 0;
+    }
+    count() {
+        return this.failures.length;
+    }
+    /**
+     * The failures as data, for a program driving the upgrade.
+     */
+    list() {
+        return this.failures.map((failure) => (Object.assign({}, failure)));
+    }
+    /**
+     * The failures, formatted for the author: which file, and why.
+     */
+    report() {
+        return this.failures.map(({ file, reason }) => `     ${chalk_1.default.bold(file)}\n       ${reason}`).join('\n\n');
+    }
+    /**
+     * The message alone. A stack trace is about our internals, not about the
+     * code being upgraded, so it isn't what the author needs to see.
+     */
+    static reasonFor(error) {
+        if (error instanceof Error) {
+            return error.message;
+        }
+        if (typeof error === 'string') {
+            return error;
+        }
+        return JSON.stringify(error);
+    }
+}
+exports.StepFailures = StepFailures;

package/lib/steps/upgrade/twopointoh/todos.d.ts

@@ -0,0 +1,22 @@
+/**
+ * The marker the upgrade leaves on code it could not change itself.
+ */
+export declare const TODO_MARKER = "@TODO";
+export type Todo = {
+    file: string;
+    /** Null for work a step leaves without a @TODO comment in the file to show for it. */
+    line: number | null;
+    text: string;
+};
+/**
+ * The TODOs a diff adds, from `git show --unified=0`.
+ *
+ * A line that is only reformatted or moved shows up as removed and added
+ * again. When the same text was removed from the file, the TODO isn't new, so
+ * an extension's own TODOs aren't reported as work the upgrade left.
+ */
+export declare function todosInDiff(diff: string): Todo[];
+/**
+ * The TODOs a commit added.
+ */
+export declare function todosAddedBy(dir: string, commit: string): Promise<Todo[]>;

package/lib/steps/upgrade/twopointoh/todos.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.todosAddedBy = exports.todosInDiff = exports.TODO_MARKER = void 0;
+const tslib_1 = require("tslib");
+const simple_git_1 = tslib_1.__importDefault(require("simple-git"));
+/**
+ * The marker the upgrade leaves on code it could not change itself.
+ */
+exports.TODO_MARKER = '@TODO';
+/**
+ * The TODOs a diff adds, from `git show --unified=0`.
+ *
+ * A line that is only reformatted or moved shows up as removed and added
+ * again. When the same text was removed from the file, the TODO isn't new, so
+ * an extension's own TODOs aren't reported as work the upgrade left.
+ */
+function todosInDiff(diff) {
+    var _a;
+    const added = [];
+    const removed = new Map();
+    let file = null;
+    let line = 0;
+    for (const row of diff.split('\n')) {
+        if (row.startsWith('+++ ')) {
+            file = row === '+++ /dev/null' ? null : row.slice(4).replace(/^b\//, '');
+            continue;
+        }
+        if (row.startsWith('--- '))
+            continue;
+        const hunk = row.match(/^@@ -\d+(?:,\d+)? \+(\d+)(?:,\d+)? @@/);
+        if (hunk) {
+            line = Number(hunk[1]);
+            continue;
+        }
+        if (file === null)
+            continue;
+        if (row.startsWith('+')) {
+            if (row.includes(exports.TODO_MARKER)) {
+                added.push({ file, line, text: row.slice(1).trim() });
+            }
+            line++;
+        }
+        else if (row.startsWith('-')) {
+            removed.set(file, [...((_a = removed.get(file)) !== null && _a !== void 0 ? _a : []), row.slice(1).trim()]);
+        }
+    }
+    return added.filter((todo) => { var _a; return !((_a = removed.get(todo.file)) === null || _a === void 0 ? void 0 : _a.includes(todo.text)); });
+}
+exports.todosInDiff = todosInDiff;
+/**
+ * The TODOs a commit added.
+ */
+async function todosAddedBy(dir, commit) {
+    const diff = await (0, simple_git_1.default)(dir).show([commit, '--format=', '--unified=0', '--no-color', '--no-ext-diff', '--no-renames']);
+    return todosInDiff(diff);
+}
+exports.todosAddedBy = todosAddedBy;

package/lib/steps/upgrade/twopointoh/typescript-4-9.d.ts

@@ -0,0 +1,12 @@
+/**
+ * The compiler options TypeScript 4.9 knows, which Flarum 2.0 builds with, and
+ * the values it accepts for those that take one of a set. A tsconfig.json has
+ * to spell an option exactly so; its values may be in any case, so they are
+ * listed lowercase.
+ *
+ * Generated from typescript@4.9.5: `ts.optionDeclarations`, each name mapped
+ * to true, or to the keys of its type when that is a Map; the libs are the
+ * keys of the `lib` option's element type.
+ */
+export declare const compilerOptions: Record<string, true | string[]>;
+export declare const libs: string[];

package/lib/steps/upgrade/twopointoh/typescript-4-9.js

@@ -0,0 +1,200 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.libs = exports.compilerOptions = void 0;
+/**
+ * The compiler options TypeScript 4.9 knows, which Flarum 2.0 builds with, and
+ * the values it accepts for those that take one of a set. A tsconfig.json has
+ * to spell an option exactly so; its values may be in any case, so they are
+ * listed lowercase.
+ *
+ * Generated from typescript@4.9.5: `ts.optionDeclarations`, each name mapped
+ * to true, or to the keys of its type when that is a Map; the libs are the
+ * keys of the `lib` option's element type.
+ */
+exports.compilerOptions = {
+    all: true,
+    allowJs: true,
+    allowSyntheticDefaultImports: true,
+    allowUmdGlobalAccess: true,
+    allowUnreachableCode: true,
+    allowUnusedLabels: true,
+    alwaysStrict: true,
+    assumeChangesOnlyAffectDirectDependencies: true,
+    baseUrl: true,
+    build: true,
+    charset: true,
+    checkJs: true,
+    composite: true,
+    declaration: true,
+    declarationDir: true,
+    declarationMap: true,
+    diagnostics: true,
+    disableReferencedProjectLoad: true,
+    disableSizeLimit: true,
+    disableSolutionSearching: true,
+    disableSourceOfProjectReferenceRedirect: true,
+    downlevelIteration: true,
+    emitBOM: true,
+    emitDeclarationOnly: true,
+    emitDecoratorMetadata: true,
+    esModuleInterop: true,
+    exactOptionalPropertyTypes: true,
+    experimentalDecorators: true,
+    explainFiles: true,
+    extendedDiagnostics: true,
+    forceConsistentCasingInFileNames: true,
+    generateCpuProfile: true,
+    generateTrace: true,
+    help: true,
+    ignoreDeprecations: true,
+    importHelpers: true,
+    importsNotUsedAsValues: ['error', 'preserve', 'remove'],
+    incremental: true,
+    init: true,
+    inlineSourceMap: true,
+    inlineSources: true,
+    isolatedModules: true,
+    jsx: ['preserve', 'react', 'react-jsx', 'react-jsxdev', 'react-native'],
+    jsxFactory: true,
+    jsxFragmentFactory: true,
+    jsxImportSource: true,
+    keyofStringsOnly: true,
+    lib: true,
+    listEmittedFiles: true,
+    listFiles: true,
+    listFilesOnly: true,
+    locale: true,
+    mapRoot: true,
+    maxNodeModuleJsDepth: true,
+    module: ['amd', 'commonjs', 'es2015', 'es2020', 'es2022', 'es6', 'esnext', 'node16', 'nodenext', 'none', 'system', 'umd'],
+    moduleDetection: ['auto', 'force', 'legacy'],
+    moduleResolution: ['classic', 'node', 'node16', 'nodenext'],
+    moduleSuffixes: true,
+    newLine: ['crlf', 'lf'],
+    noEmit: true,
+    noEmitHelpers: true,
+    noEmitOnError: true,
+    noErrorTruncation: true,
+    noFallthroughCasesInSwitch: true,
+    noImplicitAny: true,
+    noImplicitOverride: true,
+    noImplicitReturns: true,
+    noImplicitThis: true,
+    noImplicitUseStrict: true,
+    noLib: true,
+    noPropertyAccessFromIndexSignature: true,
+    noResolve: true,
+    noStrictGenericChecks: true,
+    noUncheckedIndexedAccess: true,
+    noUnusedLocals: true,
+    noUnusedParameters: true,
+    out: true,
+    outDir: true,
+    outFile: true,
+    paths: true,
+    plugins: true,
+    preserveConstEnums: true,
+    preserveSymlinks: true,
+    preserveValueImports: true,
+    preserveWatchOutput: true,
+    pretty: true,
+    project: true,
+    reactNamespace: true,
+    removeComments: true,
+    resolveJsonModule: true,
+    rootDir: true,
+    rootDirs: true,
+    showConfig: true,
+    skipDefaultLibCheck: true,
+    skipLibCheck: true,
+    sourceMap: true,
+    sourceRoot: true,
+    strict: true,
+    strictBindCallApply: true,
+    strictFunctionTypes: true,
+    strictNullChecks: true,
+    strictPropertyInitialization: true,
+    stripInternal: true,
+    suppressExcessPropertyErrors: true,
+    suppressImplicitAnyIndexErrors: true,
+    target: ['es2015', 'es2016', 'es2017', 'es2018', 'es2019', 'es2020', 'es2021', 'es2022', 'es3', 'es5', 'es6', 'esnext'],
+    traceResolution: true,
+    tsBuildInfoFile: true,
+    typeRoots: true,
+    types: true,
+    useDefineForClassFields: true,
+    useUnknownInCatchVariables: true,
+    version: true,
+    watch: true,
+};
+exports.libs = [
+    'dom',
+    'dom.iterable',
+    'es2015',
+    'es2015.collection',
+    'es2015.core',
+    'es2015.generator',
+    'es2015.iterable',
+    'es2015.promise',
+    'es2015.proxy',
+    'es2015.reflect',
+    'es2015.symbol',
+    'es2015.symbol.wellknown',
+    'es2016',
+    'es2016.array.include',
+    'es2017',
+    'es2017.intl',
+    'es2017.object',
+    'es2017.sharedmemory',
+    'es2017.string',
+    'es2017.typedarrays',
+    'es2018',
+    'es2018.asyncgenerator',
+    'es2018.asynciterable',
+    'es2018.intl',
+    'es2018.promise',
+    'es2018.regexp',
+    'es2019',
+    'es2019.array',
+    'es2019.intl',
+    'es2019.object',
+    'es2019.string',
+    'es2019.symbol',
+    'es2020',
+    'es2020.bigint',
+    'es2020.date',
+    'es2020.intl',
+    'es2020.number',
+    'es2020.promise',
+    'es2020.sharedmemory',
+    'es2020.string',
+    'es2020.symbol.wellknown',
+    'es2021',
+    'es2021.intl',
+    'es2021.promise',
+    'es2021.string',
+    'es2021.weakref',
+    'es2022',
+    'es2022.array',
+    'es2022.error',
+    'es2022.intl',
+    'es2022.object',
+    'es2022.sharedmemory',
+    'es2022.string',
+    'es5',
+    'es6',
+    'es7',
+    'esnext',
+    'esnext.array',
+    'esnext.asynciterable',
+    'esnext.bigint',
+    'esnext.intl',
+    'esnext.promise',
+    'esnext.string',
+    'esnext.symbol',
+    'esnext.weakref',
+    'scripthost',
+    'webworker',
+    'webworker.importscripts',
+    'webworker.iterable',
+];

package/lib/utils/ast.js

@@ -9,22 +9,17 @@ const prettierrc_json_1 = tslib_1.__importDefault(require("@flarum/prettier-conf
 // import { parse } from '@babel/parser';
 // import generate from '@babel/generator';
 const recast = tslib_1.__importStar(require("recast"));
+const babelTs = tslib_1.__importStar(require("./babel-ts"));
 function parseCode(code) {
-    try {
-        return recast.parse(code, {
-            parser: require('recast/parsers/babel-ts'),
-        });
-    }
-    catch (error) {
-        console.log(code);
-        throw error;
-    }
+    return recast.parse(code, {
+        parser: babelTs,
+    });
 }
 exports.parseCode = parseCode;
 async function generateCode(ast, extenders = false) {
     // @ts-ignore
     const generatedCode = recast.print(ast, {
-        parser: require('recast/parsers/babel-ts'),
+        parser: babelTs,
     }).code;
     // Format the code
     return formatCode(generatedCode, extenders);

package/lib/utils/babel-ts.d.ts

@@ -0,0 +1,9 @@
+import { ParseResult } from '@babel/parser';
+import * as t from '@babel/types';
+/**
+ * Recast's babel-ts parser, which also accepts an export of a name it can't see
+ * declared, as Prettier does. Babel reports one for every `export { name }` in
+ * an ambient `declare module` block, which is valid TypeScript. The upgrade
+ * rewrites code rather than checking it: the extension's own build does that.
+ */
+export declare function parse(source: string): ParseResult<t.File>;

package/lib/utils/babel-ts.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parse = void 0;
+const tslib_1 = require("tslib");
+const parser_1 = require("@babel/parser");
+const _babel_options_1 = tslib_1.__importDefault(require("recast/parsers/_babel_options"));
+/**
+ * Recast's babel-ts parser, which also accepts an export of a name it can't see
+ * declared, as Prettier does. Babel reports one for every `export { name }` in
+ * an ambient `declare module` block, which is valid TypeScript. The upgrade
+ * rewrites code rather than checking it: the extension's own build does that.
+ */
+function parse(source) {
+    const options = (0, _babel_options_1.default)();
+    options.plugins.push('jsx', 'typescript');
+    return (0, parser_1.parse)(source, Object.assign(Object.assign({}, options), { allowUndeclaredExports: true }));
+}
+exports.parse = parse;

package/lib/utils/composer.d.ts

@@ -63,3 +63,8 @@ export type ComposerJsonSchema = {
     };
 };
 export declare function getComposerJson(fs: Store, paths: Paths): ComposerJsonSchema;
+/**
+ * An extension's ID, from its package name, as core makes it: `vendor-package`,
+ * without a `flarum-ext-` or `flarum-` in the package's part.
+ */
+export declare function extensionId(packageName: string): string;

package/lib/utils/composer.js

@@ -1,8 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getComposerJson = void 0;
+exports.extensionId = 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;
+/**
+ * An extension's ID, from its package name, as core makes it: `vendor-package`,
+ * without a `flarum-ext-` or `flarum-` in the package's part.
+ */
+function extensionId(packageName) {
+    const [vendor, pkg] = packageName.includes('/') ? packageName.split('/', 2) : [packageName, packageName];
+    return `${vendor}-${pkg.replace(/flarum-ext-/g, '').replace(/flarum-/g, '')}`;
+}
+exports.extensionId = extensionId;

package/lib/utils/terminal.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Whether output goes to a terminal, rather than to a file or another program.
+ */
+export declare function isTerminal(): boolean;
+/**
+ * Moves the cursor up a line, so the next one overwrites it. Only in a
+ * terminal: anywhere else the escape code is noise.
+ */
+export declare function overwrite(): string;
+/**
+ * The text without colours or cursor movement.
+ */
+export declare function stripAnsi(text: string): string;

package/lib/utils/terminal.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stripAnsi = exports.overwrite = exports.isTerminal = void 0;
+/**
+ * Whether output goes to a terminal, rather than to a file or another program.
+ */
+function isTerminal() {
+    return Boolean(process.stdout.isTTY);
+}
+exports.isTerminal = isTerminal;
+/**
+ * Moves the cursor up a line, so the next one overwrites it. Only in a
+ * terminal: anywhere else the escape code is noise.
+ */
+function overwrite() {
+    return isTerminal() ? '\u001B[A' : '';
+}
+exports.overwrite = overwrite;
+/**
+ * The text without colours or cursor movement.
+ */
+function stripAnsi(text) {
+    // eslint-disable-next-line no-control-regex
+    return text.replace(/\u001B\[[\d;]*[A-Za-z]/g, '');
+}
+exports.stripAnsi = stripAnsi;