dotupnet / dotup-vscode-interface-generator

vscode extension that generates interface from typescript class

Interface generator for Visual Studio Code

Description

Interface generator is a VSCode Extension which creates an interface definition from a typescript class. Supports import statements, comments, public properties and methods, generics and optional.

Given class:

export class ExtendsOnly<XY, TG extends string> extends ABC implements DEF {
  public NumberProperty: number = 2;
  OptionalStringProperty?: string;
}

Since interfaces can not implement anything, implements DEF is omitted.

Generated interface

export interface IExtendsOnly<XY, TG extends string> extends ABC {
  NumberProperty: number;
  OptionalStringProperty?: string;
}

Installation

You can browse and install extensions from within VS Code. Press Ctrl+P and narrow down the list commands by typing ext install dotup-vscode-interface-generator.

https://marketplace.visualstudio.com/items?itemName=dotup.dotup-vscode-interface-generator

Usage

1. Open a typescript file with one or more class definitions.

2. Press Ctrl+Shift+P to see all commands and start typing Generate interface and hit Enter.

The extension creates a new file in the same folder as the source file. The new file has the name of the source file prefixed with I. Existing files will be overwritten!

Release Notes

1.0.15

Fixes/Features:

• Packages not included

Release Notes

1.0.14

Fixes/Features:

• Explorer context menu "Generate interface"
• Error handling

1.0.13

Fixes/Features:

• Update readme :)

1.0.12

Fixes/Features:

• fix #1

1.0.11

Fixes/Features:

• take over comments ( For classes, methods and properties )

1.0.10

Fixes/Features:

• Readme: pictures not shown.
• Readme: Wrong 'Generate interface' example
• Icon added
• dependencies missed
• Wrong target path on Multi-root Workspaces
• prefix on interface name was missing
• video added

TODO:

• take over comments ( For classes, methods and properties )

Enjoy!

dotup-vscode-interface-generator's Issues

Converts Promise results to any

class myobject {
	public async compare(other: myobject): Promise<boolean> {
		return true;
	}
}

current output:

export interface Imyobject {
    compare(other: Imyobject): any;
}

expected output:

export interface Imyobject {
    compare(other: Imyobject): Promise<boolean>;
}

Fails if a class is using itself as argument in a method

If you have a class that uses itself in a function as argument it´s not adopting the name of that argument:

class myobject {
	public compare(other: myobject): boolean {
		return true;
	}
}

current output:

export interface Imyobject {
    compare(other: myobject): boolean;
}

expected output:

export interface Imyobject {
    compare(other: Imyobject): boolean;
}

Overwrites the whole resulting file instead of adopting only contents of the transformed objects

If you extend the generated interface with other interfaces, classes, properties they get los while transforming the source again.

Expctation would have been that it finds the transformed interface and only replaces the content but not the full file.

Does not parse partial classes missing generated public members

Generator does not handle partial classes. Some themself may have generated code. Example, MVVM Tool Kit [RelayCommand] and [ObserviableProperty]

ClassAnalyser throws error on methods without modifier

Looses multiple result options and transforms only to one

class myobject {
	public compare(other: myobject): number | undefined {
		return 0;
	}
}

Current output:

export interface Imyobject {
    compare(other: myobject): number;
}

expected output:

export interface Imyobject {
    compare(other: myobject): number | undefined;
}