Skip to content

Commit

Permalink
feat(compiler): moves autoDefineCustomElements to an export behavior (
Browse files Browse the repository at this point in the history
#3615)

This commit moves `autoDefineCustomElements` from a config flag to a `customElementsExportBehavior` option on the `dist-custom-elements` output target. This prevents treeshaking issues that were possible when barrel exporting and this option were both enabled.

This is some initial work before we move into STENCIL-457
  • Loading branch information
tanner-reits authored and rwaskiewicz committed Oct 3, 2022
1 parent 48e8428 commit 89c25e9
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 10 deletions.
4 changes: 2 additions & 2 deletions src/cli/telemetry/test/telemetry.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,7 @@ describe('anonymizeConfigForTelemetry', () => {
outputTargets: [
{ type: WWW, baseUrl: 'https://example.com' },
{ type: DIST_HYDRATE_SCRIPT, external: ['beep', 'boop'], dir: 'shoud/go/away' },
{ type: DIST_CUSTOM_ELEMENTS, autoDefineCustomElements: false },
{ type: DIST_CUSTOM_ELEMENTS },
{ type: DIST_CUSTOM_ELEMENTS, generateTypeDeclarations: true },
{ type: DIST, typesDir: 'my-types' },
],
Expand All @@ -271,7 +271,7 @@ describe('anonymizeConfigForTelemetry', () => {
expect(anonymizedConfig.outputTargets).toEqual([
{ type: WWW, baseUrl: 'omitted' },
{ type: DIST_HYDRATE_SCRIPT, external: ['beep', 'boop'], dir: 'omitted' },
{ type: DIST_CUSTOM_ELEMENTS, autoDefineCustomElements: false },
{ type: DIST_CUSTOM_ELEMENTS },
{ type: DIST_CUSTOM_ELEMENTS, generateTypeDeclarations: true },
{ type: DIST, typesDir: 'omitted' },
]);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ export const addDefineCustomElementFunctions = (
setupComponentDependencies(moduleFile, components, newStatements, caseStatements, tagNames);
addDefineCustomElementFunction(tagNames, newStatements, caseStatements);

if (outputTarget.autoDefineCustomElements) {
if (outputTarget.customElementsExportBehavior === 'auto-define-custom-elements') {
const conditionalDefineCustomElementCall = createAutoDefinitionExpression(
principalComponent.componentClassName
);
Expand Down
15 changes: 8 additions & 7 deletions src/declarations/stencil-public-compiler.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2027,9 +2027,16 @@ export interface OutputTargetBaseNext {
* output target configuration for `customElementsExportBehavior`.
*
* - `default`: No additional export or definition behavior will happen.
* - `auto-define-custom-elements`: Enables the auto-definition of a component and its children (recursively) in the custom elements registry. This
* functionality allows consumers to bypass the explicit call to define a component, its children, its children's
* children, etc. Users of this flag should be aware that enabling this functionality may increase bundle size.
* - `single-export-module`: All components will be re-exported from the specified directory's root `index.js` file.
*/
export const CustomElementsExportBehaviorOptions = ['default', 'single-export-module'] as const;
export const CustomElementsExportBehaviorOptions = [
'default',
'auto-define-custom-elements',
'single-export-module',
] as const;

/**
* This type is auto-generated based on the values in `CustomElementsExportBehaviorOptions` array.
Expand All @@ -2045,12 +2052,6 @@ export interface OutputTargetDistCustomElements extends OutputTargetBaseNext {
inlineDynamicImports?: boolean;
includeGlobalScripts?: boolean;
minify?: boolean;
/**
* Enables the auto-definition of a component and its children (recursively) in the custom elements registry. This
* functionality allows consumers to bypass the explicit call to define a component, its children, its children's
* children, etc. Users of this flag should be aware that enabling this functionality may increase bundle size.
*/
autoDefineCustomElements?: boolean;
/**
* Enables the generation of type definition files for the output target.
*/
Expand Down

0 comments on commit 89c25e9

Please sign in to comment.