From 2eb7409b8a4fd42f6c119adaf529146099653e2e Mon Sep 17 00:00:00 2001 From: JC Franco Date: Mon, 28 Oct 2024 13:12:19 -0700 Subject: [PATCH] deprecate: deprecate `require-event-emitter-type` rule (#10638) **Related Issue:** #10398 ## Summary Deprecates this rule for 3.x removal as it is no longer needed after #10310. --- .../docs/require-event-emitter-type.md | 2 ++ .../src/rules/require-event-emitter-type.ts | 1 + 2 files changed, 3 insertions(+) diff --git a/packages/eslint-plugin-calcite-components/docs/require-event-emitter-type.md b/packages/eslint-plugin-calcite-components/docs/require-event-emitter-type.md index cf8699cbd56..2be8f6b1ba4 100644 --- a/packages/eslint-plugin-calcite-components/docs/require-event-emitter-type.md +++ b/packages/eslint-plugin-calcite-components/docs/require-event-emitter-type.md @@ -1,5 +1,7 @@ # require-event-emitter-type +**Deprecated** This rule is deprecated and will be removed in a future release. Event typing has been improved and is no longer needed. + This rule helps enforce the payload type to `EventEmitter`s to avoid misleading `any` type on the `CustomEvent` detail object. ## Config diff --git a/packages/eslint-plugin-calcite-components/src/rules/require-event-emitter-type.ts b/packages/eslint-plugin-calcite-components/src/rules/require-event-emitter-type.ts index f6b491aef34..5a277fb78fb 100644 --- a/packages/eslint-plugin-calcite-components/src/rules/require-event-emitter-type.ts +++ b/packages/eslint-plugin-calcite-components/src/rules/require-event-emitter-type.ts @@ -3,6 +3,7 @@ import { stencilComponentContext } from "stencil-eslint-core"; const rule: Rule.RuleModule = { meta: { + deprecated: true, docs: { description: "This rule helps enforce the payload type to EventEmitters to avoid misleading `any` type on the CustomEvent detail object.",