JSM: Add Canonical Modules White List

rollup-examples.config.js

@@ -1,12 +1,30 @@
 var path = require( 'path' );
 var fs = require( 'fs' );
+var isModuleCanonical = require( './utils/isModuleCanonical.js' );
 
 // Creates a rollup config object for the given file to
 // be converted to umd
 function createOutput( file ) {
 
 	var inputPath = path.resolve( file );
 	var outputPath = inputPath.replace( /[\\\/]examples[\\\/]jsm[\\\/]/, '/examples/js/' );
+	var relativePath = path.relative( './examples/jsm', file ).replace( /^\.[\/\\]/, '' );
+
+	var banner = '';
+	if ( isModuleCanonical( relativePath ) ) {
+
+		banner = [
+			'/**',
+			` * Generated from original source in "examples/jsm/${ relativePath.replace( /\\/g, '/' ) }".`,
+			' * Not intended for editing.',
+			' */'
+		].join( '\n' );
+
+	} else {
+
+		return null;
+
+	}
 
 	// Every import is marked as external so the output is 1-to-1. We
 	// assume that that global object should be the THREE object so we
@@ -41,10 +59,7 @@ function createOutput( file ) {
 			paths: p => /three\.module\.js$/.test( p ) ? 'three' : p,
 			extend: true,
 
-			banner:
-				'/**\n' +
-				` * Generated from '${ path.relative( '.', inputPath ).replace( /\\/g, '/' ) }'\n` +
-				' */\n',
+			banner: banner,
 			esModule: false
 
 		}
@@ -82,4 +97,4 @@ var files = [];
 walk( 'examples/jsm/', p => files.push( p ) );
 
 // Create a rollup config for each module.js file
-export default files.map( p => createOutput( p ) );
+export default files.map( p => createOutput( p ) ).filter( p => p );

utils/isModuleCanonical.js

@@ -0,0 +1,34 @@
+// List of strings and regexp tests describing which
+// modules should be considered the canonical source
+var canonicalModules = [
+	/controls\/.*/
+];
+
+// takes a path relative to the jsm directory
+// 'controls/OrbitControls.js' for example
+function isModuleCanonical( p ) {
+
+	p = p.replace( /\\/g, '/' );
+
+	for ( var i in canonicalModules ) {
+
+		const name = canonicalModules[ i ];
+		if ( name instanceof RegExp && name.test( p ) ) {
+
+			return true;
+
+		}
+
+		if ( typeof name === 'string' && p === name ) {
+
+			return true;
+
+		}
+
+	}
+
+	return false;
+
+}
+
+module.exports = isModuleCanonical;

utils/modularize.js

@@ -3,6 +3,7 @@
  */
 
 var fs = require( 'fs' );
+var isModuleCanonical = require( './isModuleCanonical.js' );
 
 var srcFolder = '../examples/js/';
 var dstFolder = '../examples/jsm/';
@@ -27,6 +28,23 @@ for ( var i = 0; i < files.length; i ++ ) {
 
 function convert( path, ignoreList ) {
 
+	var banner = '';
+	if ( ! isModuleCanonical( path ) ) {
+
+		banner = [
+			'/**',
+			` * Generated from original source in "examples/js/${ path.replace( /\\/g, '/' ) }".`,
+			' * Not intended for editing.',
+			' */',
+			''
+		].join( '\n' );
+
+	} else {
+
+		return;
+
+	}
+
 	var contents = fs.readFileSync( srcFolder + path, 'utf8' );
 
 	var className = '';
@@ -84,8 +102,7 @@ function convert( path, ignoreList ) {
 	var keys = Object.keys( dependencies ).sort().map( value => '\n\t' + value ).toString();
 	var imports = `import {${keys}\n} from "../../../build/three.module.js";`;
 	var exports = `export { ${className} }`;
-
-	var output = contents.replace( '_IMPORTS_', imports ) + '\n' + exports;
+	var output = banner + contents.replace( '_IMPORTS_', imports ) + '\n' + exports;
 
 	// console.log( output );