Skip to content

Commit

Permalink
added package.json; updated readme to have more details.
Browse files Browse the repository at this point in the history
  • Loading branch information
sdiemert committed Jul 15, 2015
1 parent 07a5dd1 commit 180243e
Show file tree
Hide file tree
Showing 4 changed files with 58 additions and 13 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,5 @@ out
gen


test/testModel1Output
test/testModel1Output
copyFiles.sh
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,39 @@
# StarUMLJS

JavaScript code generation plugin for StarUML diagramming tool.

## Current Status

* Currently supports one way generation of JS code from a UML model.
* Uses the standard prototype JS definition of a "class"

### Supported UML Concepts

* The tool currently supports a subset of the StarUML model:

* Classes
* Methods of classes (all treated as public)
* Attributes of classes
* Class Documentation
* Method Documentation
* Method Specification
* Method Precondition
* Method Postcondition
* Method Parameters
* Dependencies
* Direct Association
* Generalization


## Developers

* Please contribute, this project is by no means complete and is currently not stable.
* Open dev tasks are:
* Reverse code engineering
* Other "class" definition styles
* More advanced UML concept support

### Useful Links

* StarUML application page: [http://staruml.io/](http://staruml.io/)
* StarUML extension developer guide: [https://github.com/staruml/staruml-dev-docs/wiki](https://github.com/staruml/staruml-dev-docs/wiki)
14 changes: 2 additions & 12 deletions main.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@
*/

define(function (require, exports, module) {
"use strict";

var Commands = app.getModule('command/Commands');
var CommandManager = app.getModule("command/CommandManager");
var MenuManager = app.getModule("menu/MenuManager");
Expand All @@ -15,16 +13,8 @@ define(function (require, exports, module) {

var JSGen = require("JSCodeGenerator");

function handleHelloWorld() {

window.alert("hello world");

}

function handleGenerate(base, path, opts) {

console.log("handleGenerate()");

var result = new $.Deferred();

// If base is not assigned, popup ElementPicker
Expand Down Expand Up @@ -81,9 +71,9 @@ define(function (require, exports, module) {

}

var CMD = "tools.helloworld";
var CMD = "tools.javascript";

CommandManager.register("Hello World", CMD, handleGenerate);
CommandManager.register("Generate JavaScript", CMD, handleGenerate);

var menu = MenuManager.getMenu(Commands.TOOLS);

Expand Down
17 changes: 17 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"name": "sdiemert.starumljs",
"title": "StarUMLJS",
"description": "JavaScript Code Generation Plugin",
"homepage": "https://github.com/sdiemert/StarUMLJS",
"version": "0.1.0",
"keywords": ["javascript", "staruml", "js", "UML"],
"author": {
"name": "Simon Diemert",
"email": "[email protected]",
"url": "https://github.com/sdiemert"
},
"license": "MIT",
"engines": {
"staruml": ">=2.0.0"
}
}

0 comments on commit 180243e

Please sign in to comment.