@openedx/frontend-base 1.0.0-alpha.0

package/tools/dist/babel/babel.config.js

@@ -0,0 +1,28 @@
+"use strict";
+/**
+ * This Babel configuration file is for Jest.  The Webpack build does not use Babel.
+ */
+module.exports = {
+    presets: [
+        [
+            require.resolve('@babel/preset-env'), {
+                targets: { node: 'current' },
+            },
+        ],
+        [
+            require.resolve('@babel/preset-react'), {
+                runtime: 'automatic',
+            },
+        ],
+        require.resolve('@babel/preset-typescript'),
+    ],
+    env: {
+        i18n: {
+            plugins: [
+                [
+                    'formatjs',
+                ],
+            ],
+        },
+    },
+};

package/tools/dist/cli/commands/pack.js

@@ -0,0 +1,14 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = pack;
+const child_process_1 = require("child_process");
+const path_1 = __importDefault(require("path"));
+function pack() {
+    const destination = process.argv[2];
+    (0, child_process_1.execSync)('npm run release', { stdio: 'inherit' });
+    const { filename } = JSON.parse((0, child_process_1.execSync)('npm pack --json').toString())[0];
+    (0, child_process_1.execSync)(`npm --prefix ../${destination} install ${path_1.default.resolve(process.cwd(), filename)}`, { stdio: 'inherit' });
+}

package/tools/dist/cli/commands/release.js

@@ -0,0 +1,28 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = release;
+const chalk_1 = __importDefault(require("chalk"));
+const child_process_1 = require("child_process");
+const fs_1 = require("fs");
+const path_1 = __importDefault(require("path"));
+function release() {
+    const tsconfigPath = path_1.default.resolve(process.cwd(), './tsconfig.build.json');
+    if (!(0, fs_1.existsSync)(tsconfigPath)) {
+        console.error(chalk_1.default.red('openedx release: the library must include a tsconfig.build.json. Aborting.'));
+        process.exit(1);
+    }
+    // Clean up our dist folder.
+    (0, fs_1.rmSync)(path_1.default.resolve(process.cwd(), 'dist'), { recursive: true, force: true });
+    (0, child_process_1.execSync)(`tsc --project ${path_1.default.resolve(process.cwd(), './tsconfig.build.json')}`, { stdio: 'inherit' });
+    // Copy all non JS/TS files from src into dist.  This is so imports of our assets still work.
+    (0, child_process_1.execSync)(`rsync -aR src/**/* --exclude='*.tsx' --exclude='*.ts' --exclude='*.js' --exclude='*.jsx' dist/`);
+    // The above rsync command will put the files in dist/src - move them up a folder into dist,
+    // merging them into the compiled code there, and then delete dist/src.
+    if ((0, fs_1.existsSync)(path_1.default.resolve(process.cwd(), 'dist/src'))) {
+        (0, child_process_1.execSync)('cp -R dist/src/* dist');
+        (0, child_process_1.execSync)('rm -rf dist/src');
+    }
+}

package/tools/dist/cli/commands/serve.js

@@ -0,0 +1,44 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const chalk_1 = __importDefault(require("chalk"));
+const compression_1 = __importDefault(require("compression"));
+const express_1 = __importDefault(require("express"));
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+function isDirectoryEmpty(directoryPath) {
+    try {
+        const files = fs_1.default.readdirSync(directoryPath);
+        return files.length === 0;
+    }
+    catch (error) {
+        if (error.code === 'ENOENT') {
+            // Directory does not exist, so treat it as empty.
+            return true;
+        }
+        throw error; // Throw the error for other cases
+    }
+}
+const buildPath = path_1.default.join(process.cwd(), 'dist');
+const buildPathIndex = path_1.default.join(buildPath, 'index.html');
+if (isDirectoryEmpty(buildPath)) {
+    const formattedBuildCmd = chalk_1.default.bold.redBright('``npm run build``');
+    console.log(chalk_1.default.bold.red(`ERROR: No build found. Please run ${formattedBuildCmd} first.`));
+}
+else {
+    const app = (0, express_1.default)();
+    app.use((0, compression_1.default)());
+    app.use(express_1.default.static(buildPath));
+    app.use('*', (req, res) => {
+        res.sendFile(buildPathIndex);
+    });
+    // Fallback to standard example port if no PORT config is set.
+    const PORT = process.env.PORT ?? 8080;
+    app.listen(PORT, () => {
+        const formattedServedFile = chalk_1.default.bold.cyanBright(buildPathIndex);
+        const formattedPort = chalk_1.default.bold.cyanBright(PORT);
+        console.log(chalk_1.default.greenBright(`Serving ${formattedServedFile} on port ${formattedPort}...`));
+    });
+}

