]> git.proxmox.com Git - mirror_novnc.git/blobdiff - utils/use_require.js
Merge branch 'noie' of https://github.com/CendioOssman/noVNC
[mirror_novnc.git] / utils / use_require.js
index c29f77156461e24f3d144ded67d18879eb0fbf02..5dd900a75dead330330542bafd61c0279cdf862d 100755 (executable)
@@ -6,13 +6,8 @@ const fs = require('fs');
 const fse = require('fs-extra');
 const babel = require('@babel/core');
 
-const SUPPORTED_FORMATS = new Set(['amd', 'commonjs', 'systemjs', 'umd']);
-
 program
-    .option('--as [format]', `output files using various import formats instead of ES6 import and export.  Supports ${Array.from(SUPPORTED_FORMATS)}.`)
     .option('-m, --with-source-maps [type]', 'output source maps when not generating a bundled app (type may be empty for external source maps, inline for inline source maps, or both) ')
-    .option('--with-app', 'process app files as well as core files')
-    .option('--only-legacy', 'only output legacy files (no ES6 modules) for the app')
     .option('--clean', 'clear the lib folder before building')
     .parse(process.argv);
 
@@ -20,30 +15,10 @@ program
 const paths = {
     main: path.resolve(__dirname, '..'),
     core: path.resolve(__dirname, '..', 'core'),
-    app: path.resolve(__dirname, '..', 'app'),
     vendor: path.resolve(__dirname, '..', 'vendor'),
-    outDirBase: path.resolve(__dirname, '..', 'build'),
     libDirBase: path.resolve(__dirname, '..', 'lib'),
 };
 
-const noCopyFiles = new Set([
-    // skip these -- they don't belong in the processed application
-    path.join(paths.vendor, 'sinon.js'),
-    path.join(paths.vendor, 'browser-es-module-loader'),
-    path.join(paths.app, 'images', 'icons', 'Makefile'),
-]);
-
-const onlyLegacyScripts = new Set([
-    path.join(paths.vendor, 'promise.js'),
-]);
-
-const noTransformFiles = new Set([
-    // don't transform this -- we want it imported as-is to properly catch loading errors
-    path.join(paths.app, 'error-handler.js'),
-]);
-
-noCopyFiles.forEach(file => noTransformFiles.add(file));
-
 // util.promisify requires Node.js 8.x, so we have our own
 function promisify(original) {
     return function promiseWrap() {
@@ -57,16 +32,12 @@ function promisify(original) {
     };
 }
 
-const readFile = promisify(fs.readFile);
 const writeFile = promisify(fs.writeFile);
 
 const readdir = promisify(fs.readdir);
 const lstat = promisify(fs.lstat);
 
-const copy = promisify(fse.copy);
-const unlink = promisify(fse.unlink);
 const ensureDir = promisify(fse.ensureDir);
-const rmdir = promisify(fse.rmdir);
 
 const babelTransformFile = promisify(babel.transformFile);
 
@@ -87,157 +58,57 @@ function walkDir(basePath, cb, filter) {
         });
 }
 
