@openedx/frontend-base 1.0.0-alpha.20 → 1.0.0-alpha.22

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

@@ -1,146 +0,0 @@
-"use strict";
-// Tests for the intl-imports.js command line.
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const path_1 = __importDefault(require("path"));
-const intl_imports_1 = require("./intl-imports");
-const sampleAppDirectory = path_1.default.join(__dirname, '../../test-site');
-// History for `process.stdout.write` mock calls.
-const logHistory = {
-    log: [],
-    latest: '',
-};
-// History for `fs.writeFileSync` mock calls.
-const writeFileHistory = {
-    log: [],
-    latest: null,
-};
-// Mock for process.stdout.write
-const log = (text) => {
-    logHistory.latest = text;
-    logHistory.log.push(text);
-};
-// Mock for fs.writeFileSync
-const writeFileSync = (filename, content) => {
-    const entry = { filename, content };
-    writeFileHistory.latest = entry;
-    writeFileHistory.log.push(entry);
-};
-// Main with mocked output
-const main = (...directories) => (0, intl_imports_1.main)({
-    directories,
-    log,
-    writeFileSync,
-    pwd: sampleAppDirectory,
-});
-// Clean up mock histories
-afterEach(() => {
-    logHistory.log = [];
-    logHistory.latest = null;
-    writeFileHistory.log = [];
-    writeFileHistory.latest = null;
-});
-describe('help document', () => {
-    it('should print help for --help', () => {
-        main('--help');
-        expect(logHistory.latest).toMatch('Script to generate the src/i18n/index.js');
-    });
-    it('should print help for -h', () => {
-        main('-h');
-        expect(logHistory.latest).toMatch('Script to generate the src/i18n/index.js');
-    });
-});
-describe('error validation', () => {
-    it('expects a list of directories', () => {
-        main();
-        expect(logHistory.log.join('\n')).toMatch('Script to generate the src/i18n/index.js'); // Print help error
-        expect(logHistory.latest).toMatch('Error: A list of directories is required'); // Print error message
-    });
-    it('expects a directory with a relative path of "src/i18n"', () => {
-        (0, intl_imports_1.main)({
-            directories: ['frontend-app-example'],
-            log,
-            writeFileSync,
-            pwd: path_1.default.join(__dirname), // __dirname === `scripts` which has no sub-dir `src/i18n`
-        });
-        expect(logHistory.log.join('\n')).toMatch('Script to generate the src/i18n/index.js'); // Print help on error
-        expect(logHistory.latest).toMatch('Error: src/i18n directory was not found.'); // Print error message
-    });
-});
-describe('generated files', () => {
-    it('writes a correct src/i18n/index.js file', () => {
-        main('frontend-component-singlelang', 'frontend-component-nolangs', 'frontend-component-emptylangs', 'frontend-app-sample');
-        const mainFileActualContent = writeFileHistory.log.find((file) => {
-            return file.filename.endsWith('src/i18n/index.js');
-        })?.content;
-        const mainFileExpectedContent = `// 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.
-//
-
-import messagesFromFrontendComponentSinglelang from './messages/frontend-component-singlelang';
-// Skipped import due to missing 'frontend-component-nolangs/index.js' likely due to empty translations..
-// Skipped import due to missing 'frontend-component-emptylangs/index.js' likely due to empty translations..
-import messagesFromFrontendAppSample from './messages/frontend-app-sample';
-
-export default [
-  messagesFromFrontendComponentSinglelang,
-  messagesFromFrontendAppSample,
-];
-`;
-        expect(mainFileActualContent).toEqual(mainFileExpectedContent);
-    });
-    it('writes a correct frontend-component-singlelang/index.js file', () => {
-        main('frontend-component-singlelang', 'frontend-component-nolangs', 'frontend-component-emptylangs', 'frontend-app-sample');
-        const mainFileActualContent = writeFileHistory.log.find(file => file.filename.endsWith('frontend-component-singlelang/index.js'))?.content;
-        const singleLangExpectedContent = `// 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.
-//
-
-import messagesOfArLanguage from './ar.json';
-
-export default {
-  'ar': messagesOfArLanguage,
-};
-`;
-        expect(mainFileActualContent).toEqual(singleLangExpectedContent);
-    });
-    it('writes a correct frontend-app-sample/index.js file', () => {
-        main('frontend-component-singlelang', 'frontend-component-nolangs', 'frontend-component-emptylangs', 'frontend-app-sample');
-        const mainFileActualContent = writeFileHistory.log.find(file => file.filename.endsWith('frontend-app-sample/index.js'))?.content;
-        const singleLangExpectedContent = `// 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.
-//
-
-import messagesOfArLanguage from './ar.json';
-// Note: Skipped empty 'eo.json' messages file.
-import messagesOfEs419Language from './es_419.json';
-
-export default {
-  'ar': messagesOfArLanguage,
-  'es-419': messagesOfEs419Language,
-};
-`;
-        expect(mainFileActualContent).toEqual(singleLangExpectedContent);
-    });
-});
-describe('list of generated index.js files', () => {
-    it('writes only non-empty languages in addition to the main file', () => {
-        main('frontend-component-singlelang', 'frontend-component-nolangs', 'frontend-component-emptylangs', 'frontend-app-sample');
-        const writtenFiles = writeFileHistory.log
-            .map(file => file.filename)
-            .map(file => path_1.default.relative(sampleAppDirectory, file));
-        expect(writtenFiles).toEqual([
-            'src/i18n/messages/frontend-component-singlelang/index.js',
-            'src/i18n/messages/frontend-app-sample/index.js',
-            'src/i18n/index.js',
-        ]);
-    });
-});