package/tools/dist/cli/intl-imports.js

@@ -0,0 +1,233 @@
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.main = main;
+const scriptHelpDocument = `
+NAME
+  intl-imports.js — Script to generate the src/i18n/index.js file that exports messages from all the languages for Micro-frontends.
+
+SYNOPSIS
+  intl-imports.js [DIRECTORY ...]
+
+DESCRIPTION
+  This script is intended to run after 'atlas' has pulled the files.
+
+  This expects to run inside a Micro-frontend root directory with the following structure:
+
+    frontend-app-learning $ tree src/i18n/
+    src/i18n/
+    ├── index.js
+    └── messages
+        ├── frontend-app-example
+        │   ├── ar.json
+        │   ├── es_419.json
+        │   └── zh_CN.json
+        ├── frontend-component-footer
+        │   ├── ar.json
+        │   ├── es_419.json
+        │   └── zh_CN.json
+        └── frontend-component-header (empty directory)
+
+
+
+  With the structure above it's expected to run with the following command in Makefile:
+
+
+    $ node_modules/.bin/intl-imports.js frontend-component-footer frontend-component-header frontend-app-example
+
+
+  It will generate two type of files:
+
+   - Main src/i18n/index.js which overrides the Micro-frontend provided with a sample output of:
+
+      """
+      import messagesFromFrontendComponentFooter from './messages/frontend-component-footer';
+      // Skipped import due to missing './messages/frontend-component-footer/index.js' likely due to empty translations.
+      import messagesFromFrontendAppExample from './messages/frontend-app-example';
+
+      export default [
+        messagesFromFrontendComponentFooter,
+        messagesFromFrontendAppExample,
+      ];
+      """
+
+   - Each sub-directory has src/i18n/messages/frontend-component-header/index.js which is imported by the main file.:
+
+      """
+      import messagesOfArLanguage from './ar.json';
+      import messagesOfDeLanguage from './de.json';
+      import messagesOfEs419Language from './es_419.json';
+      export default {
+        'ar': messagesOfArLanguage,
+        'de': messagesOfDeLanguage,
+        'es-419': messagesOfEs419Language,
+      };
+     """
+`;
+const fs_1 = __importDefault(require("fs"));
+const lodash_camelcase_1 = __importDefault(require("lodash.camelcase"));
+const path_1 = __importDefault(require("path"));
+const loggingPrefix = path_1.default.basename(`${__filename}`); // the name of this JS file
+// Header note for generated src/i18n/index.js file
+const filesCodeGeneratorNoticeHeader = `// This file is generated by the openedx/frontend-base's "intl-import.js" script.
+//
+// Refer to the i18n documents in https://docs.openedx.org/en/latest/developers/references/i18n.html to update
+// the file and use the Micro-frontend i18n pattern in new repositories.
+//
+`;
+/**
+ * Create frontend-app-example/index.js file with proper imports.
+ *
+ * @param directory - a directory name containing .json files from Transifex e.g. "frontend-app-example".
+ * @param log - Mockable process.stdout.write
+ * @param writeFileSync - Mockable fs.writeFileSync
+ * @param i18nDir - Path to `src/i18n` directory
+ *
+ * @return object - An object containing directory name and whether its "index.js" file was successfully written.
+ */
+function generateSubdirectoryMessageFile({ directory, log, writeFileSync, i18nDir, }) {
+    const importLines = [];
+    const messagesLines = [];
+    const counter = { nonEmptyLanguages: 0 };
+    const messagesDir = `${i18nDir}/messages`; // The directory of Micro-frontend i18n messages
+    try {
+        const files = fs_1.default.readdirSync(`${messagesDir}/${directory}`, { withFileTypes: true });
+        files.sort(); // Sorting ensures a consistent generated `index.js` order of imports cross-platforms.
+        const jsonFiles = files.filter(file => file.isFile() && file.name.endsWith('.json'));
+        if (!jsonFiles.length) {
+            log(`${loggingPrefix}: Not creating '${directory}/index.js' because no .json translation files were found.\n`);
+            return {
+                directory,
+                isWritten: false,
+            };
+        }
+        jsonFiles.forEach((file) => {
+            const filename = file.name;
+            // Gets `fr_CA` from `fr_CA.json`
+            const languageCode = filename.replace(/\.json$/, '');
+            // React-friendly language code fr_CA --> fr-ca
+            const reactIntlLanguageCode = languageCode.toLowerCase().replace(/_/g, '-');
+            // camelCase variable name
+            const messagesCamelCaseVar = (0, lodash_camelcase_1.default)(`messages_Of_${languageCode}_Language`);
+            const filePath = `${messagesDir}/${directory}/${filename}`;
+            try {
+                const entries = JSON.parse(fs_1.default.readFileSync(filePath, { encoding: 'utf8' }));
+                if (!Object.keys(entries).length) {
+                    importLines.push(`// Note: Skipped empty '${filename}' messages file.`);
+                    return; // Skip the language
+                }
+            }
+            catch (e) {
+                importLines.push(`// Error: unable to parse '${filename}' messages file.`);
+                log(`${loggingPrefix}: NOTICE: Skipping '${directory}/${filename}' due to error: ${e}.\n`);
+                return; // Skip the language
+            }
+            counter.nonEmptyLanguages += 1;
+            importLines.push(`import ${messagesCamelCaseVar} from './${filename}';`);
+            messagesLines.splice(1, 0, `  '${reactIntlLanguageCode}': ${messagesCamelCaseVar},`);
+        });
+        if (counter.nonEmptyLanguages) {
+            // See the help message above for sample output.
+            const messagesFileContent = [
+                filesCodeGeneratorNoticeHeader,
+                importLines.join('\n'),
+                '\nexport default {',
+                messagesLines.join('\n'),
+                '};\n',
+            ].join('\n');
+            writeFileSync(`${messagesDir}/${directory}/index.js`, messagesFileContent);
+            return {
+                directory,
+                isWritten: true,
+            };
+        }
+        log(`${loggingPrefix}: Skipping '${directory}' because no languages were found.\n`);
+    }
+    catch (e) {
+        log(`${loggingPrefix}: NOTICE: Skipping '${directory}' due to error: ${e}.\n`);
+    }
+    return {
+        directory,
+        isWritten: false,
+    };
+}
+/**
+ * Create main `src/i18n/index.js` messages import file.
+ *
+ *
+ * @param processedDirectories - List of directories with a boolean flag whether its "index.js" file is written
+ *                               The format is "[\{ directory: "frontend-component-example", isWritten: false \}, ...]"
+ * @param log - Mockable process.stdout.write
+ * @param writeFileSync - Mockable fs.writeFileSync
+ * @param i18nDir` - Path to `src/i18n` directory
+ */
+function generateMainMessagesFile({ processedDirectories, log, writeFileSync, i18nDir, }) {
+    const importLines = [];
+    const exportLines = [];
+    processedDirectories.forEach(processedDirectory => {
+        const { directory, isWritten } = processedDirectory;
+        if (isWritten) {
+            const moduleCamelCaseVariableName = (0, lodash_camelcase_1.default)(`messages_from_${directory}`);
+            importLines.push(`import ${moduleCamelCaseVariableName} from './messages/${directory}';`);
+            exportLines.push(`  ${moduleCamelCaseVariableName},`);
+        }
+        else {
+            const skipMessage = `Skipped import due to missing '${directory}/index.js' likely due to empty translations.`;
+            importLines.push(`// ${skipMessage}.`);
+            log(`${loggingPrefix}: ${skipMessage}\n`);
+        }
+    });
+    // See the help message above for sample output.
+    const indexFileContent = [
+        filesCodeGeneratorNoticeHeader,
+        importLines.join('\n'),
+        '\nexport default [',
+        exportLines.join('\n'),
+        '];\n',
+    ].join('\n');
+    writeFileSync(`${i18nDir}/index.js`, indexFileContent);
+}
+/*
+ * Main function of the file.
+ */
+function main({ directories, log, writeFileSync, pwd, }) {
+    const i18nDir = `${pwd}/src/i18n`; // The Micro-frontend i18n root directory
+    if (directories.includes('--help') || directories.includes('-h')) {
+        log(scriptHelpDocument);
+    }
+    else if (!directories.length) {
+        log(scriptHelpDocument);
+        log(`${loggingPrefix}: Error: A list of directories is required.\n`);
+    }
+    else if (!fs_1.default.existsSync(i18nDir) || !fs_1.default.lstatSync(i18nDir).isDirectory()) {
+        log(scriptHelpDocument);
+        log(`${loggingPrefix}: Error: src/i18n directory was not found.\n`);
+    }
+    else {
+        // If we're here, we know that directories is an array, so cast it as one.
+        const processedDirectories = directories.map((directory) => generateSubdirectoryMessageFile({
+            directory,
+            log,
+            writeFileSync,
+            i18nDir,
+        }));
+        generateMainMessagesFile({
+            processedDirectories,
+            log,
+            writeFileSync,
+            i18nDir,
+        });
+    }
+}
+if (require.main === module) {
+    // Run the main() function if called from the command line.
+    main({
+        directories: process.argv.slice(2),
+        log: text => process.stdout.write(text),
+        writeFileSync: fs_1.default.writeFileSync,
+        pwd: process.env.PWD ?? '.',
+    });
+}

