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

fix(compiler): fix generated import statement #5419

Merged
merged 5 commits into from
Mar 6, 2024

Conversation

christian-bromann
Copy link
Member

@christian-bromann christian-bromann commented Feb 28, 2024

What is the current behavior?

If you have a plain component like this:

@Component({
  tag: 'my-component',
  // styleUrl: 'my-component.css',
  shadow: true,
})
export class MyComponent {
  /**
   * The first name
   */
  first: string;
}

and try to export it via:

{
  type: 'dist-custom-elements',
  customElementsExportBehavior: 'single-export-module'
},

the compiler will fail with:

[ ERROR ]  Rollup: Parse Error
           Unexpected token (Note that you need plugins to import files that are not
           JavaScript) 2: export { getAssetPath, setAssetPath, setNonce,
           setPlatformOptions } from '@stencil/core/internal/client'; 3: export * from
           '@user-index-entrypoint'; 4: export { {MyComponent } from 'MyComponent'; ^ 5:
           6: globalScripts();

The change was originally introduced here: https://github.com/ionic-team/stencil/pull/3368/files#diff-df2741ac09fef4bbb750d864b2b96bdc4f8e649f347c7cc7def8edc977e1004eR198 and seems to be not intentional.

What is the new behavior?

Removed the additional bracket.

Documentation

n/a

Does this introduce a breaking change?

  • Yes
  • No

Testing

I added a unit test for this particular use case.

Other information

n/a

Copy link
Contributor

github-actions bot commented Feb 28, 2024

--strictNullChecks error report

Typechecking with --strictNullChecks resulted in 1144 errors on this branch.

Unfortunately, it looks like that's an increase of 5 over main 😞.

Violations Not on `main` (may be more than the count above)
Path Location Error Message
src/compiler/output-targets/dist-custom-elements/test/dist-custom-elements.spec.ts (24, 12) TS18048
src/compiler/output-targets/dist-custom-elements/test/dist-custom-elements.spec.ts (25, 12) TS18048
src/compiler/output-targets/dist-custom-elements/test/dist-custom-elements.spec.ts (43, 12) TS18048
src/compiler/output-targets/dist-custom-elements/test/dist-custom-elements.spec.ts (44, 12) TS18048
src/compiler/output-targets/dist-custom-elements/test/dist-custom-elements.spec.ts (47, 12) TS18048

reports and statistics

Our most error-prone files
Path Error Count
src/dev-server/index.ts 37
src/dev-server/server-process.ts 32
src/compiler/prerender/prerender-main.ts 22
src/testing/puppeteer/puppeteer-element.ts 22
src/runtime/client-hydrate.ts 20
src/screenshot/connector-base.ts 19
src/runtime/vdom/vdom-render.ts 17
src/dev-server/request-handler.ts 15
src/compiler/prerender/prerender-optimize.ts 14
src/compiler/sys/stencil-sys.ts 14
src/compiler/transpile/transpile-module.ts 14
src/sys/node/node-sys.ts 14
src/compiler/prerender/prerender-queue.ts 13
src/compiler/sys/in-memory-fs.ts 13
src/runtime/connected-callback.ts 13
src/runtime/set-value.ts 13
src/compiler/output-targets/output-www.ts 12
src/compiler/transformers/test/parse-vdom.spec.ts 12
src/compiler/transformers/transform-utils.ts 12
src/mock-doc/test/attribute.spec.ts 12
Our most common errors
Typescript Error Code Count
TS2322 361
TS2345 349
TS18048 206
TS18047 82
TS2722 37
TS2532 24
TS2531 21
TS2454 14
TS2790 11
TS2352 10
TS2769 8
TS2538 8
TS2416 6
TS2493 3
TS18046 2
TS2684 1
TS2430 1

Unused exports report

There are 14 unused exports on this PR. That's the same number of errors on main, so at least we're not creating new ones!

Unused exports
File Line Identifier
src/runtime/bootstrap-lazy.ts 21 setNonce
src/screenshot/screenshot-fs.ts 18 readScreenshotData
src/testing/testing-utils.ts 198 withSilentWarn
src/utils/index.ts 145 CUSTOM
src/utils/index.ts 269 normalize
src/utils/index.ts 7 escapeRegExpSpecialCharacters
src/compiler/app-core/app-data.ts 25 BUILD
src/compiler/app-core/app-data.ts 115 Env
src/compiler/app-core/app-data.ts 117 NAMESPACE
src/compiler/fs-watch/fs-watch-rebuild.ts 123 updateCacheFromRebuild
src/compiler/types/validate-primary-package-output-target.ts 61 satisfies
src/compiler/types/validate-primary-package-output-target.ts 61 Record
src/testing/puppeteer/puppeteer-declarations.ts 485 WaitForEventOptions
src/compiler/sys/fetch/write-fetch-success.ts 7 writeFetchSuccessSync

Copy link
Contributor

github-actions bot commented Feb 28, 2024

PR built and packed!

Download the tarball here: https://github.com/ionic-team/stencil/actions/runs/8164820967/artifacts/1300436663

If your browser saves files to ~/Downloads you can install it like so:

unzip -d ~/Downloads ~/Downloads/stencil-core-4.12.5-dev.1709684073.9f92876.tgz.zip && npm install ~/Downloads/stencil-core-4.12.5-dev.1709684073.9f92876.tgz

Copy link
Member

@rwaskiewicz rwaskiewicz left a comment

Choose a reason for hiding this comment

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

👍 for more tests! I had some asks around type safety, take a look at the included patch and LMK what you think

@christian-bromann
Copy link
Member Author

@rwaskiewicz thanks for the patch, good to know these primitives exist, that helps a lot. I added another test for the "non-plain" use case.

Copy link
Member

@tanner-reits tanner-reits left a comment

Choose a reason for hiding this comment

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

LGTM

@christian-bromann christian-bromann added this pull request to the merge queue Mar 6, 2024
Merged via the queue into main with commit 502da1b Mar 6, 2024
121 checks passed
@christian-bromann christian-bromann deleted the cb/fix-import-of-plain-component branch March 6, 2024 16:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants