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.

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

Deconflict shared helpers with user imports #306

Merged
merged 5 commits into from
Feb 28, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 0 additions & 1 deletion src/generators/Generator.js
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,6 @@ export default class Generator {
while ( /[ \t]/.test( source[ a - 1 ] ) ) a -= 1;
while ( source[b] === '\n' ) b += 1;

//imports.push( source.slice( a, b ).replace( /^\s/, '' ) );
imports.push( node );
this.code.remove( a, b );
}
Expand Down
74 changes: 46 additions & 28 deletions src/generators/dom/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,11 @@ class DomGenerator extends Generator {
super( parsed, source, names, visitors );
this.renderers = [];
this.uses = {};

// allow compiler to deconflict user's `import { get } from 'whatever'` and
// Svelte's builtin `import { get, ... } from 'svelte/shared.js'`;
this.importedNames = {};
this.aliases = {};
}

addElement ( name, renderStatement, needsIdentifier = false ) {
Expand All @@ -23,13 +28,11 @@ class DomGenerator extends Generator {

this.createMountStatement( name );
} else {
this.uses.appendNode = true;
this.current.builders.init.addLine( `appendNode( ${renderStatement}, ${this.current.target} );` );
this.current.builders.init.addLine( `${this.helper( 'appendNode' )}( ${renderStatement}, ${this.current.target} );` );
}

if ( isToplevel ) {
this.uses.detachNode = true;
this.current.builders.detach.addLine( `detachNode( ${name} );` );
this.current.builders.detach.addLine( `${this.helper( 'detachNode' )}( ${name} );` );
}
}