package/tools/dist/cli/openedx.js

@@ -0,0 +1,100 @@
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const chalk_1 = __importDefault(require("chalk"));
+const fs_1 = require("fs");
+const path_1 = __importDefault(require("path"));
+const types_1 = require("../types");
+const pack_1 = __importDefault(require("./commands/pack"));
+const release_1 = __importDefault(require("./commands/release"));
+const ensureConfigFilenameOption_1 = require("./utils/ensureConfigFilenameOption");
+const prettyPrintTitle_1 = __importDefault(require("./utils/prettyPrintTitle"));
+const printUsage_1 = __importDefault(require("./utils/printUsage"));
+// commandName is the third argument after node and 'openedx'
+const commandName = process.argv[2];
+// remove 'openedx' from process.argv to allow subcommands to read options properly
+process.argv.splice(1, 1);
+let version;
+if ((0, fs_1.existsSync)(path_1.default.resolve(__dirname, '../../package.json'))) {
+    version = require('../../package.json').version;
+}
+else if ((0, fs_1.existsSync)(path_1.default.resolve(__dirname, '../../../package.json'))) {
+    version = require('../../../package.json').version;
+}
+(0, prettyPrintTitle_1.default)(`Open edX CLI v${version}`);
+switch (commandName) {
+    case types_1.CommandTypes.RELEASE:
+        (0, release_1.default)();
+        break;
+    case types_1.CommandTypes.PACK:
+        if (process.argv[2] === undefined) {
+            console.log(chalk_1.default.red(`${chalk_1.default.bold.red(commandName)} command usage: specify a peer folder where the command should install the package:
+
+      npm run pack my-project`));
+            process.exit(1);
+        }
+        (0, pack_1.default)();
+        break;
+    case types_1.CommandTypes.LINT:
+        (0, ensureConfigFilenameOption_1.ensureConfigFilenameOption)(types_1.ConfigTypes.LINT, ['-c', '--config']);
+        require('.bin/eslint');
+        break;
+    case types_1.CommandTypes.TEST:
+        (0, ensureConfigFilenameOption_1.ensureConfigFilenameOption)(types_1.ConfigTypes.TEST, ['-c', '--config']);
+        require('jest/bin/jest');
+        break;
+    case types_1.CommandTypes.BUILD:
+        (0, ensureConfigFilenameOption_1.ensureConfigFilenameOption)(types_1.ConfigTypes.WEBPACK_BUILD, ['-c', '--config']);
+        require('webpack/bin/webpack');
+        break;
+    case types_1.CommandTypes.DEV:
+        (0, ensureConfigFilenameOption_1.ensureConfigFilenameOption)(types_1.ConfigTypes.WEBPACK_DEV, ['-c', '--config']);
+        require('webpack-dev-server/bin/webpack-dev-server');
+        break;
+    case types_1.CommandTypes.DEV_SHELL:
+        (0, ensureConfigFilenameOption_1.ensureConfigFilenameOption)(types_1.ConfigTypes.WEBPACK_DEV_SHELL, ['-c', '--config']);
+        require('webpack-dev-server/bin/webpack-dev-server');
+        break;
+    case types_1.CommandTypes.FORMAT_JS: {
+        /* The include option is used to specify which additional source folders to extract messages from.
+         * To extract more messages on other source folders use: --include=plugins --include=plugins2
+         * The intention use case is to allow extraction from the 'plugins' directory on 'frontend-app-authoring'.
+         * That plugins folder were kept outside the src folder to ensure they remain independent and
+         * can function without relying on the MFE environment's special features.
+         * This approach allows them to be packaged separately as NPM packages. */
+        const additionalSrcFolders = [];
+        process.argv.forEach((val, index) => {
+            if (val.startsWith('--include=')) {
+                additionalSrcFolders.push(val.split('=')[1]);
+                process.argv.splice(index, 1);
+            }
+        });
+        const srcFolders = ['src'].concat(additionalSrcFolders);
+        let srcFoldersString = srcFolders.join(',');
+        if (srcFolders.length > 1) {
+            srcFoldersString = `{${srcFoldersString}}`;
+        }
+        process.argv = process.argv.concat([
+            '--format', 'node_modules/@openedx/frontend-base/dist/tools/cli/utils/formatter.js',
+            '--ignore', `${srcFoldersString}/**/*.json`,
+            '--ignore', `${srcFoldersString}/**/*.d.ts`,
+            '--out-file', './temp/formatjs/Default.messages.json',
+            '--', `${srcFoldersString}/**/*.{j,t}s*`,
+        ]);
+        require('@formatjs/cli/bin/formatjs');
+        break;
+    }
+    case types_1.CommandTypes.SERVE:
+        require('./commands/serve');
+        break;
+    case types_1.CommandTypes.HELP:
+        (0, printUsage_1.default)();
+        break;
+    default:
+        console.log(`The command ${chalk_1.default.bold(commandName)} doesn't exist.`);
+        console.log('');
+        (0, printUsage_1.default)();
+}

