add common header definition rule (#230)

Co-authored-by: Felix Schober <feschobe@microsoft.com>

.eslintrc.js

@@ -1,3 +1,8 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ */
+
 module.exports = {
     root: true,
     env: {
@@ -5,19 +10,35 @@ module.exports = {
         amd: true,
         mocha: true,
     },
-    parser: '@typescript-eslint/parser',
+    parser: "@typescript-eslint/parser",
     parserOptions: {
-        ecmaVersion: 2019
+        ecmaVersion: 2019,
     },
-    plugins: [
-        '@typescript-eslint',
-    ],
+    plugins: ["@typescript-eslint", "header"],
     extends: [
-        'eslint:recommended',
-        'plugin:@typescript-eslint/eslint-recommended',
-        'plugin:@typescript-eslint/recommended',
+        "eslint:recommended",
+        "plugin:@typescript-eslint/eslint-recommended",
+        "plugin:@typescript-eslint/recommended",
     ],
     rules: {
-        '@typescript-eslint/no-unused-vars': [ 'error', { "argsIgnorePattern": "^_$" } ],
-    }
+        "@typescript-eslint/no-unused-vars": [
+            "error",
+            { argsIgnorePattern: "^_$" },
+        ],
+        "header/header": [
+            2,
+            "block",
+            "\n * Copyright (c) Microsoft Corporation. All rights reserved.\n * Licensed under the MIT License. See License.txt in the project root for license information.\n ",
+            2,
+        ],
+    },
+    overrides: [
+        {
+            // Autogenerated file
+            files: ["**/Parser/*.js"],
+            rules: {
+                "header/header": "off"
+            }
+        }
+    ]
 };

gulpfile.js

@@ -1,7 +1,11 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ */
+
 /* eslint-disable @typescript-eslint/no-var-requires */
 /* eslint-disable no-undef */
+
 "use strict";
 const util = require('util');
 const nls = require('vscode-nls-dev');

package-lock.json

@@ -2534,6 +2534,12 @@
         }
       }
     },
