From f5c2b594773c4a7bed5078ea7a52528e97d9ffb9 Mon Sep 17 00:00:00 2001
From: 43081j <43081j@users.noreply.github.com>
Date: Tue, 1 Aug 2023 22:38:01 +0100
Subject: [PATCH] docs (no-exports-with-element): add docs

Adds docs migrated from the custom elements plugin for the
`no-exports-with-element` rule.
---
 docs/rules/no-exports-with-element.md | 58 +++++++++++++++++++++++++++
 1 file changed, 58 insertions(+)
 create mode 100644 docs/rules/no-exports-with-element.md

diff --git a/docs/rules/no-exports-with-element.md b/docs/rules/no-exports-with-element.md
new file mode 100644
index 0000000..4f46b1d
--- /dev/null
+++ b/docs/rules/no-exports-with-element.md
@@ -0,0 +1,58 @@
+# Disallows exports alongside custom element exports (no-exports-with-element)
+
+It's possible to export multiple functions and classes in a JavaScript file.
+In the case of Custom Elements, exporting more than the Custom Element itself
+can cause confusion when importing code. It may also be a sign that there is
+too much code in a single file. If you have utility functions that the Custom
+Element depends on, it might be worth splitting this out into a separate file.
+
+## Rule Details
+
+This rule disallows exports (other than the element class and event subclasses)
+in a file with a Custom Element.
+
+👎 Examples of **incorrect** code for this rule:
+
+```js
+// foo-bar-element.js
+export class FooBarElement extends HTMLElement {
+  // ...
+}
+
+export function myHelper() {
+  // ...
+}
+```
+
+👍 Examples of **correct** code for this rule:
+
+```js
+// foo-bar-element.js
+import {myHelper} from './helpers.js'
+export class FooBarElement extends HTMLElement {
+  // ...
+}
+```
+
+```js
+// foo-bar-element.js
+import {myHelper} from './helpers.js'
+export class FooReadyEvent extends Event {
+  // ...
+}
+
+export class FooBarElement extends HTMLElement {
+  // ...
+}
+```
+
+```js
+// helpers.js
+export function myHelper() {
+  // ...
+}
+```
+
+## When Not To Use It
+
+If you intentionally want multiple exports in a single file then you can disable this rule.