package/tools/dist/cli/transifex-utils.js

@@ -0,0 +1,68 @@
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = __importDefault(require("fs"));
+const glob_1 = __importDefault(require("glob"));
+const path_1 = __importDefault(require("path"));
+/*
+ * See the Makefile for how the required hash file is downloaded from Transifex.
+ */
+/*
+ * Expected input: a directory, possibly containing subdirectories, with .json files.  Each .json
+ * file is an array of translation triplets (id, description, defaultMessage).
+ *
+ *
+ */
+function gatherJson(dir) {
+    const ret = [];
+    const files = glob_1.default.sync(`${dir}/**/*.json`);
+    files.forEach((filename) => {
+        const messages = JSON.parse(fs_1.default.readFileSync(filename, { encoding: 'utf8' }));
+        ret.push(...messages);
+    });
+    return ret;
+}
+// the hash file returns ids whose periods are "escaped" (sort of), like this:
+// "key": "profile\\.sociallinks\\.social\\.links"
+// so our regular messageIds won't match them out of the box
+function escapeDots(messageId) {
+    return messageId.replace(/\./g, '\\.');
+}
+const jsonDir = process.argv[2];
+const messageObjects = gatherJson(jsonDir);
+if (messageObjects.length === 0) {
+    process.exitCode = 1;
+    throw new Error('Found no messages');
+}
+if (process.argv[3] === '--comments') { // prepare to handle the translator notes
+    const loggingPrefix = path_1.default.basename(`${__filename}`); // the name of this JS file
+    const bashScriptsPath = (process.argv[4] && process.argv[4] === '--v3-scripts-path'
+        ? './node_modules/@edx/reactifex/bash_scripts'
+        : './node_modules/reactifex/bash_scripts');
+    const hashFile = `${bashScriptsPath}/hashmap.json`;
+    process.stdout.write(`${loggingPrefix}: reading hash file ${hashFile}\n`);
+    const messageInfo = JSON.parse(fs_1.default.readFileSync(hashFile, { encoding: 'utf8' }));
+    const outputFile = `${bashScriptsPath}/hashed_data.txt`;
+    process.stdout.write(`${loggingPrefix}: writing to output file ${outputFile}\n`);
+    fs_1.default.writeFileSync(outputFile, '');
+    messageObjects.forEach((message) => {
+        const transifexFormatId = escapeDots(message.id);
+        const info = messageInfo.find((mi) => mi.key === transifexFormatId);
+        if (info) {
+            fs_1.default.appendFileSync(outputFile, `${info.string_hash}|${message.description}\n`);
+        }
+        else {
+            process.stdout.write(`${loggingPrefix}: string ${message.id} does not yet exist on transifex!\n`);
+        }
+    });
+}
+else {
+    const output = {};
+    messageObjects.forEach((message) => {
+        output[message.id] = message.defaultMessage;
+    });
+    fs_1.default.writeFileSync(process.argv[3], JSON.stringify(output, null, 2));
+}

