Add licence-header-plugin sample. (#30)

* Add licence-header-plugin sample.

Signed-off-by: Oleksandr Andriienko <[email protected]>

* Fix addressed chage. Simplify a bit code.

Signed-off-by: Oleksandr Andriienko <[email protected]>

Author: AndrienkoAleksandr

samples/licence-header-plugin/.gitignore

@@ -0,0 +1,4 @@
+dist/
+lib/
+node_modules/
+*.theia

samples/licence-header-plugin/README.md

@@ -0,0 +1,32 @@
+# licence-header-plugin
+licence-header-plugin example for che-theia. Plugin generates new MIT license file header on file edition in format:
+
+```js
+/*
+* Copyright (c) 2019 Simon's cat. All rights reserved.
+* @license MIT
+*/
+
+function meow() {
+    console.log('Feed me');
+}
+```
+
+# How to test it
+This plugin works with node projects with file extensions '.js', '.ts'. In the package.json should be declared licence type 'MIT' and author(optinal):
+```json
+{
+  "name": "SimonEmulator",
+  "version": "1.0.0",
+  "description": "Let's feed Simon's cat",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Info: no test specified\" && exit 1"
+  },
+  "author": "Simon's cat",
+  "license": "MIT"
+}
+```
+
+Open project in the che-theia and open any '.js' or '.ts' file. Change something in the file. Plugin analizes file content.
+In case if file doesn't contains MIT license header, than plugin generate it on the top of the file.

samples/licence-header-plugin/package.json

@@ -0,0 +1,33 @@
+{
+    "name": "licence-header-plugin",
+    "publisher": "eclipse-che",
+    "keywords": [
+        "theia-plugin"
+    ],
+    "version": "0.0.1",
+    "license": "EPL-2.0",
+    "files": [
+        "src"
+    ],
+    "devDependencies": {
+        "@theia/plugin": "next",
+        "@theia/plugin-packager": "latest",
+        "rimraf": "2.6.2",
+        "typescript-formatter": "7.2.2",
+        "typescript": "2.9.2"
+    },
+    "scripts": {
+        "prepare": "yarn run clean && yarn run build",
+        "clean": "rimraf lib",
+        "format-code": "tsfmt -r",
+        "watch": "tsc -watch",
+        "compile": "tsc",
+        "build": "yarn run format-code && yarn run compile && theia:plugin pack"
+    },
+    "engines": {
+        "theiaPlugin": "next"
+    },
+    "theiaPlugin": {
+        "backend": "lib/licence-header-plugin-backend.js"
+    }
+}

samples/licence-header-plugin/src/licence-header-plugin-backend.ts

@@ -0,0 +1,87 @@
+/*********************************************************************
+ * Copyright (c) 2019 Red Hat, Inc.
+ *
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ **********************************************************************/
+
+import * as theia from '@theia/plugin';
+import * as fs from 'fs';
+import * as path from 'path';
+export const YEARS_IDENTIFIER = '${Years}';
+export const AUTHORS_IDENTIFIER = '${Authors}';
+
+export const MIT_LICENSE_HEADER_CONTENT = `/*\n* Copyright (c) ${YEARS_IDENTIFIER}${AUTHORS_IDENTIFIER}. All rights reserved.\n* @license MIT\n*/\n`;
+export const MIT_LICENSE_HEDER_REGEXP = new RegExp(/.*(Copyright \(c\) ).*(. All rights reserved.\n).*(@license MIT\n).*/);
+
+export const PACKAGE_JSON = 'package.json';
+
+export const SUPPORTED_EXTENSIONS = ['.js', '.ts'];
+export const SUPPORTED_LICENCE_HEADERS = ['MIT'];
+
+export class LicenseHeader {
+
+    constructor(private readonly authors: string, private readonly licenseContent: string, private readonly licenceRegexp: RegExp) { }
+
+    getHeader(): string {
+        const currentYear = new Date().getFullYear();
+        const spaceAfterYear = this.authors ? ' ' : '';
+        const header = this.licenseContent.replace(YEARS_IDENTIFIER, currentYear + spaceAfterYear).replace(AUTHORS_IDENTIFIER, this.authors || '');
+        return header;
+    }
+
+    getRegExpr(): RegExp {
+        return this.licenceRegexp;
+    }
+}
+
+export function start(context: theia.PluginContext) {
+    context.subscriptions.push(theia.workspace.onWillSaveTextDocument(fileSaveEvent => {
+        const fileContentPromise = new Promise<void | theia.TextEdit[]>((resolve, reject) => {
+            const document = fileSaveEvent.document;
+            const fileExt = path.extname(document.uri.fsPath);
+            if (!isSupportedValue(fileExt, SUPPORTED_EXTENSIONS)) {
+                resolve([]);
+            }
+            const fileUri = document.uri;
+            const workspaceFolder: theia.WorkspaceFolder | theia.Uri | undefined = theia.workspace.getWorkspaceFolder(fileUri);
+            let workspaceFolderUri: theia.Uri | undefined;
+            if (workspaceFolder) {
+                workspaceFolderUri = workspaceFolder instanceof theia.Uri ? workspaceFolder : workspaceFolder.uri;
+            }
+
+            if (workspaceFolderUri) {
+                const packageJsonPath = path.resolve(workspaceFolderUri.fsPath, PACKAGE_JSON);
+                if (fs.existsSync(packageJsonPath)) {
+                    const packageJson = require(packageJsonPath);
+
+                    if (document && packageJson.license && isSupportedValue(packageJson.license, SUPPORTED_LICENCE_HEADERS)) {
+                        const fileText = document.getText();
+
+                        const textEdits: theia.TextEdit[] = [];
+                        const mitLicenceHeader = new LicenseHeader(packageJson.author, MIT_LICENSE_HEADER_CONTENT, MIT_LICENSE_HEDER_REGEXP);
+
+                        if (!mitLicenceHeader.getRegExpr().test(fileText)) {
+                            const licenceHeaderEdit = theia.TextEdit.insert(document.lineAt(0).range.start, mitLicenceHeader.getHeader());
+                            textEdits.push(licenceHeaderEdit);
+                        }
+                        resolve(textEdits);
+                    }
+                }
+            }
+            resolve();
+        });
+
+        fileSaveEvent.waitUntil(fileContentPromise);
+    }));
+}
+
+function isSupportedValue(item: string, supportedElems: string[]): boolean {
+    return supportedElems.findIndex((supportedElem => supportedElem === item)) >= 0;
+}
+
+export function stop() {
+}

samples/licence-header-plugin/tsconfig.json

@@ -0,0 +1,22 @@
+{
+    "compilerOptions": {
+        "strict": true,
+        "experimentalDecorators": true,
+        "noUnusedLocals": true,
+        "emitDecoratorMetadata": true,
+        "downlevelIteration": true,
+        "module": "commonjs",
+        "moduleResolution": "node",
+        "target": "es5",
+        "lib": [
+            "es6",
+            "webworker"
+        ],
+        "sourceMap": true,
+        "rootDir": "src",
+        "outDir": "lib"
+    },
+    "include": [
+        "src"
+    ]
+}

samples/licence-header-plugin/tsfmt.json

@@ -0,0 +1,18 @@
+{
+    "baseIndentSize": 0,
+    "newLineCharacter": "\n",
+    "indentSize": 4,
+    "tabSize": 4,
+    "indentStyle": 4,
+    "convertTabsToSpaces": true,
+    "insertSpaceAfterCommaDelimiter": true,
+    "insertSpaceAfterSemicolonInForStatements": true,
+    "insertSpaceBeforeAndAfterBinaryOperators": true,
+    "insertSpaceAfterKeywordsInControlFlowStatements": true,
+    "insertSpaceAfterFunctionKeywordForAnonymousFunctions": false,
+    "insertSpaceAfterOpeningAndBeforeClosingNonemptyParenthesis": false,
+    "insertSpaceAfterOpeningAndBeforeClosingNonemptyBrackets": false,
+    "insertSpaceAfterOpeningAndBeforeClosingTemplateStringBraces": false,
+    "placeOpenBraceOnNewLineForFunctions": false,
+    "placeOpenBraceOnNewLineForControlBlocks": false
+}