Skip to content

ianhlavats/TypeScriptUML

 
 

Repository files navigation

TypeScript Extension for StarUML 2

This extension for StarUML(http://staruml.io) support to generate TypeScript code from UML model and to reverse Java code to UML model. Install this extension from Extension Manager of StarUML. It is based on TypeScript 2.0 specification.

TypeScript Code Generation

  1. Click the menu (Tools > TypeScript > Generate Code...)
  2. Select a base model (or package) that will be generated to TypeScript.
  3. Select a folder where generated TypeScript source files will be placed.

Belows are the rules to convert from UML model elements to Java source codes.

UMLPackage

  • converted to TypeScript namespace (as a folder).

UMLClass

  • converted to TypeScript Class. (as a separate .ts file)
  • visibility to one of modifiers public, protected, private and none.
  • isAbstract property to abstract modifier.
  • isFinalSpecialization and isLeaf property to sealed modifier.
  • Default constructor is generated.
  • All contained types (UMLClass, UMLInterface, UMLEnumeration) are generated as inner type definition.
  • Documentation property to TypeScriptDoc comment.
  • Annotation Type is converted to TypeScript attribute class which extends System.Attribute and postfix of class is Attribute. (cf. class testAttribute:System.Attribute)

UMLAttribute

  • converted to TypeScript Field.
  • visibility property to one of modifiers public, protected, private and none.
  • name property to field identifier.
  • type property to field type.
  • multiplicity property to array type.
  • isStatic property to static modifier.
  • isLeaf property to sealed modifier.
  • defaultValue property to initial value.
  • Documentation property to TypeScriptDoc comment.

UMLOperation

  • converted to TypeScript Methods.
  • visibility property to one of modifiers public, protected, private and none.
  • name property to method identifier.
  • isAbstract property to abstract modifier.
  • isStatic property to static modifier.
  • UMLParameter to TypeScript Method Parameters.
  • UMLParameter's name property to parameter identifier.
  • UMLParameter's type property to type of parameter.
  • UMLParameter with direction = return to return type of method. When no return parameter, void is used.
  • UMLParameter with isReadOnly = true to sealed modifier of parameter.
  • Documentation property to TypeScriptDoc comment.

UMLInterface

  • converted to TypeScript Interface. (as a separate .ts file)
  • visibility property to one of modifiers public, protected, private and none.
  • Documentation property to TypeScriptDoc comment.

UMLEnumeration

  • converted to TypeScript enum. (as a separate .ts file)
  • visibility property to one of modifiers public, protected, private and none.
  • UMLEnumerationLiteral to literals of enum.

UMLAssociationEnd

  • converted to TypeScript Field.
  • visibility property to one of modifiers public, protected, private and none.
  • name property to field identifier.
  • type property to field type.
  • If multiplicity is one of 0..*, 1..*, *, then collection type (List<> when isOrdered = true or HashSet<>) is used.
  • defaultValue property to initial value.
  • Documentation property to JavaDoc comment.

UMLGeneralization

  • converted to TypeScript Extends (:).
  • Allowed only for UMLClass to UMLClass, and UMLInterface to UMLInterface.

UMLInterfaceRealization

  • converted to TypeScript Implements (:).
  • Allowed only for UMLClass to UMLInterface.

TypeScript Reverse Engineering

  1. Click the menu (Tools > TypeScript > Reverse Code...)
  2. Select a folder containing TypeScript source files to be converted to UML model elements.
  3. CsharpReverse model will be created in the Project.

Belows are the rules to convert from TypeScript source code to UML model elements.

TypeScript Namespace

  • converted to UMLPackage.

TypeScript Class

  • converted to UMLClass.
  • Class name to name property.
  • Type parameters to UMLTemplateParameter.
  • Access modifier public, protected and private to visibility property.
  • abstract modifier to isAbstract property.
  • sealed modifier to isLeaf property.
  • Constructors to UMLOperation with stereotype <<constructor>>.
  • All contained types (UMLClass, UMLInterface, UMLEnumeration) are generated as inner type definition.

TypeScript Field (to UMLAttribute)

  • converted to UMLAttribute if "Use Association" is off in Preferences.

  • Field type to type property.

    • Primitive Types : type property has the primitive type name as string.
    • T[](array) or its decendants: type property refers to T with multiplicity *.
    • T (User-Defined Types) : type property refers to the T type.
    • Otherwise : type property has the type name as string.
  • Access modifier public, protected and private to visibility property.

  • static modifier to isStatic property.

  • sealed modifier to isLeaf and isReadOnly property.

  • Initial value to defaultValue property.

TypeScript Field (to UMLAssociation)

  • converted to (Directed) UMLAssociation if "Use Association" is on in Preferences and there is a UML type element (UMLClass, UMLInterface, or UMLEnumeration) correspond to the field type.

  • Field type to end2.reference property.

    • T[](array) or its decendants: reference property refers to T with multiplicity *.
    • T (User-Defined Types) : reference property refers to the T type.
    • Otherwise : converted to UMLAttribute, not UMLAssociation.
  • Access modifier public, protected and private to visibility property.

TypeScript Method

  • converted to UMLOperation.
  • Type parameters to UMLTemplateParameter.
  • Access modifier public, protected and private to visibility property.
  • static modifier to isStatic property.
  • abstract modifier to isAbstract property.
  • sealed modifier to isLeaf property.

TypeScript Interface

  • converted to UMLInterface.
  • Class name to name property.
  • Type parameters to UMLTemplateParameter.
  • Access modifier public, protected and private to visibility property.

TypeScript Enum

  • converted to UMLEnumeration.
  • Enum name to name property.
  • Type parameters to UMLTemplateParameter.
  • Access modifier public, protected and private to visibility property.
  • Enum constants are converted to UMLEnumerationLiteral.

TypeScript AnnotationType

  • converted to UMLClass with stereotype <<annotationType>>.
  • Annotation type elements to UMLOperation. (Default value to a Tag with name="default").

Licensed under the MIT license (see LICENSE file).

About

TyepScript extension for StarUML 2

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%