-function transformHtml(legacyScripts, onlyLegacy) {
-    // write out the modified vnc.html file that works with the bundle
-    const srcHtmlPath = path.resolve(__dirname, '..', 'vnc.html');
-    const outHtmlPath = path.resolve(paths.outDirBase, 'vnc.html');
-    return readFile(srcHtmlPath)
-        .then((contentsRaw) => {
-            let contents = contentsRaw.toString();
-
-            const startMarker = '<!-- begin scripts -->\n';
-            const endMarker = '<!-- end scripts -->';
-            const startInd = contents.indexOf(startMarker) + startMarker.length;
-            const endInd = contents.indexOf(endMarker, startInd);
-
-            let newScript = '';
-
-            if (onlyLegacy) {
-            // Only legacy version, so include things directly
-                for (let i = 0;i < legacyScripts.length;i++) {
-                    newScript += `    <script src="${legacyScripts[i]}"></script>\n`;
-                }
-            } else {
-                // Otherwise include both modules and legacy fallbacks
-                newScript += '    <script type="module" crossorigin="anonymous" src="app/ui.js"></script>\n';
-                for (let i = 0;i < legacyScripts.length;i++) {
-                    newScript += `    <script nomodule src="${legacyScripts[i]}"></script>\n`;
-                }
-            }
-
-            contents = contents.slice(0, startInd) + `${newScript}\n` + contents.slice(endInd);
-
-            return contents;
-        })
-        .then((contents) => {
-            console.log(`Writing ${outHtmlPath}`);
-            return writeFile(outHtmlPath, contents);
-        });
-}
-
-function makeLibFiles(importFormat, sourceMaps, withAppDir, onlyLegacy) {
-    if (!importFormat) {
-        throw new Error("you must specify an import format to generate compiled noVNC libraries");
-    } else if (!SUPPORTED_FORMATS.has(importFormat)) {
-        throw new Error(`unsupported output format "${importFormat}" for import/export -- only ${Array.from(SUPPORTED_FORMATS)} are supported`);
-    }
-
+function makeLibFiles(sourceMaps) {
     // NB: we need to make a copy of babelOpts, since babel sets some defaults on it
     const babelOpts = () => ({
         plugins: [],
         presets: [
             [ '@babel/preset-env',
-              { targets: 'ie >= 11',
-                modules: importFormat } ]
+              { modules: 'commonjs' } ]
         ],
         ast: false,
         sourceMaps: sourceMaps,
     });
 
-    // No point in duplicate files without the app, so force only converted files
-    if (!withAppDir) {
-        onlyLegacy = true;
-    }
-
-    let inPath;
-    let outPathBase;
-    if (withAppDir) {
-        outPathBase = paths.outDirBase;
-        inPath = paths.main;
-    } else {
-        outPathBase = paths.libDirBase;
-    }
-    const legacyPathBase = onlyLegacy ? outPathBase : path.join(outPathBase, 'legacy');
-
-    fse.ensureDirSync(outPathBase);
-
-    const helpers = require('./use_require_helpers');
-    const helper = helpers[importFormat];
+    fse.ensureDirSync(paths.libDirBase);
 
     const outFiles = [];
-    const legacyFiles = [];
 
-    const handleDir = (jsOnly, vendorRewrite, inPathBase, filename) => Promise.resolve()
+    const handleDir = (vendorRewrite, inPathBase, filename) => Promise.resolve()
         .then(() => {
-            const outPath = path.join(outPathBase, path.relative(inPathBase, filename));
-            const legacyPath = path.join(legacyPathBase, path.relative(inPathBase, filename));
+            const outPath = path.join(paths.libDirBase, path.relative(inPathBase, filename));
 
             if (path.extname(filename) !== '.js') {
-                if (!jsOnly) {
-                    console.log(`Writing ${outPath}`);
-                    return copy(filename, outPath);
-                }
                 return;  // skip non-javascript files
             }
-
-            if (noTransformFiles.has(filename)) {
-                return ensureDir(path.dirname(outPath))
-                    .then(() => {
-                        console.log(`Writing ${outPath}`);
-                        return copy(filename, outPath);
-                    });
-            }
-
-            if (onlyLegacyScripts.has(filename)) {
-                legacyFiles.push(legacyPath);
-                return ensureDir(path.dirname(legacyPath))
-                    .then(() => {
-                        console.log(`Writing ${legacyPath}`);
-                        return copy(filename, legacyPath);
-                    });
-            }
-
             return Promise.resolve()
-                .then(() => {
-                    if (onlyLegacy) {
-                        return;
-                    }
-                    return ensureDir(path.dirname(outPath))
-                        .then(() => {
-                            console.log(`Writing ${outPath}`);
-                            return copy(filename, outPath);
-                        });
-                })
-                .then(() => ensureDir(path.dirname(legacyPath)))
+                .then(() => ensureDir(path.dirname(outPath)))
                 .then(() => {
                     const opts = babelOpts();
-                    if (helper && helpers.optionsOverride) {
-                        helper.optionsOverride(opts);
-                    }
             // Adjust for the fact that we move the core files relative
             // to the vendor directory
                     if (vendorRewrite) {
                         opts.plugins.push(["import-redirect",
-                                           {"root": legacyPathBase,
+                                           {"root": paths.libDirBase,
                                             "redirect": { "vendor/(.+)": "./vendor/$1"}}]);
                     }
 
                     return babelTransformFile(filename, opts)
                         .then((res) => {
-                            console.log(`Writing ${legacyPath}`);
+                            console.log(`Writing ${outPath}`);
                             const {map} = res;
                             let {code} = res;
                             if (sourceMaps === true) {
                     // append URL for external source map
-                                code += `\n//# sourceMappingURL=${path.basename(legacyPath)}.map\n`;
+                                code += `\n//# sourceMappingURL=${path.basename(outPath)}.map\n`;
                             }
-                            outFiles.push(`${legacyPath}`);
-                            return writeFile(legacyPath, code)
+                            outFiles.push(`${outPath}`);
+                            return writeFile(outPath, code)
                                 .then(() => {
                                     if (sourceMaps === true || sourceMaps === 'both') {
-                                        console.log(`  and ${legacyPath}.map`);
-                                        outFiles.push(`${legacyPath}.map`);
-                                        return writeFile(`${legacyPath}.map`, JSON.stringify(map));
+                                        console.log(`  and ${outPath}.map`);
+                                        outFiles.push(`${outPath}.map`);
+                                        return writeFile(`${outPath}.map`, JSON.stringify(map));
                                     }
                                 });
                         });
@@ -246,64 +117,12 @@ function makeLibFiles(importFormat, sourceMaps, withAppDir, onlyLegacy) {
 
     Promise.resolve()
         .then(() => {
-            const handler = handleDir.bind(null, true, false, inPath || paths.main);
-            const filter = (filename, stats) => !noCopyFiles.has(filename);
-            return walkDir(paths.vendor, handler, filter);
-        })
-        .then(() => {
-            const handler = handleDir.bind(null, true, !inPath, inPath || paths.core);
-            const filter = (filename, stats) => !noCopyFiles.has(filename);
-            return walkDir(paths.core, handler, filter);
-        })
-        .then(() => {
-            if (!withAppDir) return;
-            const handler = handleDir.bind(null, false, false, inPath);
-            const filter = (filename, stats) => !noCopyFiles.has(filename);
-            return walkDir(paths.app, handler, filter);
+            const handler = handleDir.bind(null, false, paths.main);
+            return walkDir(paths.vendor, handler);
         })
         .then(() => {
-            if (!withAppDir) return;
-
-            if (!helper || !helper.appWriter) {
-                throw new Error(`Unable to generate app for the ${importFormat} format!`);
-            }
-
-            const outAppPath = path.join(legacyPathBase, 'app.js');
-            console.log(`Writing ${outAppPath}`);
-            return helper.appWriter(outPathBase, legacyPathBase, outAppPath)
-                .then((extraScripts) => {
-                    let legacyScripts = [];
-
-                    legacyFiles.forEach((file) => {
-                        let relFilePath = path.relative(outPathBase, file);
-                        legacyScripts.push(relFilePath);
-                    });
-
-                    legacyScripts = legacyScripts.concat(extraScripts);
-
-                    let relAppPath = path.relative(outPathBase, outAppPath);
-                    legacyScripts.push(relAppPath);
-
-                    transformHtml(legacyScripts, onlyLegacy);
-                })
-                .then(() => {
-                    if (!helper.removeModules) return;
-                    console.log(`Cleaning up temporary files...`);
-                    return Promise.all(outFiles.map((filepath) => {
-                        unlink(filepath)
-                            .then(() => {
-                                // Try to clean up any empty directories if
-                                // this was the last file in there
-                                const rmdirR = dir =>
-                                    rmdir(dir)
-                                        .then(() => rmdirR(path.dirname(dir)))
-                                        .catch(() => {
-                                // Assume the error was ENOTEMPTY and ignore it
-                                        });
-                                return rmdirR(path.dirname(filepath));
-                            });
-                    }));
-                });
+            const handler = handleDir.bind(null, true, paths.core);
+            return walkDir(paths.core, handler);
         })
         .catch((err) => {
             console.error(`Failure converting modules: ${err}`);
@@ -314,9 +133,6 @@ function makeLibFiles(importFormat, sourceMaps, withAppDir, onlyLegacy) {
 if (program.clean) {
     console.log(`Removing ${paths.libDirBase}`);
     fse.removeSync(paths.libDirBase);
-
-    console.log(`Removing ${paths.outDirBase}`);
-    fse.removeSync(paths.outDirBase);
 }
 
-makeLibFiles(program.as, program.withSourceMaps, program.withApp, program.onlyLegacy);
+makeLibFiles(program.withSourceMaps);