feat: added special webpack rule to check license comments (#66)

Author: alexander-akait

configs/index.js

@@ -6,6 +6,7 @@ import nodeConfig from "./node.js";
 import packageJSON from "./package-json.js";
 import stylisticConfig from "./stylistic.js";
 import typescriptConfig from "./typescript.js";
+import webpackSpecial from "./webpack-special.js";
 
 const configs = {
 	...browserConfig,
@@ -16,6 +17,7 @@ const configs = {
 	...stylisticConfig,
 	...typescriptConfig,
 	...packageJSON,
+	...webpackSpecial,
 };
 
 export default configs;

configs/webpack-special.js

@@ -0,0 +1,9 @@
+import { configs } from "../plugins/webpack/index.js";
+
+const recommendedWebpackSpecialConfig = {
+	...configs.recommended,
+};
+
+export default {
+	"webpack/special": recommendedWebpackSpecialConfig,
+};

eslint.config.js

@@ -39,4 +39,9 @@ export default defineConfig([
 			"n/hashbang": "off",
 		},
 	},
+	// For test purposes
+	{
+		files: ["./validation/webpack/**/*"],
+		extends: [configs["recommended-commonjs"], configs["webpack/special"]],
+	},
 ]);

plugins/webpack/index.js

@@ -0,0 +1,45 @@
+import { createRequire } from "node:module";
+import { allExtensions } from "../../configs/utils/extensions.js";
+import { rule as requireLicenseComment } from "./rules/require-license-comment.js";
+
+const require = createRequire(import.meta.url);
+
+const { version } = require("../../package.json");
+
+const rules = {
+	"require-license-comment": requireLicenseComment,
+};
+
+const recommendedRules = {
+	...Object.fromEntries(
+		Object.entries(rules)
+			.filter(([, rule]) => rule.meta.docs?.recommended)
+			.map(([name]) => [`webpack/${name}`, "error"]),
+	),
+};
+
+const configs = {
+	recommended: {
+		name: "webpack/recommended",
+		files: [`**/*.{${allExtensions.map((item) => item.slice(1)).join(",")}}`],
+		plugins: {
+			get webpack() {
+				// eslint-disable-next-line no-use-before-define
+				return plugin;
+			},
+		},
+		rules: recommendedRules,
+	},
+};
+
+const plugin = {
+	configs,
+	meta: {
+		version,
+	},
+	rules,
+};
+
+export { configs, rules };
+
+export default plugin;

plugins/webpack/rules/require-license-comment.js

@@ -0,0 +1,59 @@
+/**
+ * @type {import("eslint").Rule} rule
+ */
+export const rule = {
+	create(context) {
+		const sourceCode = context.getSourceCode();
+
+		return {
+			"Program:exit"(program) {
+				const comments = sourceCode.getAllComments();
+				const licenseComment = comments.find(
+					(comment) =>
+						comment.type === "Block" &&
+						/\n\s*MIT License http:\/\/www\.opensource\.org\/licenses\/mit-license\.php\n\s*(?:(Authors? .+)\n)?\s*/g.test(
+							comment.value,
+						),
+				);
+
+				if (!licenseComment) {
+					context.report({
+						loc: program.loc,
+						message: "Expected license comment.",
+					});
+
+					return;
+				}
+
+				const afterComment = sourceCode.text[licenseComment.end];
+
+				if (afterComment !== "\n") {
+					context.report({
+						loc: licenseComment.loc,
+						message: "Expected newline after license comment.",
+					});
+
+					return;
+				}
+
+				const afterAfterComment = sourceCode.text[licenseComment.end + 1];
+
+				if (afterAfterComment !== "\n") {
+					context.report({
+						loc: licenseComment.loc,
+						message: "Expected newline after license comment.",
+					});
+				}
+			},
+		};
+	},
+	meta: {
+		docs: {
+			category: "Best Practices",
+			description: "Require license comment",
+			recommended: true,
+		},
+		fixable: "code",
+		type: "layout",
+	},
+};

validation/webpack/file.js

@@ -0,0 +1,17 @@
+/*
+	MIT License http://www.opensource.org/licenses/mit-license.php
+	Author Alexander Akait @alexander-akait
+*/
+
+"use strict";
+
+/**
+ * @param {number} a a
+ * @param {number} b b
+ * @returns {number} result
+ */
+function sum(a, b) {
+	return a + b;
+}
+
+sum(1, 2);

validation/webpack/package.json

@@ -0,0 +1,5 @@
+{
+  "name": "webpack-package",
+  "version": "1.0.0",
+  "description": "Test"
+}