Feature/refactor document manager (buehler#131)

* rename the class and the jsdoc

* rename the files

* add the object manager interface and implement it

* adding basic class manager structure

* adding basic create method and tests

* refactor changeable, adding tests

* adding basic remove method and test skeleton

* add jsdoc lint rule

* adding types to declarations

* fix test

* add function without rettype

* adding types to declarations

* test for a typeguard

* fix export typed stuff

* adding tests for types

* rename propertyvisibility

* adding visibility to a method

* add and remove methods from a class, with tests

* correctly test changeables and add methods with name

* fix bug, move enum for sorting matters

* adding first commit actions and tests

* adding generation of properties

* adding more tests and cases

* insert properties in between

* code proeprty specials

* add type to params, add generation of methods

* require jsdoc for private methods

* add method generator

* first generated method

* calculate if emtpy line should be deleted on method removal

* do filter constructor injected properties

* coding tests

* remove only

* add lint to pkgjson

* missing JS doc

* Documentation

* changelog

* ups.

Author: buehler

CHANGELOG.md

@@ -3,6 +3,8 @@ All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
+#### Added
+- Classmanager that can modify classes in a document ([#127](https://github.com/buehler/typescript-hero/issues/127))
 
 ## [0.10.1]
 #### Added

package.json

@@ -39,8 +39,9 @@
     "precompile": "del ./out",
     "compile": "tsc -w --sourceMap",
     "postinstall": "node ./node_modules/vscode/bin/install",
-    "pretest": "tslint -c tslint.json --project tsconfig.json -e \"test/**/*.*\"",
+    "pretest": "npm run lint",
     "test": "node ./node_modules/vscode/bin/test",
+    "lint": "tslint -c tslint.json --project tsconfig.json -e \"test/**/*.*\"",
     "build": "del ./out && tsc",
     "package": "npm run build && del './*.vsix' && vsce package"
   },
@@ -58,6 +59,7 @@
     "sinon": "^1.17.6",
     "sinon-chai": "^2.8.0",
     "tslint": "^3.15.1",
+    "tslint-jsdoc-rules": "^0.1.2",
     "vscode": "^1.0.0"
   },
   "dependencies": {

src/TypeScriptHero.ts

@@ -28,6 +28,12 @@ export class TypeScriptHero implements Disposable {
         this.extensions.forEach(o => o.initialize(context));
     }
 
+    /**
+     * Disposes TypeScript Hero.
+     * 
+     * 
+     * @memberOf TypeScriptHero
+     */
     public dispose(): void {
         this.logger.info('Deactivation event called. Disposing TypeScriptHero.');
         for (let ext of this.extensions) {

src/caches/ResolveIndex.ts

@@ -1,5 +1,10 @@
 import { ExtensionConfig } from '../ExtensionConfig';
-import { ModuleDeclaration, TsDeclaration, TsExportableDeclaration } from '../models/TsDeclaration';
+import {
+    ModuleDeclaration,
+    TsDeclaration,
+    TsExportableDeclaration,
+    TsTypedExportableDeclaration
+} from '../models/TsDeclaration';
 import { TsAllFromExport, TsAssignedExport, TsFromExport, TsNamedFromExport } from '../models/TsExport';
 import { TsFile, TsNamedResource, TsResource } from '../models/TsResource';
 import { TsResourceParser } from '../parser/TsResourceParser';
@@ -22,6 +27,13 @@ export type ResourceIndex = { [declaration: string]: DeclarationInfo[] };
 
 type Resources = { [name: string]: TsResource };
 
+/**
+ * Returns the name of the node folder. Is used as the library name for indexing.
+ * (e.g. ./node_modules/webpack returns webpack)
+ * 
+ * @param {string} path
+ * @returns {string}
+ */
 function getNodeLibraryName(path: string): string {
     let dirs = path.split(/\/|\\/),
         nodeIndex = dirs.indexOf('node_modules');
@@ -297,7 +309,7 @@ export class ResolveIndex {
      * 
      * @memberOf ResolveIndex
      */
-    private async parseResources(files: TsFile[], cancellationToken?: CancellationToken): Promise<Resources> {
+    private async parseResources(files: TsFile[] = [], cancellationToken?: CancellationToken): Promise<Resources> {
         let parsedResources: Resources = {};
 
         for (let file of files) {
@@ -324,8 +336,9 @@ export class ResolveIndex {
                 return;
             }
             let resource = parsedResources[key];
-            resource.declarations = resource.declarations
-                .filter(o => o instanceof TsExportableDeclaration && o.isExported);
+            resource.declarations = resource.declarations.filter(
+                o => (o instanceof TsExportableDeclaration || o instanceof TsTypedExportableDeclaration) && o.isExported
+            );
             this.processResourceExports(parsedResources, resource);
         }
 
@@ -423,7 +436,9 @@ export class ResolveIndex {
                 }
             } else {
                 if (ex instanceof TsAssignedExport) {
-                    for (let lib of ex.exported.filter(o => !(o instanceof TsExportableDeclaration))) {
+                    for (let lib of ex.exported.filter(
+                        o => !(o instanceof TsExportableDeclaration) && !(o instanceof TsTypedExportableDeclaration))
+                    ) {
                         this.processResourceExports(parsedResources, lib as TsResource, processedResources);
                     }
                     this.processAssignedExport(parsedResources, ex, resource);
@@ -500,11 +515,14 @@ export class ResolveIndex {
         exportingLib: TsResource
     ): void {
         tsExport.exported.forEach(exported => {
-            if (exported instanceof TsExportableDeclaration) {
+            if (exported instanceof TsExportableDeclaration || exported instanceof TsTypedExportableDeclaration) {
                 exportingLib.declarations.push(exported);
             } else {
                 exportingLib.declarations.push(
-                    ...exported.declarations.filter(o => o instanceof TsExportableDeclaration && o.isExported)
+                    ...exported.declarations.filter(
+                        o => (o instanceof TsExportableDeclaration || o instanceof TsTypedExportableDeclaration) &&
+                            o.isExported
+                    )
                 );
                 exported.declarations = [];
             }

src/extensions/CodeFixExtension.ts

@@ -28,10 +28,24 @@ export class CodeFixExtension extends BaseExtension {
         this.logger.info('Extension instantiated.');
     }
 
+    /**
+     * Returns command items for this extension.
+     * 
+     * @returns {CommandQuickPickItem[]}
+     * 
+     * @memberOf CodeFixExtension
+     */
     public getGuiCommands(): CommandQuickPickItem[] {
         return [];
     }
 
+    /**
+     * Initializes the extension.
+     * 
+     * @param {ExtensionContext} context
+     * 
+     * @memberOf CodeFixExtension
+     */
     public initialize(context: ExtensionContext): void {
         context.subscriptions.push(commands.registerCommand(
             'typescriptHero.codeFix.executeCodeAction',
@@ -41,6 +55,12 @@ export class CodeFixExtension extends BaseExtension {
         this.logger.info('Initialized.');
     }
 
+    /**
+     * Disposes the extension.
+     * 
+     * 
+     * @memberOf CodeFixExtension
+     */
     public dispose(): void {
         this.logger.info('Dispose called.');
     }

src/extensions/ResolveExtension.ts

@@ -1,6 +1,6 @@
 import { ResolveIndex } from '../caches/ResolveIndex';
-import { DocumentController } from '../controllers/DocumentController';
 import { ExtensionConfig } from '../ExtensionConfig';
+import { ImportManager } from '../managers/ImportManager';
 import { CommandQuickPickItem, ResolveQuickPickItem } from '../models/QuickPickItems';
 import { TshCommand } from '../models/TshCommand';
 import { TsResourceParser } from '../parser/TsResourceParser';
@@ -29,6 +29,13 @@ const resolverOk = 'Resolver $(check)',
     TYPESCRIPT = 'typescript',
     TYPESCRIPT_REACT = 'typescriptreact';
 
+/**
+ * Compares the ignorepatterns (if they have the same elements ignored).
+ * 
+ * @param {string[]} local
+ * @param {string[]} config
+ * @returns {boolean}
+ */
 function compareIgnorePatterns(local: string[], config: string[]): boolean {
     if (local.length !== config.length) {
         return false;
@@ -78,6 +85,13 @@ export class ResolveExtension extends BaseExtension {
         this.logger.info('Extension instantiated.');
     }
 
+    /**
+     * Returns command items for this extension.
+     * 
+     * @returns {CommandQuickPickItem[]}
+     * 
+     * @memberOf ResolveExtension
+     */
     public getGuiCommands(): CommandQuickPickItem[] {
         return [
             new CommandQuickPickItem(
@@ -113,6 +127,13 @@ export class ResolveExtension extends BaseExtension {
         ];
     }
 
+    /**
+     * Initializes the extension.
+     * 
+     * @param {ExtensionContext} context
+     * 
+     * @memberOf ResolveExtension
+     */
     public initialize(context: ExtensionContext): void {
         context.subscriptions.push(
             commands.registerTextEditorCommand('typescriptHero.resolve.addImport', () => this.addImport())
@@ -176,6 +197,12 @@ export class ResolveExtension extends BaseExtension {
         this.logger.info('Initialized.');
     }
 
+    /**
+     * Disposes the extension.
+     * 
+     * 
+     * @memberOf ResolveExtension
+     */
     public dispose(): void {
         this.logger.info('Dispose called.');
     }
@@ -255,7 +282,7 @@ export class ResolveExtension extends BaseExtension {
             return;
         }
         try {
-            let ctrl = await DocumentController.create(window.activeTextEditor.document);
+            let ctrl = await ImportManager.create(window.activeTextEditor.document);
             await ctrl.addMissingImports(this.index).commit();
         } catch (e) {
             this.logger.error('An error happend during import fixing', e);
@@ -273,7 +300,7 @@ export class ResolveExtension extends BaseExtension {
      */
     private async organizeImports(): Promise<boolean> {
         try {
-            let ctrl = await DocumentController.create(window.activeTextEditor.document);
+            let ctrl = await ImportManager.create(window.activeTextEditor.document);
             return await ctrl.organizeImports().commit();
         } catch (e) {
             this.logger.error('An error happend during "organize imports".', { error: e });
@@ -291,7 +318,7 @@ export class ResolveExtension extends BaseExtension {
      * @memberOf ResolveExtension
      */
     private async addImportToDocument(item: ResolveQuickPickItem): Promise<boolean> {
-        let ctrl = await DocumentController.create(window.activeTextEditor.document);
+        let ctrl = await ImportManager.create(window.activeTextEditor.document);
         return await ctrl.addDeclarationImport(item.declarationInfo).commit();
     }
 

src/extensions/RestartDebuggerExtension.ts

@@ -39,6 +39,13 @@ export class RestartDebuggerExtension extends BaseExtension {
         this.logger.info('Extension instantiated.');
     }
 
+    /**
+     * Returns command items for this extension.
+     * 
+     * @returns {CommandQuickPickItem[]}
+     * 
+     * @memberOf RestartDebuggerExtension
+     */
     public getGuiCommands(): CommandQuickPickItem[] {
         return [
             new CommandQuickPickItem(
@@ -53,6 +60,13 @@ export class RestartDebuggerExtension extends BaseExtension {
         ];
     }
 
+    /**
+     * Initializes the extension.
+     * 
+     * @param {ExtensionContext} context
+     * 
+     * @memberOf RestartDebuggerExtension
+     */
     public initialize(context: ExtensionContext): void {
         this.configure();
         context.subscriptions.push(commands.registerCommand('typescriptHero.restartDebugger.toggle', () => {
@@ -65,6 +79,12 @@ export class RestartDebuggerExtension extends BaseExtension {
         this.logger.info('Initialized.');
     }
 
+    /**
+     * Disposes the extension.
+     * 
+     * 
+     * @memberOf RestartDebuggerExtension
+     */
     public dispose(): void {
         this.logger.info('Dispose called.');
         if (this.fileWatcher) {