fix(compiler): deprecate scriptDataOpts (#5737)

* fix(compiler): deprecate scriptDataOpts STENCIL-665 * Update src/declarations/stencil-public-compiler.ts Co-authored-by: Alice Pote <alice.writes.wrongs@gmail.com> --------- Co-authored-by: Alice Pote <alice.writes.wrongs@gmail.com>
ionic-team · May 8, 2024 · da25aaa · da25aaa
1 parent b0a9f7b
commit da25aaa
Show file tree

Hide file tree

Showing 6 changed files with 6 additions and 0 deletions.
diff --git a/src/app-data/index.ts b/src/app-data/index.ts
@@ -88,6 +88,7 @@ export const BUILD: BuildConditionals = {
   cloneNodeFix: false,
   hydratedAttribute: false,
   hydratedClass: true,
+  // TODO(STENCIL-1305): remove this option
   scriptDataOpts: false,
   // TODO(STENCIL-914): remove this option when `experimentalSlotFixes` is the default behavior
   scopedSlotTextContentFix: false,

diff --git a/src/compiler/app-core/app-data.ts b/src/compiler/app-core/app-data.ts
@@ -176,6 +176,7 @@ export const updateBuildConditionals = (config: ValidatedConfig, b: BuildConditi
   b.lifecycleDOMEvents = !!(b.isDebug || config._isTesting || config.extras.lifecycleDOMEvents);
   // TODO(STENCIL-914): remove this option when `experimentalSlotFixes` is the default behavior
   b.scopedSlotTextContentFix = !!config.extras.scopedSlotTextContentFix;
+  // TODO(STENCIL-1305): remove this option
   b.scriptDataOpts = config.extras.scriptDataOpts;
   b.attachStyles = true;
   b.invisiblePrehydration = typeof config.invisiblePrehydration === 'undefined' ? true : config.invisiblePrehydration;

diff --git a/src/compiler/output-targets/dist-hydrate-script/hydrate-build-conditionals.ts b/src/compiler/output-targets/dist-hydrate-script/hydrate-build-conditionals.ts
@@ -34,6 +34,7 @@ export const getHydrateBuildConditionals = (cmps: d.ComponentCompilerMeta[]) =>
   build.shadowDomShim = true;
   build.hydratedAttribute = false;
   build.hydratedClass = true;
+  // TODO(STENCIL-1305): remove this option
   build.scriptDataOpts = false;
   build.attachStyles = true;
 

diff --git a/src/declarations/stencil-private.ts b/src/declarations/stencil-private.ts
@@ -181,6 +181,7 @@ export interface BuildConditionals extends Partial<BuildFeatures> {
   hydratedAttribute?: boolean;
   hydratedClass?: boolean;
   initializeNextTick?: boolean;
+  // TODO(STENCIL-1305): remove this option
   scriptDataOpts?: boolean;
   // TODO(STENCIL-854): Remove code related to legacy shadowDomShim field
   shadowDomShim?: boolean;

diff --git a/src/declarations/stencil-public-compiler.ts b/src/declarations/stencil-public-compiler.ts
@@ -328,6 +328,7 @@ interface ConfigExtrasBase {
    * It is possible to assign data to the actual `<script>` element's `data-opts` property,
    * which then gets passed to Stencil's initial bootstrap. This feature is only required
    * for very special cases and rarely needed. Defaults to `false`.
+   * @deprecated This option has been deprecated and will be removed in a future major version of Stencil.
    */
   scriptDataOpts?: boolean;
 

diff --git a/src/testing/reset-build-conditionals.ts b/src/testing/reset-build-conditionals.ts
@@ -50,6 +50,7 @@ export function resetBuildConditionals(b: d.BuildConditionals) {
   b.appendChildSlotFix = false;
   b.cloneNodeFix = false;
   b.hotModuleReplacement = false;
+  // TODO(STENCIL-1305): remove this option
   b.scriptDataOpts = false;
   // TODO(STENCIL-914): remove this option when `experimentalSlotFixes` is the default behavior
   b.scopedSlotTextContentFix = false;