chore: improve license header checks @W-14846456 (#3951)

* chore(scripts): run header check on commit

Fail faster than waiting for CI!

* fix(scripts): update copyright header check to permit new company name

In 2022, Salesforce changed from "salesforce.com, inc." to "Salesforce, Inc."

https://investor.salesforce.com/press-releases/press-release-details/2022/Salesforce-Changes-Legal-Name-to-Salesforce-Inc/default.aspx

* chore: remove file that doesn't exist from ignore patterns

* chore(lint): add copyright header enforcement to eslint

This enables auto-fixes, which is an improvment over the check-license-headers.js script.

* chore(scripts): add check-license-headers to package.json scripts

* fix: check license headers for all files, not just js/ts

* chore: remove check-license-headers script

Headers are enforced for JS/TS files using eslint.

Other file types don't need enforcement.

* chore(lint): remove overrides covered by .eslintignore

* chore(lint): remove unnecessary rule exception

* style: revert to 2-space indent

* style: revert to original formatting

* chore(scripts): remove package.json script for removed script file

.eslintrc

@@ -10,7 +10,8 @@
         "jest",
         "@lwc/lwc-internal",
         "@typescript-eslint",
-        "import"
+        "import",
+        "header"
     ],
     "extends": [
         "eslint:recommended",
@@ -104,7 +105,22 @@
             "name": "@lwc/features",
             "importNames": ["lwcRuntimeFlags", "runtimeFlags", "default"],
             "message": "Do not directly import runtime flags from @lwc/features. Use the global lwcRuntimeFlags variable instead."
-        }]
+        }],
+        "header/header": [
+            2,
+            "block",
+            [
+              "",
+              {
+                "pattern": "^ \\* Copyright \\(c\\) \\d{4}, ([sS]alesforce.com, inc|Salesforce, Inc)\\.$",
+                "template": " * Copyright (c) 2024, Salesforce, Inc."
+              },
+              " * All rights reserved.",
+              " * SPDX-License-Identifier: MIT",
+              " * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/MIT",
+              " "
+            ]
+          ]
     },
 
     "overrides": [
@@ -185,6 +201,16 @@
                 "benchmark": true,
                 "run": true
             }
-        }
+        },
+        {
+            "files": [
+              "packages/@lwc/integration-tests/src/**/!(*.spec.js)",
+              "packages/@lwc/integration-karma/test/**",
+              "packages/@lwc/integration-karma/test-hydration/**"
+            ],
+            "rules": {
+              "header/header": "off"
+            }
+          }
     ]
 }

.github/workflows/unit.yml

@@ -48,8 +48,6 @@ jobs:
       - name: Install chromedriver v119
         run: yarn add -W chromedriver@^119
 
-      - name: Check missing file headers
-        run: node ./scripts/tasks/check-license-headers.js
       - name: Check package.json integrity
         run: node ./scripts/tasks/check-and-rewrite-package-json.js --test
       - name: Verify @lwc/shared is tree-shakable

package.json

@@ -49,6 +49,7 @@
         "bytes": "^3.1.2",
         "es-module-lexer": "^1.4.1",
         "eslint": "^8.56.0",
+        "eslint-plugin-header": "^3.1.1",
         "eslint-plugin-import": "^2.29.1",
         "eslint-plugin-jest": "^27.6.0",
         "glob": "^10.3.10",

packages/@lwc/engine-server/src/__tests__/modules/x/htmlVoid/htmlVoid.js

@@ -1,3 +1,9 @@
+/*
+ * Copyright (c) 2024, Salesforce, Inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: MIT
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/MIT
+ */
 import { LightningElement } from 'lwc';
 
 export default class extends LightningElement {

packages/@lwc/engine-server/src/__tests__/modules/x/htmlVoidAdjacentText/htmlVoidAdjacentText.js

@@ -1,3 +1,9 @@
+/*
+ * Copyright (c) 2024, Salesforce, Inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: MIT
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/MIT
+ */
 import { LightningElement } from 'lwc';
 
 export default class extends LightningElement {

packages/@lwc/engine-server/src/__tests__/modules/x/htmlVoidHtmlNamespace/htmlVoidHtmlNamespace.js

@@ -1,3 +1,9 @@
+/*
+ * Copyright (c) 2024, Salesforce, Inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: MIT
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/MIT
+ */
 import { LightningElement } from 'lwc';
 
 export default class extends LightningElement {

packages/@lwc/engine-server/src/__tests__/modules/x/svgPath/svgPath.js

@@ -1,3 +1,9 @@
+/*
+ * Copyright (c) 2024, Salesforce, Inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: MIT
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/MIT
+ */
 import { LightningElement } from 'lwc';
 
 export default class extends LightningElement {

packages/@lwc/template-compiler/src/shared/utils.ts

@@ -1,11 +1,11 @@
-import { DASHED_TAGNAME_ELEMENT_SET } from './constants';
-
 /*
  * Copyright (c) 2018, salesforce.com, inc.
  * All rights reserved.
  * SPDX-License-Identifier: MIT
  * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/MIT
  */
+import { DASHED_TAGNAME_ELEMENT_SET } from './constants';
+
 export function toPropertyName(attr: string) {
     let prop = '';
     let shouldUpperCaseNext = false;

scripts/release/version.js

@@ -1,5 +1,4 @@
 #!/usr/bin/env node
-
 /*
  * Copyright (c) 2018, salesforce.com, inc.
  * All rights reserved.

yarn.lock

@@ -1265,9 +1265,11 @@
 
 "@lwc/eslint-plugin-lwc-internal@link:./scripts/eslint-plugin":
   version "0.0.0"
+  uid ""
 
 "@lwc/jest-utils-lwc-internals@link:./scripts/jest/utils":
   version "0.0.0"
+  uid ""
 
 "@mapbox/node-pre-gyp@^1.0.0":
   version "1.0.11"
@@ -4935,6 +4937,11 @@ eslint-module-utils@^2.8.0:
   dependencies:
     debug "^3.2.7"
 
+eslint-plugin-header@^3.1.1:
+  version "3.1.1"
+  resolved "https://registry.yarnpkg.com/eslint-plugin-header/-/eslint-plugin-header-3.1.1.tgz#6ce512432d57675265fac47292b50d1eff11acd6"
+  integrity sha512-9vlKxuJ4qf793CmeeSrZUvVClw6amtpghq3CuWcB5cUNnWHQhgcqy5eF8oVKFk1G3Y/CbchGfEaw3wiIJaNmVg==
+
 eslint-plugin-import@^2.29.1:
   version "2.29.1"
   resolved "https://registry.yarnpkg.com/eslint-plugin-import/-/eslint-plugin-import-2.29.1.tgz#d45b37b5ef5901d639c15270d74d46d161150643"