package/tools/dist/cli/utils/ensureConfigFilenameOption.js

@@ -0,0 +1,42 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ensureConfigFilenameOption = ensureConfigFilenameOption;
+const path_1 = __importDefault(require("path"));
+const getResolvedConfigPath_1 = __importDefault(require("./getResolvedConfigPath"));
+function ensureConfigFilenameOption(configType, keys) {
+    let configFileName = null;
+    let fileNameIndex = null;
+    for (const key of keys) {
+        const index = process.argv.indexOf(key);
+        if (index !== -1) {
+            fileNameIndex = index + 1;
+            if (process.argv.length > fileNameIndex) {
+                configFileName = process.argv[fileNameIndex];
+            }
+            else {
+                console.error(`You must specify a config filename as the next argument when using the ${key} flag. Aborting.`);
+                process.exit(1);
+            }
+        }
+    }
+    let customConfigFilePath = null;
+    if (configFileName !== null) {
+        customConfigFilePath = path_1.default.resolve(process.cwd(), configFileName);
+    }
+    const resolvedConfigPath = (0, getResolvedConfigPath_1.default)(customConfigFilePath, configType);
+    if (resolvedConfigPath === null) {
+        console.error(`No valid config file was found. Did you forget to create a config file? You may specify a custom path with the ${keys.join(' or ')} flag(s).`);
+        process.exit(1);
+    }
+    // If there wasn't a config flag on the command line, add one.
+    if (fileNameIndex === null) {
+        process.argv.push(keys[0]);
+        process.argv.push(resolvedConfigPath);
+    }
+    else {
+        process.argv[fileNameIndex] = resolvedConfigPath;
+    }
+}