Expand All @@ -55,8 +58,7 @@ class DomGenerator extends Generator {
if ( fragment.key ) properties.addBlock( `key: key,` );

if ( fragment.builders.mount.isEmpty() ) {
this.uses.noop = true;
properties.addBlock( `mount: noop,` );
properties.addBlock( `mount: ${this.helper( 'noop' )},` );
} else {
properties.addBlock( deindent`
mount: function ( target, anchor ) {
Expand All @@ -66,8 +68,7 @@ class DomGenerator extends Generator {
}

if ( fragment.builders.update.isEmpty() ) {
this.uses.noop = true;
properties.addBlock( `update: noop,` );
properties.addBlock( `update: ${this.helper( 'noop' )},` );
} else {
properties.addBlock( deindent`
update: function ( changed, ${fragment.params} ) {
Expand All @@ -79,8 +80,7 @@ class DomGenerator extends Generator {
}

if ( fragment.builders.teardown.isEmpty() ) {
this.uses.noop = true;
properties.addBlock( `teardown: noop,` );
properties.addBlock( `teardown: ${this.helper( 'noop' )},` );
} else {
properties.addBlock( deindent`
teardown: function ( detach ) {
Expand All @@ -101,18 +101,15 @@ class DomGenerator extends Generator {
}

createAnchor ( name ) {
this.uses.createComment = true;
const renderStatement = `createComment()`;
const renderStatement = `${this.helper( 'createComment' )}()`;
this.addElement( name, renderStatement, true );
}

createMountStatement ( name ) {
if ( this.current.target === 'target' ) {
this.uses.insertNode = true;
this.current.builders.mount.addLine( `insertNode( ${name}, target, anchor );` );
this.current.builders.mount.addLine( `${this.helper( 'insertNode' )}( ${name}, target, anchor );` );
} else {
this.uses.appendNode = true;
this.current.builders.init.addLine( `appendNode( ${name}, ${this.current.target} );` );
this.current.builders.init.addLine( `${this.helper( 'appendNode' )}( ${name}, ${this.current.target} );` );
}
}

Expand All @@ -133,6 +130,22 @@ class DomGenerator extends Generator {
// unset the children, to avoid them being visited again
node.children = [];
}

helper ( name ) {
this.uses[ name ] = true;

if ( !( name in this.aliases ) ) {
let alias = name;
let i = 1;
while ( alias in this.importedNames ) {
alias = `${name}$${i++}`;
}

this.aliases[ name ] = alias;
}

return this.aliases[ name ];
}
}

export default function dom ( parsed, source, options, names ) {
Expand All @@ -143,6 +156,12 @@ export default function dom ( parsed, source, options, names ) {

const { computations, templateProperties } = generator.parseJs();

generator.imports.forEach( node => {
node.specifiers.forEach( specifier => {
generator.importedNames[ specifier.local.name ] = true;
});
});

let namespace = null;
if ( templateProperties.namespace ) {
const ns = templateProperties.namespace.value;
Expand Down Expand Up @@ -214,15 +233,12 @@ export default function dom ( parsed, source, options, names ) {
}

if ( parsed.css && options.css !== false ) {
generator.uses.appendNode = true;
generator.uses.createElement = true;

builders.main.addBlock( deindent`
let addedCss = false;
function addCss () {
var style = createElement( 'style' );
var style = ${generator.helper( 'createElement' )}( 'style' );
style.textContent = ${JSON.stringify( processCss( parsed, generator.code ) )};
appendNode( style, document.head );
${generator.helper( 'appendNode' )}( style, document.head );

addedCss = true;
}
Expand Down Expand Up @@ -305,12 +321,12 @@ export default function dom ( parsed, source, options, names ) {

builders.main.addBlock( sharedPath ?
deindent`
${name}.prototype.get = get;
${name}.prototype.fire = fire;
${name}.prototype.observe = observe;
${name}.prototype.on = on;
${name}.prototype.set = set;
${name}.prototype._flush = _flush;
${name}.prototype.get = ${generator.helper( 'get' )};
${name}.prototype.fire = ${generator.helper( 'fire' )};
${name}.prototype.observe = ${generator.helper( 'observe' )};
${name}.prototype.on = ${generator.helper( 'on' )};
${name}.prototype.set = ${generator.helper( 'set' )};
${name}.prototype._flush = ${generator.helper( '_flush' )};
` :
deindent`
${name}.prototype.get = ${shared.get};
Expand Down Expand Up @@ -347,7 +363,9 @@ export default function dom ( parsed, source, options, names ) {
throw new Error( `Components with shared helpers must be compiled to ES2015 modules (format: 'es')` );
}

const names = [ 'get', 'fire', 'observe', 'on', 'set', '_flush', 'dispatchObservers' ].concat( Object.keys( generator.uses ) );
const names = [ 'get', 'fire', 'observe', 'on', 'set', '_flush', 'dispatchObservers' ].concat( Object.keys( generator.uses ) )
.map( name => name in generator.aliases ? `${name} as ${generator.aliases[ name ]}` : name );

builders.main.addLineAtStart(
`import { ${names.join( ', ' )} } from ${JSON.stringify( sharedPath )}`
);
Expand Down
3 changes: 1 addition & 2 deletions src/generators/dom/visitors/EachBlock.js
Original file line number Diff line number Diff line change
Expand Up @@ -151,9 +151,8 @@ export default {
` );
}

generator.uses.teardownEach = true;
generator.current.builders.teardown.addBlock(
`teardownEach( ${iterations}, ${isToplevel ? 'detach' : 'false'} );` );
`${generator.helper( 'teardownEach' )}( ${iterations}, ${isToplevel ? 'detach' : 'false'} );` );

if ( node.else ) {
generator.current.builders.teardown.addBlock( deindent`
Expand Down
12 changes: 4 additions & 8 deletions src/generators/dom/visitors/Element.js
Original file line number Diff line number Diff line change
Expand Up @@ -61,25 +61,21 @@ export default {

if ( local.namespace ) {
if ( local.namespace === 'http://www.w3.org/2000/svg' ) {
generator.uses.createSvgElement = true;
render = `var ${name} = createSvgElement( '${node.name}' )`;
render = `var ${name} = ${generator.helper( 'createSvgElement' )}( '${node.name}' )`;
} else {
render = `var ${name} = document.createElementNS( '${local.namespace}', '${node.name}' );`;
}
} else {
generator.uses.createElement = true;
render = `var ${name} = createElement( '${node.name}' );`;
render = `var ${name} = ${generator.helper( 'createElement' )}( '${node.name}' );`;
}

if ( generator.cssId && !generator.elementDepth ) {
generator.uses.setAttribute = true;
render += `\nsetAttribute( ${name}, '${generator.cssId}', '' );`;
render += `\n${generator.helper( 'setAttribute' )}( ${name}, '${generator.cssId}', '' );`;
}

local.init.addLineAtStart( render );
if ( isToplevel ) {
generator.uses.detachNode = true;
generator.current.builders.detach.addLine( `detachNode( ${name} );` );
generator.current.builders.detach.addLine( `${generator.helper( 'detachNode' )}( ${name} );` );
}

// special case – bound <option> without a value attribute
Expand Down
3 changes: 1 addition & 2 deletions src/generators/dom/visitors/MustacheTag.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@ export default {
const { snippet } = generator.contextualise( node.expression );

generator.current.builders.init.addLine( `var last_${name} = ${snippet}` );
generator.addElement( name, `createText( last_${name} )`, true );
generator.uses.createText = true;
generator.addElement( name, `${generator.helper( 'createText' )}( last_${name} )`, true );

generator.current.builders.update.addBlock( deindent`
if ( ( __tmp = ${snippet} ) !== last_${name} ) {
Expand Down
9 changes: 3 additions & 6 deletions src/generators/dom/visitors/RawMustacheTag.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,17 @@ export default {

// we would have used comments here, but the `insertAdjacentHTML` api only
// exists for `Element`s.
generator.uses.createElement = true;

const before = `${name}_before`;
generator.addElement( before, `createElement( 'noscript' )`, true );
generator.addElement( before, `${generator.helper( 'createElement' )}( 'noscript' )`, true );

const after = `${name}_after`;
generator.addElement( after, `createElement( 'noscript' )`, true );
generator.addElement( after, `${generator.helper( 'createElement' )}( 'noscript' )`, true );

const isToplevel = generator.current.localElementDepth === 0;

generator.current.builders.init.addLine( `var last_${name} = ${snippet};` );
const mountStatement = `${before}.insertAdjacentHTML( 'afterend', last_${name} );`;
generator.uses.detachBetween = true;
const detachStatement = `detachBetween( ${before}, ${after} );`;
const detachStatement = `${generator.helper( 'detachBetween' )}( ${before}, ${after} );`;

if ( isToplevel ) {
generator.current.builders.mount.addLine( mountStatement );
Expand Down
4 changes: 1 addition & 3 deletions src/generators/dom/visitors/Text.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ export default {
}

const name = generator.current.getUniqueName( `text` );
generator.addElement( name, `createText( ${JSON.stringify( node.data )} )`, false );

generator.uses.createText = true;
generator.addElement( name, `${generator.helper( 'createText' )}( ${JSON.stringify( node.data )} )`, false );
}
};
23 changes: 8 additions & 15 deletions src/generators/dom/visitors/attributes/addElementAttributes.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ export default function addElementAttributes ( generator, node, local ) {
// xlink is a special case... we could maybe extend this to generic
// namespaced attributes but I'm not sure that's applicable in
// HTML5?
const helper = isXlink ? 'setXlinkAttribute' : 'setAttribute';
const method = isXlink ? 'setXlinkAttribute' : 'setAttribute';

if ( attribute.value === true ) {
// attributes without values, e.g. <textarea readonly>
Expand All @@ -30,9 +30,8 @@ export default function addElementAttributes ( generator, node, local ) {
`${local.name}.${propertyName} = true;`
);
} else {
generator.uses[ helper ] = true;
local.init.addLine(
`${helper}( ${local.name}, '${name}', true );`
`${generator.helper( method )}( ${local.name}, '${name}', true );`
);
}

Expand All @@ -48,9 +47,8 @@ export default function addElementAttributes ( generator, node, local ) {
`${local.name}.${propertyName} = '';`
);
} else {
generator.uses[ helper ] = true;
local.init.addLine(
`${helper}( ${local.name}, '${name}', '' );`
`${generator.helper( method )}( ${local.name}, '${name}', '' );`
);
}
}
Expand Down Expand Up @@ -79,9 +77,8 @@ export default function addElementAttributes ( generator, node, local ) {
}

if ( addAttribute ) {
generator.uses[ helper ] = true;
local.init.addLine(
`${helper}( ${local.name}, '${name}', ${result} );`
`${generator.helper( method )}( ${local.name}, '${name}', ${result} );`
);
}
}
Expand All @@ -99,8 +96,7 @@ export default function addElementAttributes ( generator, node, local ) {
if ( propertyName ) {
updater = `${local.name}.${propertyName} = ${last};`;
} else {
generator.uses[ helper ] = true;
updater = `${helper}( ${local.name}, '${name}', ${last} );`; // TODO use snippet both times – see note below
updater = `${generator.helper( method )}( ${local.name}, '${name}', ${last} );`; // TODO use snippet both times – see note below
}

local.init.addLine( updater );
Expand Down Expand Up @@ -133,8 +129,7 @@ export default function addElementAttributes ( generator, node, local ) {
if (propertyName) {
updater = `${local.name}.${propertyName} = ${value};`;
} else {
generator.uses[ helper ] = true;
updater = `${helper}( ${local.name}, '${name}', ${value} );`;
updater = `${generator.helper( method )}( ${local.name}, '${name}', ${value} );`;
}

local.init.addLine( updater );
Expand Down Expand Up @@ -194,18 +189,16 @@ export default function addElementAttributes ( generator, node, local ) {
${handlerName}.teardown();
` );
} else {
generator.uses.addEventListener = true;
generator.uses.removeEventListener = true;
local.init.addBlock( deindent`
function ${handlerName} ( event ) {
${handlerBody}
}

addEventListener( ${local.name}, '${name}', ${handlerName} );
${generator.helper( 'addEventListener' )}( ${local.name}, '${name}', ${handlerName} );
` );

generator.current.builders.teardown.addLine( deindent`
removeEventListener( ${local.name}, '${name}', ${handlerName} );
${generator.helper( 'removeEventListener' )}( ${local.name}, '${name}', ${handlerName} );
` );
}
}
Expand Down
6 changes: 2 additions & 4 deletions src/generators/dom/visitors/attributes/binding/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -138,8 +138,6 @@ export default function createBinding ( generator, node, attribute, current, loc
updateElement = `${local.name}.${attribute.name} = ${contextual ? attribute.value : `root.${attribute.value}`};`;
}

generator.uses.addEventListener = true;
generator.uses.removeEventListener = true;
local.init.addBlock( deindent`
var ${local.name}_updating = false;

Expand All @@ -149,7 +147,7 @@ export default function createBinding ( generator, node, attribute, current, loc
${local.name}_updating = false;
}

addEventListener( ${local.name}, '${eventName}', ${handler} );
${generator.helper( 'addEventListener' )}( ${local.name}, '${eventName}', ${handler} );
` );

node.initialUpdate = updateElement;
Expand All @@ -159,7 +157,7 @@ export default function createBinding ( generator, node, attribute, current, loc
);

generator.current.builders.teardown.addLine( deindent`
removeEventListener( ${local.name}, '${eventName}', ${handler} );
${generator.helper( 'removeEventListener' )}( ${local.name}, '${eventName}', ${handler} );
` );
}
}
2 changes: 1 addition & 1 deletion test/generate.js
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ describe( 'generate', () => {

try {
const source = fs.readFileSync( `test/generator/${dir}/main.html`, 'utf-8' );
compiled = svelte.compile( source );
compiled = svelte.compile( source, compileOptions );
} catch ( err ) {
if ( config.compileError ) {
config.compileError( err );
Expand Down
8 changes: 8 additions & 0 deletions test/generator/deconflict-builtins/_config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
export default {
html: `<span>got</span>`,

test ( assert, component ) {
assert.equal( component.get( 'foo' ), 'got' );
component.teardown();
}
};
3 changes: 3 additions & 0 deletions test/generator/deconflict-builtins/get.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
export default function get () {
return 'got';
}
Loading