chore(license): add a new ESLint rule to check license header (#2150)

webapp/.eslintrc.cjs

@@ -12,10 +12,17 @@ module.exports = {
     "plugin:react/jsx-runtime",
     "plugin:react-hooks/recommended",
     "plugin:jsdoc/recommended-typescript",
-    "plugin:prettier/recommended",
+    "plugin:prettier/recommended", // Must be the last one
+  ],
+  plugins: [
+    "license-header",
+    "react-refresh",
+  ],
+  ignorePatterns: [
+    "dist", 
+    "license-header.js", 
+    ".eslintrc.cjs",
   ],
-  plugins: ["react-refresh"],
-  ignorePatterns: ["dist", ".eslintrc.cjs"],
   parser: "@typescript-eslint/parser",
   parserOptions: {
     // `ecmaVersion` is automatically sets by `esXXXX` in `env`
@@ -48,6 +55,7 @@ module.exports = {
     "jsdoc/require-jsdoc": "off",
     "jsdoc/require-hyphen-before-param-description": "warn",
     "jsdoc/tag-lines": ["warn", "any", { startLines: 1 }], // Expected 1 line after block description
+    "license-header/header": ["error", "license-header.js"],
     "no-console": "warn",
     "no-param-reassign": [
       "error",

webapp/.prettierignore

@@ -0,0 +1 @@
+license-header.js

webapp/package.json

@@ -106,6 +106,7 @@
     "eslint": "8.55.0",
     "eslint-config-prettier": "9.0.0",
     "eslint-plugin-jsdoc": "48.2.0",
+    "eslint-plugin-license-header": "0.6.1",
     "eslint-plugin-prettier": "5.0.0",
     "eslint-plugin-react": "7.33.2",
     "eslint-plugin-react-hooks": "4.6.0",

webapp/tsconfig.json

@@ -2,7 +2,11 @@
   "compilerOptions": {
     "target": "es2022",
     "useDefineForClassFields": true,
-    "lib": ["ES2022", "DOM", "DOM.Iterable"],
+    "lib": [
+      "ES2022", 
+      "DOM", 
+      "DOM.Iterable",
+    ],
     "module": "ESNext",
     "skipLibCheck": true,
 
@@ -13,7 +17,11 @@
     "isolatedModules": true,
     "noEmit": true,
     "jsx": "react-jsx",
-    "types": ["vitest/globals", "vitest/jsdom"],
+    "types": [
+      "vite/client",
+      "vitest/globals",
+      "vitest/jsdom",
+    ],
 
     /* Linting */
     "strict": true,

webapp/tsconfig.node.json

@@ -5,7 +5,10 @@
     "module": "ESNext",
     "moduleResolution": "bundler",
     "allowSyntheticDefaultImports": true,
-    "types": ["vitest/globals", "vitest/jsdom"]
+    "types": [
+      "vitest/globals",
+      "vitest/jsdom",
+    ]
   },
   "include": ["vite.config.ts"]
 }

webapp/vite.config.ts

@@ -1,4 +1,17 @@
-/// <reference types="vitest" />
+/**
+ * Copyright (c) 2024, RTE (https://www.rte-france.com)
+ *
+ * See AUTHORS.txt
+ *
+ * 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 http://mozilla.org/MPL/2.0/.
+ *
+ * SPDX-License-Identifier: MPL-2.0
+ *
+ * This file is part of the Antares project.
+ */
+
 import { defineConfig } from "vite";
 import react from "@vitejs/plugin-react-swc";