@allons-y/stylelint-header 4.0.0

package/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Change log
+
+## 4.0.0
+
+### Major Changes
+
+- Drop support for stylelint 16. The `stylelint` peer dependency now requires ([`b54abd8`](https://github.com/allonsy-studio/stylelint-header/commit/b54abd89e1827b503d97ae3982e05ec13e5393e7))
+  17.x, and the CI test matrix no longer runs against v16.

package/LICENSE

@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

package/README.md

@@ -0,0 +1,175 @@
+<!-- weaver:banner:START -->
+<!-- auto-generated by Weaver — do not edit between these markers -->
+
+<a href="https://allons-y.studio">
+    <img id="user-content-logo" src="https://raw.githubusercontent.com/allonsy-studio/.github/main/assets/png/oss-banner.png" alt="Brought to you by Allons-y Studio" width="1500">
+</a>
+
+<!-- weaver:banner:END -->
+
+<!-- weaver:header:START -->
+<h1 align="center">stylelint-header</h1>
+<p align="center">
+  <b>Enforce a header comment on every stylesheet.</b>
+</p>
+
+<div align="center">
+
+[![Tests](https://github.com/castastrophe/stylelint-header/actions/workflows/testing.yml/badge.svg?branch=main)](https://github.com/castastrophe/stylelint-header/actions/workflows/testing.yml)
+[![NPM version](https://img.shields.io/npm/v/stylelint-header.svg)](https://www.npmjs.com/package/stylelint-header)
+
+</div>
+<!-- weaver:header:END -->
+
+A [stylelint](https://github.com/stylelint/stylelint) custom rule that asserts every file begins with a configured header comment — typically a copyright or licence notice. When the header is missing, the rule reports an error; with `--fix`, it prepends the header for you.
+
+## The problem
+
+Copyright and licence headers are easy to add and easy to forget. A pre-commit lint check is the natural place to enforce them, but stylelint doesn't ship a header rule out of the box. **stylelint-header bridges the gap** — point it at a string or a file and every CSS/SCSS/Less file in your project picks up the same header, formatted consistently, with `--fix` doing the boring work.
+
+## Features
+
+- **Template-driven** — pass a string or a path to a file; supports [`lodash.template`](https://lodash.com/docs/4.17.15#template) syntax for variables
+- **Fuzzy matching** — uses [`string-similarity`](https://www.npmjs.com/package/string-similarity) so cosmetic edits (whitespace, year bumps) don't trigger false positives
+- **Auto-fixable** — missing headers are prepended on `--fix`, preserving the rest of the file
+- **Minifier-friendly** — opt into `/*!` syntax so the header survives tools like cssnano
+- **Built-in variables** — `YEAR`, `FILE_NAME`, and `FILE_PATH` are filled in automatically; bring your own as needed
+
+## Installation
+
+```sh
+yarn add --dev stylelint-header
+npm install --save-dev stylelint-header
+pnpm add --save-dev stylelint-header
+bun add --dev stylelint-header
+```
+
+## Usage
+
+Add the plugin to your stylelint config and enable the `header/header` rule, passing either a string template or a path to a file containing the template. To toggle the rule off, set the value to `null`.
+
+### With a template file
+
+```json
+{
+	"plugins": ["stylelint-header"],
+	"rules": {
+		"header/header": ["./COPYRIGHT"]
+	}
+}
+```
+
+### With an inline template string
+
+```js
+{
+  "plugins": ["stylelint-header"],
+  "rules": {
+    "header/header": [
+      "Copyright <%= YEAR %>. <%= company %>",
+      {
+        templateVariables: {
+          company: "AI Overlords Inc.",
+        },
+        nonMatchingTolerance: 0.8,
+      },
+    ],
+  },
+}
+```
+
+## Options
+
+### `templateVariables`
+
+**Type:** `object` &nbsp;&nbsp;**Default:** `{}`
+
+Key/value pairs used to substitute variables in the header template. Given a template like:
+
+```js
+(c) <%= YEAR %> <%= company %>
+```
+
+and a config of:
+
+```js
+{
+  templateVariables: {
+    company: "AI Overlords Inc.",
+  },
+}
+```
+
+the resulting header becomes:
+
+```css
+/*!
+ * (c) 2026 AI Overlords Inc.
+ */
+```
+
+`YEAR` was substituted automatically — it doesn't need to appear in `templateVariables`. The following variables are always available:
+
+| Variable    | Value                            |
+| ----------- | -------------------------------- |
+| `YEAR`      | The current year                 |
+| `FILE_NAME` | The basename of the linted file  |
+| `FILE_PATH` | The directory of the linted file |
+
+Templates use [`lodash.template`](https://lodash.com/docs/4.17.15#template) — see the lodash docs for the full syntax.
+
+### `nonMatchingTolerance`
+
+**Type:** `number` between `0` and `1` &nbsp;&nbsp;**Default:** `0.98`
+
+Minimum similarity (per [`string-similarity`](https://www.npmjs.com/package/string-similarity)) between the comment found at the top of the file and the configured header. Lower the value when you want to allow small drift (e.g. a stale year); raise it to enforce an exact match.
+
+### `isRemovable`
+
+**Type:** `boolean` &nbsp;&nbsp;**Default:** `false`
+
+When `true`, generated headers begin with `/*` rather than `/*!`. The `/*!` prefix is preserved by most CSS minifiers (e.g. cssnano) — leave the default in place if you want the header to survive minification, set to `true` if you don't.
+
+## Requirements
+
+- Node.js >= 24
+- stylelint 17.x
+
+## Contributing
+
+Contributions are welcome — see [CONTRIBUTING.md](./CONTRIBUTING.md) for the full workflow, and [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md) for community expectations. For bugs and ideas, please open an [issue](https://github.com/castastrophe/stylelint-header/issues/new).
+
+<!-- weaver:license:START -->
+
+## License
+
+[Apache 2.0](./LICENSE) © [Cassondra Roberts](https://allons-y.studio)
+<!-- weaver:license:END -->
+
+<!-- weaver:funding:START -->
+<!-- auto-generated by Weaver — do not edit between these markers -->
+
+<h2>Funding ☕️</h2>
+
+If you find this plugin useful and would like to buy me a coffee/beer as a small thank you, I would greatly appreciate it!
+
+<a href="https://www.buymeacoffee.com/castastrophe">
+    <img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" height="60" width="217" />
+</a>
+
+<!-- weaver:funding:END -->
+
+<!-- weaver:footer:START -->
+<!-- auto-generated by Weaver — do not edit between these markers -->
+
+<p align="left">
+<a href="https://allons-y.studio">
+    <picture>
+        <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/allonsy-studio/.github/main/assets/png/oss-footer-dark.png">
+        <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/allonsy-studio/.github/main/assets/png/oss-footer-light.png">
+        <img id="user-content-logo" src="https://raw.githubusercontent.com/allonsy-studio/.github/main/assets/png/oss-footer-light.png" alt="Brought to you by Allons-y Studio" width="400">
+    </picture>
+</a>
+</p>
+
+<!-- weaver:footer:END -->

package/index.js

@@ -0,0 +1,138 @@
+import { existsSync, readFileSync } from "fs";
+import { join } from "path";
+
+import stylelint from "stylelint";
+import { compareTwoStrings } from "string-similarity";
+import { template } from "lodash-es";
+
+const {
+	createPlugin,
+	utils: { report, ruleMessages, validateOptions },
+} = stylelint;
+
+const ruleName = "header/header";
+
+const messages = ruleMessages(ruleName, {
+	rejected: `Header not found.`,
+});
+
+const meta = {
+	url: "https://github.com/castastrophe/stylelint-header/blob/main/README.md",
+};
+
+/**
+ * @typedef {object} Options
+ * @property {number} [nonMatchingTolerance=0.98] -- percentage of allowed difference between a found comment in the file and the provided header
+ * @property {{ [string]: any }} [templateVariables={}] -- used to replace variables in the header template
+ * @property {boolean} [isRemovable=false] -- whether the comment starts with `/*!`, a special syntax that is often retained even when other comments are stripped by minifiers such as cssnano
+ */
+
+/** @type {import('stylelint').Rule<string, Options>} */
+const ruleFunction =
+	(pathOrString, options = {}, context = {}) =>
+	(root, result) => {
+		const validOptions = validateOptions(
+			result,
+			ruleName,
+			{
+				actual: pathOrString,
+				possible: [
+					null,
+					(x) => typeof x === "string",
+					(x) => typeof x === "string" && existsSync(x),
+					(x) => typeof x === "string" && existsSync(join(process.cwd(), x)),
+				],
+			},
+			{
+				optional: true,
+				actual: options,
+				possible: {
+					nonMatchingTolerance: [
+						(val) => typeof val === "number" && val >= 0 && val <= 1,
+					],
+					templateVariables: [Object, null],
+					isRemovable: [Boolean, null],
+				},
+			},
+		);
+
+		if (!validOptions) return;
+
+		let headerTemplate = pathOrString;
+
+		if (existsSync(pathOrString)) {
+			headerTemplate = readFileSync(pathOrString, "utf8");
+		} else if (existsSync(join(process.cwd(), pathOrString))) {
+			headerTemplate = readFileSync(join(process.cwd(), pathOrString), "utf8");
+		}
+
+		if (!headerTemplate || headerTemplate === "") return;
+
+		// Trim any comment tags from the string and remove whitespace
+		headerTemplate = headerTemplate.replace(/(\/\*|\*\/|(\s*\*))/g, "").trim();
+
+		const getHeader = template(headerTemplate);
+		const header = getHeader({
+			YEAR: new Date().getFullYear(),
+			FILE_NAME: context.file?.basename,
+			FILE_PATH: context.file?.dirname,
+			...(options.templateVariables ?? {}),
+		});
+
+		const nonMatchingTolerance = options?.nonMatchingTolerance || 0.98;
+		const isRemovable = options?.isRemovable || false;
+
+		// Walk comments on root to find if header exists
+		let found = false;
+		root.walkComments((comment, _idx) => {
+			// Remove any asterisks and whitespace from the texts before comparing
+			const clean = (text) =>
+				text
+					.replace(/(\*|\n|\s)/g, "")
+					.replace(/^!/g, "")
+					.trim();
+
+			// If the two strings are at least 98% alike, it's a match
+			if (
+				compareTwoStrings(clean(comment.text), clean(header)) >=
+				nonMatchingTolerance
+			) {
+				found = true;
+			}
+
+			// This escapes the loop if found, continues if not found
+			return !found;
+		});
+
+		if (found) return;
+
+		if (context.fix) {
+			// Add the provided header to the top of the file
+			root.prepend({
+				text: header
+					.split("\n")
+					.map((line) => ` * ${line}`)
+					.join("\n"),
+				raws: {
+					left: isRemovable ? "\n" : "!\n",
+					right: "\n ",
+				},
+			});
+			// Put a few newlines between the comment and the first property
+			root.nodes[1].raws.before = context.newline + context.newline;
+		} else {
+			// Just report the issue
+			report({
+				ruleName: ruleName,
+				result: result,
+				message: messages.rejected,
+				node: root,
+			});
+		}
+	};
+
+ruleFunction.ruleName = ruleName;
+ruleFunction.messages = messages;
+ruleFunction.meta = meta;
+
+export default createPlugin(ruleName, ruleFunction);

package/package.json

@@ -0,0 +1,103 @@
+{
+	"publishConfig": {
+		"access": "public",
+		"registry": "https://registry.npmjs.org/"
+	},
+	"name": "@allons-y/stylelint-header",
+	"version": "4.0.0",
+	"description": "A stylelint plugin that checks for a file header.",
+	"license": "MPL-2.0",
+	"author": "Cassondra Roberts <castastrophe@users.noreply.github.com> (https://allons-y.studio)",
+	"funding": [
+		{
+			"type": "github",
+			"url": " https://github.com/sponsors/castastrophe"
+		},
+		{
+			"type": "buymeacoffee",
+			"url": "https://www.buymeacoffee.com/castastrophe"
+		}
+	],
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/allonsy-studio/stylelint-header.git"
+	},
+	"bugs": {
+		"url": "https://github.com/allonsy-studio/stylelint-header/issues"
+	},
+	"type": "module",
+	"exports": "./index.js",
+	"module": "index.js",
+	"files": [
+		"index.js",
+		"!test/*",
+		"README.md",
+		"CHANGELOG.md",
+		"package.json",
+		"LICENSE"
+	],
+	"scripts": {
+		"changeset": "changeset",
+		"coverage": "yarn test --coverage --coverageReporters=cobertura",
+		"format": "yarn lint --fix",
+		"lint": "eslint --no-error-on-unmatched-pattern --no-warn-ignored --cache '**/*'",
+		"postpack": "pinst --enable",
+		"prepack": "pinst --disable",
+		"prepare": "husky && envoy || true",
+		"prepublish": "yarn test",
+		"test": "cross-env NODE_OPTIONS=--experimental-vm-modules jest",
+		"watch": "yarn test --watch"
+	},
+	"dependencies": {
+		"lodash-es": "4.18.1",
+		"string-similarity": "4.0.4"
+	},
+	"peerDependencies": {
+		"stylelint": "17.x"
+	},
+	"devDependencies": {
+		"@allons-y/envoy": "^1.1.0",
+		"@changesets/cli": "^2.31.0",
+		"@changesets/get-github-info": "^0.8.0",
+		"@eslint/compat": "^1.4.1",
+		"@eslint/js": "^10.0.1",
+		"@eslint/json": "^1.2.0",
+		"@eslint/markdown": "^8.0.2",
+		"@stylistic/eslint-plugin": "^2.13.0",
+		"cross-env": "10.1.0",
+		"eslint": "^10.4.1",
+		"eslint-config-prettier": "^10.1.8",
+		"eslint-plugin-jest": "^29.15.4",
+		"eslint-plugin-jsonc": "^3.2.0",
+		"eslint-plugin-node": "^11.1.0",
+		"globals": "^17.6.0",
+		"husky": "9.1.7",
+		"jest": "30.3.0",
+		"jest-preset-stylelint": "9.1.0",
+		"lint-staged": "^17.0.4",
+		"pinst": "3.0.0",
+		"prettier": "^3.8.3",
+		"stylelint": "17.9.1"
+	},
+	"keywords": [
+		"css",
+		"header",
+		"linter",
+		"stylelint",
+		"stylelint-plugin"
+	],
+	"engines": {
+		"node": ">=24"
+	},
+	"jest": {
+		"preset": "jest-preset-stylelint"
+	},
+	"lint-staged": {
+		"*": [
+			"eslint --fix --format stylish",
+			"prettier --write --ignore-unknown --no-error-on-unmatched-pattern --no-warn-ignored"
+		],
+		".github/renovate.json": "npx --yes --package renovate -- renovate-config-validator --strict"
+	},
+	"packageManager": "yarn@4.17.1"
+}