Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

JSM: Add Canonical Modules White List #15599

Closed
wants to merge 9 commits into from
Closed

JSM: Add Canonical Modules White List #15599

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
9756da9
Add check to modularize and rollup config to determine whether or not…
gkjohnson Jan 17, 2019
f502fa8
Fix banner text
gkjohnson Jan 17, 2019
14c92f7
Merge remote-tracking branch 'mrdoob-origin/dev' into canonical-modules
gkjohnson Mar 15, 2019
4eab62b
Merge remote-tracking branch 'mrdoob-origin/dev' into canonical-modules
gkjohnson Mar 15, 2019
a75fd01
Merge remote-tracking branch 'mrdoob-origin/dev' into canonical-modules
gkjohnson Mar 27, 2019
c90f730
Simplify rollup config, make it more like modularize.js
gkjohnson Mar 27, 2019
44098be
Remove isModuleCanonical
gkjohnson Mar 27, 2019
31d26f5
comment out list of files
gkjohnson Mar 27, 2019
15dcbf9
fix external references
gkjohnson Mar 27, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 47 additions & 15 deletions rollup-examples.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,31 @@
/**
* @author Garrett Johnson / http://gkjohnson.github.io/
*/

var path = require( 'path' );
var fs = require( 'fs' );

var srcFolder = __dirname + '/examples/jsm/';
var dstFolder = __dirname + '/examples/js/';

var files = [
// { path: /postprocessing[\/\\].+\.js$/ },
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No files are converted at the moment (so rollup will throw an error) but they can be added in future PRs. You can use rollup to convert the files in the jsm/controls folder by changing this to:

var files = [
	{ path: /controls[\/\\].+\.js$/ }
];

// { path: /controls[\/\\].+\.js$/ }
];

// Creates a rollup config object for the given file to
// be converted to umd
function createOutput( file ) {
function createOutput( inputPath ) {

var inputPath = path.resolve( file );
var outputPath = inputPath.replace( /[\\\/]examples[\\\/]jsm[\\\/]/, '/examples/js/' );
var relativePath = path.relative( srcFolder, inputPath );
var outputPath = path.join( dstFolder, relativePath );

var banner = [
'/**',
` * Generated from original source in "examples/jsm/${ relativePath.replace( /\\/g, '/' ) }".`,
' * Not intended for editing.',
' */'
].join( '\n' );

// 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
Expand All @@ -15,7 +34,7 @@ function createOutput( file ) {

input: inputPath,
treeshake: false,
external: p => p !== inputPath,
external: p => inputPath !== p,

plugins: [ {

Expand All @@ -41,10 +60,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

}
Expand All @@ -54,11 +70,11 @@ function createOutput( file ) {
}

// Walk the file structure starting at the given directory and fire
// the callback for every js file.
// the callback for every file found.
function walk( dir, cb ) {

var files = fs.readdirSync( dir );
files.forEach( f => {
var dirFiles = fs.readdirSync( dir );
dirFiles.forEach( f => {

var p = path.join( dir, f );
var stats = fs.statSync( p );
Expand All @@ -67,7 +83,7 @@ function walk( dir, cb ) {

walk( p, cb );

} else if ( f.endsWith( '.js' ) ) {
} else {

cb( p );

Expand All @@ -78,8 +94,24 @@ function walk( dir, cb ) {
}

// Gather up all the files
var files = [];
walk( 'examples/jsm/', p => files.push( p ) );
var configs = [];
walk( srcFolder, function ( p ) {

for ( var i = 0; i < files.length; i ++ ) {

var file = files[ i ];
if ( file.path.test( p ) ) {

// create a rollup config if the file matches one
// of the path regex
configs.push( createOutput( p ) );
break;

}

}

} );

// Create a rollup config for each module.js file
export default files.map( p => createOutput( p ) );
export default configs;
11 changes: 9 additions & 2 deletions utils/modularize.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,14 @@ for ( var i = 0; i < files.length; i ++ ) {

function convert( path, ignoreList ) {

var banner = [
'/**',
` * Generated from original source in "examples/js/${ path.replace( /\\/g, '/' ) }".`,
' * Not intended for editing.',
' */',
''
].join( '\n' );

var contents = fs.readFileSync( srcFolder + path, 'utf8' );

var className = '';
Expand Down Expand Up @@ -133,8 +141,7 @@ function convert( path, ignoreList ) {
.toString();
var imports = `import {${keys}\n} from "../../../build/three.module.js";`;
var exports = `export { ${className} };\n`;

var output = contents.replace( '_IMPORTS_', keys ? imports : '' ) + '\n' + exports;
var output = banner + contents.replace( '_IMPORTS_', keys ? imports : '' ) + '\n' + exports;

// console.log( output );

Expand Down