package/tools/dist/cli/utils/formatter.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.format = (messages) => {
+    const results = Object.entries(messages).map(([id, message]) => ({
+        id,
+        defaultMessage: message.defaultMessage,
+        description: message.description,
+    }));
+    return results;
+};

package/tools/dist/cli/utils/getResolvedConfigPath.js

@@ -0,0 +1,28 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = getResolvedConfigPath;
+const fs_1 = __importDefault(require("fs"));
+const defaultConfigPaths_1 = require("../../defaultConfigPaths");
+function getResolvedConfigPath(customConfigPath, configType) {
+    const configPaths = defaultConfigPaths_1.defaultConfigPaths[configType];
+    if (customConfigPath !== null) {
+        if (fs_1.default.existsSync(customConfigPath)) {
+            return customConfigPath;
+        }
+        else {
+            console.error(`The custom config file at ${customConfigPath} does not exist. Aborting.`);
+            return null;
+        }
+    }
+    else {
+        for (const configPath of configPaths) {
+            if (fs_1.default.existsSync(configPath)) {
+                return configPath;
+            }
+        }
+    }
+    return null;
+}

package/tools/dist/cli/utils/prettyPrintTitle.js

@@ -0,0 +1,17 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = prettyPrintTitle;
+const chalk_1 = __importDefault(require("chalk"));
+const gradient_string_1 = __importDefault(require("gradient-string"));
+function prettyPrintTitle(title) {
+    const openedxGradient = (0, gradient_string_1.default)(['#B82669', '#22358C']);
+    const borderedTitle = `█ ${title} █`;
+    const whitespace = Array.from({ length: borderedTitle.length }, () => '█').join('');
+    console.log(chalk_1.default.bgWhite(openedxGradient(whitespace)));
+    console.log(chalk_1.default.bold.bgWhite(openedxGradient(borderedTitle)));
+    console.log(chalk_1.default.bgWhite(openedxGradient(whitespace)));
+    console.log('');
+}

