remove assetsDir backwards compatibility #3341

alicewriteswrongs · 2022-04-20T20:47:45Z

Pull request checklist

Please check if your PR fulfills the following requirements:

Tests for the changes have been added (for bug fixes / features)
Docs have been reviewed and added / updated if needed (for bug fixes / features)
Build (npm run build) was run locally and any changes were pushed
Unit tests (npm test) were run locally and passed
E2E Tests (npm run test.karma.prod) were run locally and passed
Prettier (npm run prettier) was run locally and passed

Pull request type

Please check the type of change your PR introduces:

Bugfix
Feature
Refactoring (no functional changes, no api changes)
Build related changes
Documentation content changes
Other (please describe): removing backwards compatibility for a deprecated parameter

What is the current behavior?

GitHub Issue Number: N/A

Right now we have backwards compatibility for the assetsDir option by converting it under the hood from string to string[] and setting it on assetsDirs. This removes that, since the param has been deprecated for quite some time now.

What is the new behavior?

It will no longer allow the backwards compatibility.

Does this introduce a breaking change?

Yes
No

Users will need to remove any assetsDir props passed in to the @Component decorator, and migrate to assetsDirs instead.

Testing

I ran the unit tests and also installed this into a test component repo to verify that things are working alright

Other information

The `assetsDir` option for the `@Component` decorator was deprecated some time ago in favor of the `assetsDirs` option, but we have retained backwards-compatibility with the old option nonetheless. This commit removes that backwards compatibility. STENCIL-410: Remove Backwards Compatibility for assetDir Field on @component BREAKING CHANGE: setting `assetsDir` on a component will no longer work. Users should migrate to `assetsDirs` instead.

rwaskiewicz · 2022-04-20T23:28:19Z

src/compiler/transformers/decorators-to-static/component-decorator.ts

+  if (isString((componentOptions as any).assetsDirs)) {
+    const error = buildError(diagnostics);
+    error.messageText = `@Component option "assetsDir" is no longer supported. "assetsDirs" should be used instead.`
+    augmentDiagnosticWithNode(error, componentDecorator)
  }


We may be able to delete this conditional in its entirety. ATM, assetsDirs is typed as a string[]:

/** * Array of relative links to folders of assets required by the component. */ assetsDirs?: string[];

I think if folks are still using it as a string literal, we can lean on the TS type checker to yell at them. Thoughts?

I meant to leave a review comment on this but forgot - my thought initially was to just remove the whole conditional, but I wasn't sure if we wanted to try to have some sort of last-ditch error throwing deprecation warning. But I'm for removing it entirely if you think that makes sense :)

Yeah, I think it's acceptable at this point from a usability standpoint. assetsDir: string was deprecated in v2.0.0, so I'd argue folks have definitely had enough time to migrate to assetsDir: string[]

In #3341 we removed backwards compatibility for the deprecated `assetsDir` component decorator prop. This updates the BREAKING_CHANGES document to reflect that change. STENCIL-410: Remove Backwards Compatibility for assetDir Field on @component