feat(tooling-general): add pre-commit hook to automatically add missi…

…ng license headers (#416)

* feat: add pre-commit hook to automatically add missing license headers

* refactor: improve code

* refactor(general): Update lockfile

---------

Co-authored-by: marc2332 <[email protected]>
Co-authored-by: cpl121 <[email protected]>

.husky/pre-commit

@@ -0,0 +1 @@
+pnpm exec lint-staged --allow-empty

.lintstagedrc.json

@@ -0,0 +1,3 @@
+{
+    "{sdk,apps}/**/*.{ts,js,mjs,tsx}": "eslint -c ./linting/.eslintrc.precommit.js --fix"
+}

linting/.eslintrc.precommit.js

@@ -0,0 +1,9 @@
+// Copyright (c) 2024 IOTA Stiftung
+// SPDX-License-Identifier: Apache-2.0
+
+module.exports = {
+    plugins: ['license-check'],
+    rules: {
+        'license-check/license-check': 'error',
+    },
+};

linting/license-check/package.json

@@ -0,0 +1,5 @@
+{
+    "name": "eslint-plugin-license-check",
+    "version": "1.0.0",
+    "main": "plugin.js"
+  }

linting/license-check/plugin.js

@@ -0,0 +1,10 @@
+// Copyright (c) 2024 IOTA Stiftung
+// SPDX-License-Identifier: Apache-2.0
+
+const licenseCheck = require('./rules/license-check.rule');
+
+module.exports = {
+    rules: {
+        'license-check': licenseCheck,
+    },
+};

linting/license-check/rules/license-check.rule.js

@@ -0,0 +1,70 @@
+// Copyright (c) 2024 IOTA Stiftung
+// SPDX-License-Identifier: Apache-2.0
+
+const IOTA_COPYRIGHT_HEADER = 'Copyright (c) 2024 IOTA Stiftung';
+const OLD_COPYRIGHT_HEADER = 'Copyright (c) Mysten Labs, Inc.';
+const MODIFICATION_COPYRIGHT_HEADER = 'Modifications Copyright (c) 2024 IOTA Stiftung';
+const LICENSE_IDENTIFIER = 'SPDX-License-Identifier: Apache-2.0';
+
+const MISSING_HEADER_MESSAGE = 'Missing or incorrect license header.';
+const MISSING_MODIFICATION_MESSAGE = 'Add modification notice to the license header.';
+
+const IOTA_LICENSE_HEADER = `// ${IOTA_COPYRIGHT_HEADER}\n// ${LICENSE_IDENTIFIER}\n\n`;
+const MODIFICATION_HEADER = `\n\n// ${MODIFICATION_COPYRIGHT_HEADER}\n// ${LICENSE_IDENTIFIER}\n\n`;
+
+function checkHeader(node, context) {
+    const sourceCode = context.getSourceCode();
+    const comments = sourceCode.getAllComments();
+    const firstComment = comments?.[0]?.value;
+
+    const hasIotaCopyrightHeader = firstComment?.includes(IOTA_COPYRIGHT_HEADER);
+    const hasOldCopyrightHeader = firstComment?.includes(OLD_COPYRIGHT_HEADER);
+    const hasLicenseIdentifier = comments?.[1]?.value.includes(LICENSE_IDENTIFIER);
+
+    // Check if the file has any license header.
+    if (
+        (!hasIotaCopyrightHeader && !hasOldCopyrightHeader) ||
+        !firstComment ||
+        !hasLicenseIdentifier
+    ) {
+        context.report({
+            node,
+            message: MISSING_HEADER_MESSAGE,
+            fix(fixer) {
+                return fixer.insertTextBeforeRange([0, 0], IOTA_LICENSE_HEADER);
+            },
+        });
+
+        // Check if the file has the old copyright notice and has the modification header.
+    } else if (firstComment.includes(OLD_COPYRIGHT_HEADER)) {
+        const hasModificationNotice = comments[2]?.value?.includes(MODIFICATION_COPYRIGHT_HEADER);
+        if (!hasModificationNotice) {
+            context.report({
+                node: comments[1],
+                message: MISSING_MODIFICATION_MESSAGE,
+                fix(fixer) {
+                    return fixer.insertTextAfter(comments[1], MODIFICATION_HEADER);
+                },
+            });
+        }
+    }
+}
+
+module.exports = {
+    meta: {
+        type: 'suggestion',
+        docs: {
+            description: 'Check and fix license header',
+            category: 'Stylistic Issues',
+        },
+        fixable: 'code',
+        schema: [],
+    },
+    create(context) {
+        return {
+            Program(node) {
+                checkHeader(node, context);
+            },
+        };
+    },
+};

package.json

@@ -21,7 +21,8 @@
 		"eslint:check": "eslint --max-warnings=0 .",
 		"eslint:fix": "pnpm run eslint:check --fix",
 		"lint": "pnpm run eslint:check && pnpm run prettier:check",
-		"lint:fix": "pnpm run eslint:fix && pnpm run prettier:fix"
+		"lint:fix": "pnpm run eslint:fix && pnpm run prettier:fix",
+		"prepare": "husky"
 	},
 	"pnpm": {
 		"overrides": {
@@ -54,13 +55,16 @@
 		"eslint-config-next": "14.2.3",
 		"eslint-config-prettier": "^8.8.0",
 		"eslint-import-resolver-typescript": "^3.5.5",
+		"eslint-plugin-license-check": "link:linting/license-check",
 		"eslint-plugin-header": "^3.1.1",
 		"eslint-plugin-import": "^2.27.5",
 		"eslint-plugin-prettier": "^5.0.0",
 		"eslint-plugin-require-extensions": "^0.1.3",
 		"eslint-plugin-tsdoc": "^0.2.17",
 		"eslint-plugin-unused-imports": "^3.0.0",
 		"graphql-config": "^5.0.3",
+		"husky": "^9.0.11",
+		"lint-staged": "^15.2.5",
 		"prettier": "^3.0.0",
 		"prettier-plugin-tailwindcss": "^0.4.1",
 		"tsx": "^3.12.7",