package/dist/tools/cli/transifex-utils.d.ts

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-export {};

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

@@ -1,68 +0,0 @@
-#!/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/dist/tools/webpack/plugins/html-webpack-new-relic-plugin/test/HtmlWebpackNewRelicPlugin.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/tools/webpack/plugins/html-webpack-new-relic-plugin/test/HtmlWebpackNewRelicPlugin.test.js

@@ -1,66 +0,0 @@
-"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 html_webpack_plugin_1 = __importDefault(require("html-webpack-plugin"));
-const path_1 = __importDefault(require("path"));
-const webpack_1 = __importDefault(require("webpack"));
-const HtmlWebpackNewRelicPlugin_1 = __importDefault(require("../HtmlWebpackNewRelicPlugin"));
-const OUTPUT_DIR = path_1.default.join(__dirname, './dist');
-describe('HtmlWebpackNewRelicPlugin', () => {
-    const testPluginOptions = {
-        accountID: '121212',
-        agentID: '343434',
-        trustKey: '565656',
-        licenseKey: '123456',
-        applicationID: '654321',
-    };
-    afterEach(() => {
-        if (fs_1.default.existsSync(OUTPUT_DIR)) {
-            fs_1.default.rmSync(OUTPUT_DIR, { recursive: true, force: true });
-        }
-    });
-    it('should append new relic script to body', done => {
-        (0, webpack_1.default)({
-            entry: path_1.default.resolve(__dirname, 'fixtures', 'entry.js'),
-            output: {
-                path: path_1.default.resolve(__dirname, './dist'),
-            },
-            plugins: [
-                new html_webpack_plugin_1.default(),
-                new HtmlWebpackNewRelicPlugin_1.default(testPluginOptions),
-            ],
-        }, (err) => {
-            const htmlFile = path_1.default.resolve(OUTPUT_DIR, 'index.html');
-            expect(err).toBeNull();
-            expect(fs_1.default.existsSync(htmlFile)).toBe(true);
-            const file = fs_1.default.readFileSync(path_1.default.resolve(OUTPUT_DIR, htmlFile), { encoding: 'utf-8' }, (error, data) => data.toString());
-            Object.entries(testPluginOptions).forEach(([optionName, optionValue]) => {
-                expect(file.indexOf(`${optionName}:"${optionValue}"`)).toBeGreaterThan(-1);
-            });
-            done();
-        });
-    });
-    describe('when its missing configuration variables', () => {
-        function testMissingOption(missingOptionName) {
-            it(`should throw error if ${missingOptionName} is missing`, done => {
-                const compiler = (0, webpack_1.default)({
-                    entry: path_1.default.resolve(__dirname, 'fixtures', 'entry.js'),
-                    output: {
-                        path: path_1.default.resolve(__dirname, '../dist'),
-                    },
-                    plugins: [new html_webpack_plugin_1.default()],
-                });
-                const optionsMissingOne = { ...testPluginOptions };
-                delete optionsMissingOne[missingOptionName];
-                expect(() => compiler.options.plugins.push(new HtmlWebpackNewRelicPlugin_1.default(optionsMissingOne))).toThrow(`${missingOptionName} argument is required`);
-                done();
-            });
-        }
-        Object.keys(testPluginOptions).forEach((key) => {
-            testMissingOption(key);
-        });
-    });
-});