]>
git.proxmox.com Git - mirror_novnc.git/blob - utils/use_require.js
3 const path
= require ( 'path' );
4 const program
= require ( 'commander' );
5 const fs
= require ( 'fs' );
6 const fse
= require ( 'fs-extra' );
7 const babel
= require ( 'babel-core' );
9 const SUPPORTED_FORMATS
= new Set ([ 'amd' , 'commonjs' , 'systemjs' , 'umd' ]);
12 . option ( '--as [format]' , `output files using various import formats instead of ES6 import and export. Supports ${Array.from(SUPPORTED_FORMATS)} .` )
13 . 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) ' )
14 . option ( '--with-app' , 'process app files as well as core files' )
15 . option ( '--only-legacy' , 'only output legacy files (no ES6 modules) for the app' )
16 . option ( '--clean' , 'clear the lib folder before building' )
19 // the various important paths
21 main
: path
. resolve ( __dirname
, '..' ),
22 core
: path
. resolve ( __dirname
, '..' , 'core' ),
23 app
: path
. resolve ( __dirname
, '..' , 'app' ),
24 vendor
: path
. resolve ( __dirname
, '..' , 'vendor' ),
25 out_dir_base
: path
. resolve ( __dirname
, '..' , 'build' ),
26 lib_dir_base
: path
. resolve ( __dirname
, '..' , 'lib' ),
29 const no_copy_files
= new Set ([
30 // skip these -- they don't belong in the processed application
31 path
. join ( paths
. vendor
, 'sinon.js' ),
32 path
. join ( paths
. vendor
, 'browser-es-module-loader' ),
33 path
. join ( paths
. vendor
, 'promise.js' ),
34 path
. join ( paths
. app
, 'images' , 'icons' , 'Makefile' ),
37 const no_transform_files
= new Set ([
38 // don't transform this -- we want it imported as-is to properly catch loading errors
39 path
. join ( paths
. app
, 'error-handler.js' ),
42 no_copy_files
. forEach (( file
) => no_transform_files
. add ( file
));
44 // util.promisify requires Node.js 8.x, so we have our own
45 function promisify ( original
) {
48 const args
= Array
. prototype . slice
. call ( arguments
);
49 return new Promise (( resolve
, reject
) => {
50 original
. apply ( obj
, args
. concat (( err
, value
) => {
51 if ( err
) return reject ( err
);
58 const readFile
= promisify ( fs
. readFile
);
59 const writeFile
= promisify ( fs
. writeFile
);
61 const readdir
= promisify ( fs
. readdir
);
62 const lstat
= promisify ( fs
. lstat
);
64 const copy
= promisify ( fse
. copy
);
65 const unlink
= promisify ( fse
. unlink
);
66 const ensureDir
= promisify ( fse
. ensureDir
);
67 const rmdir
= promisify ( fse
. rmdir
);
69 const babelTransformFile
= promisify ( babel
. transformFile
);
71 // walkDir *recursively* walks directories trees,
72 // calling the callback for all normal files found.
73 const walkDir = function ( base_path
, cb
, filter
) {
74 return readdir ( base_path
)
76 const paths
= files
. map ( filename
=> path
. join ( base_path
, filename
));
77 return Promise
. all ( paths
. map (( filepath
) => {
78 return lstat ( filepath
)
80 if ( filter
!== undefined && ! filter ( filepath
, stats
)) return ;
82 if ( stats
. isSymbolicLink ()) return ;
83 if ( stats
. isFile ()) return cb ( filepath
);
84 if ( stats
. isDirectory ()) return walkDir ( filepath
, cb
, filter
);
90 const transform_html = function ( legacy_scripts
, only_legacy
) {
91 // write out the modified vnc.html file that works with the bundle
92 const src_html_path
= path
. resolve ( __dirname
, '..' , 'vnc.html' );
93 const out_html_path
= path
. resolve ( paths
. out_dir_base
, 'vnc.html' );
94 return readFile ( src_html_path
)
95 . then ( contents_raw
=> {
96 let contents
= contents_raw
. toString ();
98 const start_marker
= '<!-- begin scripts --> \n ' ;
99 const end_marker
= '<!-- end scripts -->' ;
100 const start_ind
= contents
. indexOf ( start_marker
) + start_marker
. length
;
101 const end_ind
= contents
. indexOf ( end_marker
, start_ind
);
106 // Only legacy version, so include things directly
107 for ( let i
= 0 ; i
< legacy_scripts
. length
; i
++) {
108 new_script
+= ` <script src=" ${legacy_scripts[i]} "></script> \n ` ;
111 // Otherwise detect if it's a modern browser and select
112 // variant accordingly
114 <script type="module"> \n \
115 window._noVNC_has_module_support = true; \n \
118 window.addEventListener("load", function() { \n \
119 if (window._noVNC_has_module_support) return; \n \
120 let legacy_scripts = ${JSON.stringify(legacy_scripts)} ; \n \
121 for (let i = 0;i < legacy_scripts.length;i++) { \n \
122 let script = document.createElement("script"); \n \
123 script.src = legacy_scripts[i]; \n \
124 script.async = false; \n \
125 document.head.appendChild(script); \n \
130 // Original, ES6 modules
131 new_script
+= ' <script type="module" crossorigin="anonymous" src="app/ui.js"></script> \n ' ;
134 contents
= contents
. slice ( 0 , start_ind
) + ` ${new_script} \n ` + contents
. slice ( end_ind
);
138 . then (( contents
) => {
139 console
. log ( `Writing ${out_html_path} ` );
140 return writeFile ( out_html_path
, contents
);
144 const make_lib_files = function ( import_format
, source_maps
, with_app_dir
, only_legacy
) {
145 if (! import_format
) {
146 throw new Error ( "you must specify an import format to generate compiled noVNC libraries" );
147 } else if (! SUPPORTED_FORMATS
. has ( import_format
)) {
148 throw new Error ( `unsupported output format " ${import_format} " for import/export -- only ${Array.from(SUPPORTED_FORMATS)} are supported` );
151 // NB: we need to make a copy of babel_opts, since babel sets some defaults on it
152 const babel_opts
= () => ({
153 plugins
: [ `transform-es2015-modules- ${import_format} ` ],
156 sourceMaps
: source_maps
,
159 // No point in duplicate files without the app, so force only converted files
167 out_path_base
= paths
. out_dir_base
;
168 in_path
= paths
. main
;
170 out_path_base
= paths
. lib_dir_base
;
172 const legacy_path_base
= only_legacy
? out_path_base
: path
. join ( out_path_base
, 'legacy' );
174 fse
. ensureDirSync ( out_path_base
);
176 const helpers
= require ( './use_require_helpers' );
177 const helper
= helpers
[ import_format
];
181 const handleDir
= ( js_only
, vendor_rewrite
, in_path_base
, filename
) => Promise
. resolve ()
183 if ( no_copy_files
. has ( filename
)) return ;
185 const out_path
= path
. join ( out_path_base
, path
. relative ( in_path_base
, filename
));
186 const legacy_path
= path
. join ( legacy_path_base
, path
. relative ( in_path_base
, filename
));
188 if ( path
. extname ( filename
) !== '.js' ) {
190 console
. log ( `Writing ${out_path} ` );
191 return copy ( filename
, out_path
);
193 return ; // skip non-javascript files
196 return Promise
. resolve ()
198 if ( only_legacy
&& ! no_transform_files
. has ( filename
)) {
201 return ensureDir ( path
. dirname ( out_path
))
203 console
. log ( `Writing ${out_path} ` );
204 return copy ( filename
, out_path
);
207 . then (() => ensureDir ( path
. dirname ( legacy_path
)))
209 if ( no_transform_files
. has ( filename
)) {
213 const opts
= babel_opts ();
214 if ( helper
&& helpers
. optionsOverride
) {
215 helper
. optionsOverride ( opts
);
217 // Adjust for the fact that we move the core files relative
218 // to the vendor directory
219 if ( vendor_rewrite
) {
220 opts
. plugins
. push ([ "import-redirect" ,
221 { "root" : legacy_path_base
,
222 "redirect" : { "vendor/(.+)" : "./vendor/$1" }}]);
225 return babelTransformFile ( filename
, opts
)
227 console
. log ( `Writing ${legacy_path} ` );
230 if ( source_maps
=== true ) {
231 // append URL for external source map
232 code
+= ` \n //# sourceMappingURL= ${path.basename(legacy_path)} .map \n ` ;
234 outFiles
. push ( ` ${legacy_path} ` );
235 return writeFile ( legacy_path
, code
)
237 if ( source_maps
=== true || source_maps
=== 'both' ) {
238 console
. log ( ` and ${legacy_path} .map` );
239 outFiles
. push ( ` ${legacy_path} .map` );
240 return writeFile ( ` ${legacy_path} .map` , JSON
. stringify ( map
));
247 if ( with_app_dir
&& helper
&& helper
. noCopyOverride
) {
248 helper
. noCopyOverride ( paths
, no_copy_files
);
253 const handler
= handleDir
. bind ( null , true , false , in_path
|| paths
. main
);
254 const filter
= ( filename
, stats
) => ! no_copy_files
. has ( filename
);
255 return walkDir ( paths
. vendor
, handler
, filter
);
258 const handler
= handleDir
. bind ( null , true , ! in_path
, in_path
|| paths
. core
);
259 const filter
= ( filename
, stats
) => ! no_copy_files
. has ( filename
);
260 return walkDir ( paths
. core
, handler
, filter
);
263 if (! with_app_dir
) return ;
264 const handler
= handleDir
. bind ( null , false , false , in_path
);
265 const filter
= ( filename
, stats
) => ! no_copy_files
. has ( filename
);
266 return walkDir ( paths
. app
, handler
, filter
);
269 if (! with_app_dir
) return ;
271 if (! helper
|| ! helper
. appWriter
) {
272 throw new Error ( `Unable to generate app for the ${import_format} format!` );
275 const out_app_path
= path
. join ( legacy_path_base
, 'app.js' );
276 console
. log ( `Writing ${out_app_path} ` );
277 return helper
. appWriter ( out_path_base
, legacy_path_base
, out_app_path
)
278 . then ( extra_scripts
=> {
279 const rel_app_path
= path
. relative ( out_path_base
, out_app_path
);
280 const legacy_scripts
= extra_scripts
. concat ([ rel_app_path
]);
281 transform_html ( legacy_scripts
, only_legacy
);
284 if (! helper
. removeModules
) return ;
285 console
. log ( `Cleaning up temporary files...` );
286 return Promise
. all ( outFiles
. map ( filepath
=> {
289 // Try to clean up any empty directories if this
290 // was the last file in there
291 const rmdir_r
= dir
=> {
293 . then (() => rmdir_r ( path
. dirname ( dir
)))
295 // Assume the error was ENOTEMPTY and ignore it
298 return rmdir_r ( path
. dirname ( filepath
));
304 console
. error ( `Failure converting modules: ${err} ` );
310 console
. log ( `Removing ${paths.lib_dir_base} ` );
311 fse
. removeSync ( paths
. lib_dir_base
);
313 console
. log ( `Removing ${paths.out_dir_base} ` );
314 fse
. removeSync ( paths
. out_dir_base
);
317 make_lib_files ( program
. as
, program
. withSourceMaps
, program
. withApp
, program
. onlyLegacy
);