Add eslint header rule

jeanp413 · jeanp413 · commit 26ca9c312efa · 2022-07-01T00:59:01.000-05:00
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -6,7 +6,8 @@
   },
   "plugins": [
     "@typescript-eslint/eslint-plugin",
-    "jsdoc"
+    "jsdoc",
+    "header"
   ],
   "rules": {
     "constructor-super": "warn",
@@ -60,6 +61,16 @@
       {
         "allowTemplateLiterals": true
       }
-    ]
+    ],
+    "header/header": [
+			2,
+			"block",
+			[
+				"---------------------------------------------------------------------------------------------",
+				" *  Copyright (c) Gitpod. All rights reserved.",
+				" *  Licensed under the MIT License. See License.txt in the project root for license information.",
+				" *--------------------------------------------------------------------------------------------"
+			]
+		]
   }
 }
diff --git a/package.json b/package.json
@@ -97,7 +97,8 @@
 		"webpack": "webpack --mode development",
 		"compile": "tsc -b",
 		"watch": "tsc -b -w",
-		"package": "npx vsce package --yarn"
+		"package": "npx vsce package --yarn",
+		"lint": "eslint . --ext .ts"
 	},
 	"devDependencies": {
 		"@types/analytics-node": "^3.1.9",
@@ -116,6 +117,7 @@
 		"@typescript-eslint/parser": "^5.19.0",
 		"eslint": "^8.13.0",
 		"eslint-plugin-jsdoc": "^19.1.0",
+		"eslint-plugin-header": "3.1.1",
 		"minimist": "^1.2.6",
 		"ts-loader": "^9.2.7",
 		"typescript": "^4.6.3",
diff --git a/src/authentication.ts b/src/authentication.ts
@@ -1,5 +1,6 @@
 /*---------------------------------------------------------------------------------------------
  *  Copyright (c) Gitpod. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
 import * as vscode from 'vscode';
diff --git a/src/common/dispose.ts b/src/common/dispose.ts
@@ -1,5 +1,6 @@
 /*---------------------------------------------------------------------------------------------
  *  Copyright (c) Gitpod. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
 import * as vscode from 'vscode';
diff --git a/src/common/files.ts b/src/common/files.ts
@@ -1,5 +1,6 @@
 /*---------------------------------------------------------------------------------------------
  *  Copyright (c) Gitpod. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
 import * as fs from 'fs';
diff --git a/src/common/keychain.ts b/src/common/keychain.ts
@@ -1,5 +1,6 @@
 /*---------------------------------------------------------------------------------------------
  *  Copyright (c) Gitpod. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
 // keytar depends on a native module shipped in vscode, so this is
diff --git a/src/common/logger.ts b/src/common/logger.ts
@@ -1,5 +1,6 @@
 /*---------------------------------------------------------------------------------------------
  *  Copyright (c) Gitpod. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
 import * as vscode from 'vscode';
diff --git a/src/common/telemetry.ts b/src/common/telemetry.ts
@@ -1,5 +1,6 @@
 /*---------------------------------------------------------------------------------------------
  *  Copyright (c) Gitpod. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
 // This code is based on https://github.com/microsoft/vscode-extension-telemetry
diff --git a/src/common/utils.ts b/src/common/utils.ts
@@ -1,5 +1,6 @@
 /*---------------------------------------------------------------------------------------------
  *  Copyright (c) Gitpod. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
 import { EventEmitter, Event, Disposable } from 'vscode';
diff --git a/src/exportLogs.ts b/src/exportLogs.ts
@@ -1,3 +1,8 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Gitpod. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
 import * as path from 'path';
 import * as yazl from 'yazl';
 import * as fs from 'fs';
diff --git a/src/extension.ts b/src/extension.ts
@@ -1,5 +1,6 @@
 /*---------------------------------------------------------------------------------------------
  *  Copyright (c) Gitpod. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
 import * as os from 'os';
diff --git a/src/gitpodServer.ts b/src/gitpodServer.ts
@@ -1,5 +1,6 @@
 /*---------------------------------------------------------------------------------------------
  *  Copyright (c) Gitpod. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
 import * as vscode from 'vscode';
diff --git a/src/internalApi.ts b/src/internalApi.ts
@@ -1,5 +1,6 @@
 /*---------------------------------------------------------------------------------------------
  *  Copyright (c) Gitpod. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
 import { GitpodClient, GitpodServer, GitpodServiceImpl } from '@gitpod/gitpod-protocol/lib/gitpod-service';
diff --git a/src/remoteConnector.ts b/src/remoteConnector.ts
@@ -1,3 +1,8 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Gitpod. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
 import { AutoTunnelRequest, ResolveSSHConnectionRequest, ResolveSSHConnectionResponse } from '@gitpod/local-app-api-grpcweb/lib/localapp_pb';
 import { LocalAppClient } from '@gitpod/local-app-api-grpcweb/lib/localapp_pb_service';
 import { NodeHttpTransport } from '@improbable-eng/grpc-web-node-http-transport';
diff --git a/src/settingsSync.ts b/src/settingsSync.ts
@@ -1,5 +1,6 @@
 /*---------------------------------------------------------------------------------------------
  *  Copyright (c) Gitpod. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
 import * as vscode from 'vscode';
diff --git a/src/ssh/hostfile.ts b/src/ssh/hostfile.ts
@@ -1,5 +1,6 @@
 /*---------------------------------------------------------------------------------------------
  *  Copyright (c) Gitpod. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
 import * as os from 'os';
diff --git a/src/ssh/identityFiles.ts b/src/ssh/identityFiles.ts
@@ -1,5 +1,6 @@
 /*---------------------------------------------------------------------------------------------
  *  Copyright (c) Gitpod. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
 import * as os from 'os';
diff --git a/src/telemetryReporter.ts b/src/telemetryReporter.ts
@@ -1,3 +1,8 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Gitpod. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
 import { AppenderData, BaseTelemetryAppender, BaseTelemetryClient, BaseTelemetryReporter } from './common/telemetry';
 import SegmentAnalytics from 'analytics-node';
 import * as os from 'os';
diff --git a/yarn.lock b/yarn.lock
@@ -904,6 +904,11 @@ escape-string-regexp@^4.0.0:
   resolved "https://registry.yarnpkg.com/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz#14ba83a5d373e3d311e5afca29cf5bfad965bf34"
   integrity sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA==
 
+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-jsdoc@^19.1.0:
   version "19.2.0"
   resolved "https://registry.yarnpkg.com/eslint-plugin-jsdoc/-/eslint-plugin-jsdoc-19.2.0.tgz#f522b970878ae402b28ce62187305b33dfe2c834"
