✨ feature(eslint-plugin): add new file-header rule

Signed-off-by: Pauline <[email protected]>

packages/eslint-plugin/src/index.ts

@@ -10,6 +10,7 @@ import noTsExportEqual from './rules/no-ts-export-equal';
 import consistentListNewline from './rules/consistent-list-newline';
 import indentUnindent from './rules/indent-unindent';
 import onlyExportComponents from './rules/only-export-components';
+import fileHeader from './rules/file-header';
 import type { RuleModule } from './utils';
 
 const plugin = {
@@ -20,6 +21,7 @@ const plugin = {
 	/// @keep-sorted
 	rules: {
 		'consistent-list-newline': consistentListNewline,
+		'file-header': fileHeader,
 		'if-newline': ifNewline,
 		'import-dedupe': importDedupe,
 		'indent-unindent': indentUnindent,

packages/eslint-plugin/src/rules/file-header.md

@@ -0,0 +1,28 @@
+# file-header
+
+Simple file header that adds a copyright/license/message to the top of files.
+
+Adapted from [`eslint-plugin-simple-header`](https://codeberg.org/rini/eslint-plugin-simple-header)
+
+## Rule Details
+
+```ts
+type PetalFileHeader = [] | [(({
+	syntax?: string;
+	decor?: string;
+	[k: string]: unknown | undefined;
+} | {
+
+	syntax?: [string, string];
+
+	decor?: [string, string, string];
+	[k: string]: unknown | undefined;
+}) & ({
+
+	files: [string, ...string[]];
+	[k: string]: unknown | undefined;
+} | {
+	text: (string | string[]);
+	[k: string]: unknown | undefined;
+}))];
+```

packages/eslint-plugin/src/rules/file-header.test.ts

@@ -0,0 +1,7 @@
+import { run } from './_test';
+import rule, { RULE_NAME } from './file-header';
+
+run({
+	name: RULE_NAME,
+	rule,
+});