+    "eslint-plugin-header": {
+      "version": "3.1.1",
+      "resolved": "https://registry.npmjs.org/eslint-plugin-header/-/eslint-plugin-header-3.1.1.tgz",
+      "integrity": "sha512-9vlKxuJ4qf793CmeeSrZUvVClw6amtpghq3CuWcB5cUNnWHQhgcqy5eF8oVKFk1G3Y/CbchGfEaw3wiIJaNmVg==",
+      "dev": true
+    },
     "eslint-scope": {
       "version": "5.1.1",
       "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-5.1.1.tgz",

package.json

@@ -482,6 +482,7 @@
     "@vscode/test-web": "^0.0.24",
     "chai": "^4.3.6",
     "eslint": "^8.11.0",
+    "eslint-plugin-header": "^3.1.1",
     "fancy-log": "^1.3.3",
     "fs-extra": "^9.0.1",
     "gulp": "^4.0.2",

src/client/PortalWebView.ts

@@ -1,7 +1,7 @@
-/* --------------------------------------------------------------------------------------------
+/*
  * Copyright (c) Microsoft Corporation. All rights reserved.
  * Licensed under the MIT License. See License.txt in the project root for license information.
- * ------------------------------------------------------------------------------------------ */
+ */
 
 import * as vscode from "vscode";
 import * as path from "path";

src/client/constants.ts

@@ -1,5 +1,7 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ */
 
 export const EXTENSION_ID = 'microsoft-IsvExpTools.powerplatform-vscode';
 

src/client/extension.ts

@@ -1,5 +1,7 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ */
 
 import * as vscode from "vscode";
 import TelemetryReporter from "@vscode/extension-telemetry";

src/client/lib/CliAcquisition.ts

@@ -1,5 +1,7 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ */
 
 // https://code.visualstudio.com/api/extension-capabilities/common-capabilities#output-channel
 

src/client/lib/PacActivityBarUI.ts

@@ -1,5 +1,7 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ */
 
 import * as nls from 'vscode-nls';
 nls.config({ messageFormat: nls.MessageFormat.bundle, bundleFormat: nls.BundleFormat.standalone })();

src/client/lib/PacTerminal.ts

@@ -1,5 +1,7 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ */
 
 import * as nls from 'vscode-nls';
 nls.config({ messageFormat: nls.MessageFormat.bundle, bundleFormat: nls.BundleFormat.standalone })();

src/client/lib/PanelComponents.ts

@@ -1,5 +1,7 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ */
 
 import * as nls from 'vscode-nls';
 nls.config({ messageFormat: nls.MessageFormat.bundle, bundleFormat: nls.BundleFormat.standalone })();

src/client/pac/PacTypes.ts

@@ -1,5 +1,7 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ */
 
 export type PacOutput = {
     Status: string;

src/client/pac/PacWrapper.ts

@@ -1,5 +1,7 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ */
 
 import * as os from "os";
 import * as path from "path";

src/client/telemetry/ITelemetry.ts

@@ -1,5 +1,7 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ */
 
 /**
  * Interface available for sending telemetry for this extension.

src/client/telemetry/NoopTelemetry.ts

@@ -1,5 +1,7 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ */
 
 import { ITelemetry } from './ITelemetry';
 

src/client/telemetry/appdata.ts

@@ -1,5 +1,7 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ */
 
 import * as process from "process";
 import * as os from "os";

src/client/telemetry/batchedTelemetryAgent.ts

@@ -1,5 +1,7 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ */
 
 import { ExtensionContext } from "vscode";
 

src/client/telemetry/localfileusersettings.ts

@@ -1,5 +1,7 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ */
 
 import * as fs from 'fs-extra';
 import { getAppDataPath } from './appdata';

src/client/test/unit/BlockingQueue.test.ts

@@ -1,5 +1,7 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ */
 
 import { expect } from "chai";
 import { BlockingQueue } from "../../../common/utilities/BlockingQueue";

src/client/test/unit/CliAcquisition.test.ts

@@ -1,5 +1,7 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ */
 
 import * as fs from 'fs-extra';
 import * as path from 'path';

src/client/test/unit/PacWrapper.test.ts

@@ -1,5 +1,7 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ */
 
 import { expect } from "chai";
 import { IPacInterop, IPacWrapperContext, PacArguments, PacWrapper } from "../../pac/PacWrapper";

src/common/PortalConfigFinder.ts

@@ -1,7 +1,8 @@
-/* --------------------------------------------------------------------------------------------
+/*
  * Copyright (c) Microsoft Corporation. All rights reserved.
  * Licensed under the MIT License. See License.txt in the project root for license information.
- * ------------------------------------------------------------------------------------------ */
+ */
+
 import {
     WorkspaceFolder
 } from 'vscode-languageserver/node';

src/common/TelemetryData.ts

@@ -1,7 +1,7 @@
-/* --------------------------------------------------------------------------------------------
+/*
  * Copyright (c) Microsoft Corporation. All rights reserved.
  * Licensed under the MIT License. See License.txt in the project root for license information.
- * ------------------------------------------------------------------------------------------ */
+ */
 
  /**
   * This type is used in the contract of telemetry/event notifications sent from language servers to the language clients.

src/common/utilities/BlockingQueue.ts

@@ -1,5 +1,7 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ */
 
 // Queue that returns Promises on dequeue, either already resolved if the item
 // has already been enqueued, or still waiting if the item has not yet arrived.

src/server/htmlServer.ts

@@ -1,7 +1,8 @@
-/* --------------------------------------------------------------------------------------------
+/*
  * Copyright (c) Microsoft Corporation. All rights reserved.
  * Licensed under the MIT License. See License.txt in the project root for license information.
- * ------------------------------------------------------------------------------------------ */
+ */
+
 import {
     createConnection,
     TextDocuments,

src/server/lib/LineReader.ts

@@ -1,7 +1,7 @@
-/* --------------------------------------------------------------------------------------------
+/*
  * Copyright (c) Microsoft Corporation. All rights reserved.
  * Licensed under the MIT License. See License.txt in the project root for license information.
- * ------------------------------------------------------------------------------------------ */
+ */
 
 import {
     TextDocument,

src/server/lib/PortalManifestReader.ts

@@ -1,7 +1,7 @@
-/* --------------------------------------------------------------------------------------------
+/*
  * Copyright (c) Microsoft Corporation. All rights reserved.
  * Licensed under the MIT License. See License.txt in the project root for license information.
- * ------------------------------------------------------------------------------------------ */
+ */
 
 import {
     WorkspaceFolder

src/server/telemetry/ServerTelemetry.ts

@@ -1,7 +1,7 @@
-/* --------------------------------------------------------------------------------------------
+/*
  * Copyright (c) Microsoft Corporation. All rights reserved.
  * Licensed under the MIT License. See License.txt in the project root for license information.
- * ------------------------------------------------------------------------------------------ */
+ */
 
 import { Connection, TelemetryEventNotification} from 'vscode-languageserver/node';
 import { ITelemetryData } from '../../common/TelemetryData';

src/server/test/unit/LineReader.test.ts

@@ -1,5 +1,7 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ */
 
 /* eslint-disable @typescript-eslint/no-unused-vars */
 /* eslint-disable no-var */

src/server/test/unit/liquidTagGrammer.test.ts

@@ -1,5 +1,7 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ */
 
 /* eslint-disable @typescript-eslint/no-var-requires */
 

src/server/yamlServer.ts

@@ -1,7 +1,8 @@
-/* --------------------------------------------------------------------------------------------
+/*
  * Copyright (c) Microsoft Corporation. All rights reserved.
  * Licensed under the MIT License. See License.txt in the project root for license information.
- * ------------------------------------------------------------------------------------------ */
+ */
+
 import {
     createConnection,
     TextDocuments,

src/web/client/common/authenticationProvider.ts

@@ -1,8 +1,9 @@
-/* eslint-disable @typescript-eslint/no-unused-vars */
-/* --------------------------------------------------------------------------------------------
+/*
  * Copyright (c) Microsoft Corporation. All rights reserved.
  * Licensed under the MIT License. See License.txt in the project root for license information.
- * ------------------------------------------------------------------------------------------ */
+ */
+
+/* eslint-disable @typescript-eslint/no-unused-vars */
 /* eslint-disable @typescript-eslint/no-explicit-any */
 
 import * as vscode from 'vscode';

src/web/client/common/constants.ts

@@ -1,7 +1,7 @@
-/* --------------------------------------------------------------------------------------------
+/*
  * Copyright (c) Microsoft Corporation. All rights reserved.
  * Licensed under the MIT License. See License.txt in the project root for license information.
- * ------------------------------------------------------------------------------------------ */
+ */
 
 export const PORTAL_LANGUAGES = 'adx_portallanguages';
 export const WEBSITE_LANGUAGES = 'adx_websitelanguages';

src/web/client/common/localStore.ts

@@ -1,8 +1,9 @@
-/* eslint-disable @typescript-eslint/no-unused-vars */
-/* --------------------------------------------------------------------------------------------
+/*
  * Copyright (c) Microsoft Corporation. All rights reserved.
  * Licensed under the MIT License. See License.txt in the project root for license information.
- * ------------------------------------------------------------------------------------------ */
+ */
+
+/* eslint-disable @typescript-eslint/no-unused-vars */
 /* eslint-disable @typescript-eslint/no-explicit-any */
 
 'use strict';

src/web/client/common/portalSchema.ts

@@ -1,3 +1,8 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ */
+
 export const portal_schema_data = {
     "entities": {
         "dataSourceProperties": {

src/web/client/common/portalSchemaReader.ts

@@ -1,7 +1,8 @@
-/* --------------------------------------------------------------------------------------------
+/*
  * Copyright (c) Microsoft Corporation. All rights reserved.
  * Licensed under the MIT License. See License.txt in the project root for license information.
- * ------------------------------------------------------------------------------------------ */
+ */
+
 /* eslint-disable @typescript-eslint/no-explicit-any */
 
 import { portal_schema_data } from "./portalSchema";

src/web/client/extension.ts

@@ -1,7 +1,7 @@
-/* --------------------------------------------------------------------------------------------
+/*
  * Copyright (c) Microsoft Corporation. All rights reserved.
  * Licensed under the MIT License. See License.txt in the project root for license information.
- * ------------------------------------------------------------------------------------------ */
+ */
 
 import * as vscode from "vscode";
 import TelemetryReporter from "@vscode/extension-telemetry";

src/web/client/test/unit/extension.test.ts

@@ -1,7 +1,7 @@
-/* --------------------------------------------------------------------------------------------
+/*
  * Copyright (c) Microsoft Corporation. All rights reserved.
  * Licensed under the MIT License. See License.txt in the project root for license information.
- * ------------------------------------------------------------------------------------------ */
+ */
 
 import { expect } from "chai";