package/tools/dist/cli/utils/printUsage.js

@@ -0,0 +1,48 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = printUsage;
+const chalk_1 = __importDefault(require("chalk"));
+function printUsage() {
+    console.log('CLI Usage:\n');
+    console.group();
+    console.log('openedx <command> <options>\n');
+    console.groupEnd();
+    console.log('Commands:\n');
+    console.group();
+    console.log(`${chalk_1.default.bold('release')}\n`);
+    console.group();
+    console.log(`Compile source code for release as a library.  Compiled code is put into the dist folder.\n`);
+    console.groupEnd();
+    console.log(`${chalk_1.default.bold('pack')} <peer folder>\n`);
+    console.group();
+    console.log(`Package the dist folder as an NPM-compatible .tgz file suitable for use with npm install, then install it in the specified peer folder.  The folder is assumed to be a peer of this repository, do not include a path.\n`);
+    console.groupEnd();
+    console.log(`${chalk_1.default.bold('lint')} <eslint options>\n`);
+    console.group();
+    console.log(`Runs ESLint on the source code. Requires an ${chalk_1.default.bold('eslint.config.js')} file.\n`);
+    console.groupEnd();
+    console.log(`${chalk_1.default.bold('test')} <jest options>\n`);
+    console.group();
+    console.log(`Runs Jest on the source code test suite. Requires a ${chalk_1.default.bold('jest.config.js')} file.\n`);
+    console.groupEnd();
+    console.log(`${chalk_1.default.bold('build')}\n`);
+    console.group();
+    console.log(`Compiles the source code for deployment as a frontend site.  Requires a ${chalk_1.default.bold('site.config.build.tsx')} file.\n`);
+    console.groupEnd();
+    console.log(`${chalk_1.default.bold('dev')}\n`);
+    console.group();
+    console.log(`Compiles the source code and serves it in Webpack dev server as a frontend site. Requires a ${chalk_1.default.bold('site.config.dev.tsx')} file.\n`);
+    console.groupEnd();
+    console.log(`${chalk_1.default.bold('formatjs')}\n`);
+    console.group();
+    console.log(`Runs formatjs on the source code to extract internationalization messages.\n`);
+    console.groupEnd();
+    console.log(`${chalk_1.default.bold('serve')}\n`);
+    console.group();
+    console.log(`Serves the dist folder with an express server.  Used to locally test production assets.\n`);
+    console.groupEnd();
+    console.groupEnd();
+}