Skip to content

Commit

Permalink
v2.0.2
Browse files Browse the repository at this point in the history
  • Loading branch information
Marcos Vinícius Rubido authored and Marcos Vinícius Rubido Sauda committed Jan 12, 2019
1 parent cf222be commit 2d571b7
Show file tree
Hide file tree
Showing 5 changed files with 109 additions and 98 deletions.
3 changes: 2 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ Will convert a Typescript file to a PlantUML file. Following all inheritances.
## Usage

```
./bin/tplant.js -i sample/SubClass.ts
npm install --global tplant
tplant --input sample/Classes/Greeter.ts > sample/Classes/Greeter.puml
```

# References
Expand Down
42 changes: 21 additions & 21 deletions package-lock.json
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

61 changes: 35 additions & 26 deletions package.json
View file
Original file line number Diff line number Diff line change
@@ -1,44 +1,53 @@
{
"name": "tplant",
"version": "2.0.1",
"version": "2.0.2",
"description": "Typescript to PlantUML",
"keywords": [
"Class Diagram",
"plantuml",
"typescript",
"uml"
],
"homepage": "https://github.com/bafolts/tplant#readme",
"bugs": {
"url": "https://github.com/bafolts/tplant/issues"
},
"repository": {
"type": "git",
"url": "git+https://github.com/bafolts/tplant.git"
},
"license": "ISC",
"author": "Brian Folts",
"contributors": [
"Marcos V. Rubido <[email protected]> (https://marcosvrs.com/)"
],
"files": [
"dist/*.js"
],
"main": "dist/index.js",
"types": "dist/index.d.ts",
"bin": {
"tplant": "dist/index.js"
},
"scripts": {
"build": "tsc",
"build:dev": "tsc --sourceMap -w",
"lint": "tslint -p .",
"lint:fix": "tslint -p . --fix",
"prepare": "npm run build",
"prepublishOnly": "npm test && npm run lint",
"test": "npm run build && mocha"
},
"dependencies": {
"commander": "^2.19.0",
"glob": "^7.1.3",
"typescript": "^3.2.2"
},
"devDependencies": {
"@types/glob": "^7.1.1",
"@types/node": "^10.12.15",
"@types/node": "^10.12.18",
"mocha": "^5.2.0",
"tslint": "^5.11.0",
"tslint": "^5.12.1",
"tslint-microsoft-contrib": "^6.0.0"
},
"scripts": {
"build": "tsc",
"build:dev": "tsc --sourceMap -w",
"test": "tsc && mocha"
},
"repository": {
"type": "git",
"url": "git+https://github.com/bafolts/tplant.git"
},
"keywords": [
"plantuml",
"typescript",
"uml",
"Class Diagram"
],
"author": "Brian Folts",
"contributors": ["Marcos V. Rubido <[email protected]> (https://marcosvrs.com/)"],
"license": "ISC",
"bugs": {
"url": "https://github.com/bafolts/tplant/issues"
},
"homepage": "https://github.com/bafolts/tplant#readme"
}
}
11 changes: 6 additions & 5 deletions src/generateDocumentation.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ export function generateDocumentation(fileNames: ReadonlyArray<string>, options:
}

function getMemberReturnType(symbol: ts.Symbol): string {
const returnType = getMemberType(symbol);
const returnType: MEMBER_TYPE = getMemberType(symbol);
if (returnType === MEMBER_TYPE.PROPERTY || returnType === MEMBER_TYPE.INDEX) {
return checker.typeToString(checker.getTypeOfSymbolAtLocation(symbol, symbol.valueDeclaration));
}
Expand Down Expand Up @@ -350,15 +350,16 @@ export function generateDocumentation(fileNames: ReadonlyArray<string>, options:

if ((<ts.ClassLikeDeclarationBase>symbol.valueDeclaration).members !== undefined) {
(<ts.ClassLikeDeclarationBase>symbol.valueDeclaration).members.forEach((memberName: ts.ClassElement): void => {
const symbol: ts.Symbol | void = checker.getSymbolAtLocation((<ts.MethodDeclaration | ts.PropertyDeclaration>memberName).name);
if (symbol === undefined) {
const classSymbol: ts.Symbol | void = checker.getSymbolAtLocation(
(<ts.MethodDeclaration | ts.PropertyDeclaration>memberName).name);
if (classSymbol === undefined) {
return;
}
const serializedMember: ISerializeMember | void = serializeMember(symbol);
const serializedMember: ISerializeMember | void = serializeMember(classSymbol);
if (serializedMember === undefined) {
return;
}
if (!details.members.some(e => e.name === serializedMember.name)) {
if (!details.members.some((e: ISerializeMember) => e.name === serializedMember.name)) {
details.members.push(serializedMember);
}
});
Expand Down
90 changes: 45 additions & 45 deletions tsconfig.json
View file
Original file line number Diff line number Diff line change
@@ -1,56 +1,56 @@
{
"compilerOptions": {
/* Basic Options */
"target": "es5", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017','ES2018' or 'ESNEXT'. */
"module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
// "lib": [], /* Specify library files to be included in the compilation. */
"allowJs": true, /* Allow javascript files to be compiled. */
"checkJs": true, /* Report errors in .js files. */
// "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
// "declaration": true, /* Generates corresponding '.d.ts' file. */
// "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
// "sourceMap": true, /* Generates corresponding '.map' file. */
// "outFile": "./dist/index.js", /* Concatenate and emit output to single file. */
"outDir": "./dist/", /* Redirect output structure to the directory. */
// "rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
// "composite": true, /* Enable project compilation */
"removeComments": true, /* Do not emit comments to output. */
// "noEmit": true, /* Do not emit outputs. */
// "importHelpers": true, /* Import emit helpers from 'tslib'. */
// "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
// "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
"target": "es5", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017','ES2018' or 'ESNEXT'. */
"module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
// "lib": [], /* Specify library files to be included in the compilation. */
// "allowJs": true, /* Allow javascript files to be compiled. */
// "checkJs": true, /* Report errors in .js files. */
// "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
"declaration": true, /* Generates corresponding '.d.ts' file. */
// "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
// "sourceMap": true, /* Generates corresponding '.map' file. */
// "outFile": "./dist/index.js", /* Concatenate and emit output to single file. */
"outDir": "./dist" , /* Redirect output structure to the directory. */
// "rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
// "composite": true, /* Enable project compilation */
"removeComments": true, /* Do not emit comments to output. */
// "noEmit": true, /* Do not emit outputs. */
// "importHelpers": true, /* Import emit helpers from 'tslib'. */
// "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
// "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
/* Strict Type-Checking Options */
"strict": true, /* Enable all strict type-checking options. */
"noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
"strictNullChecks": true, /* Enable strict null checks. */
// "strictFunctionTypes": true, /* Enable strict checking of function types. */
// "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
// "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
// "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
// "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */
"strict": true, /* Enable all strict type-checking options. */
"noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
"strictNullChecks": true, /* Enable strict null checks. */
// "strictFunctionTypes": true, /* Enable strict checking of function types. */
// "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
// "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
// "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
// "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */
/* Additional Checks */
// "noUnusedLocals": true, /* Report errors on unused locals. */
// "noUnusedParameters": true, /* Report errors on unused parameters. */
// "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
// "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */
// "noUnusedLocals": true, /* Report errors on unused locals. */
// "noUnusedParameters": true, /* Report errors on unused parameters. */
// "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
// "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */
/* Module Resolution Options */
// "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
// "baseUrl": "./", /* Base directory to resolve non-absolute module names. */
// "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
// "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
// "typeRoots": [], /* List of folders to include type definitions from. */
// "types": [], /* Type declaration files to be included in compilation. */
// "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
"esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
// "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */
// "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
// "baseUrl": "./", /* Base directory to resolve non-absolute module names. */
// "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
// "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
// "typeRoots": [], /* List of folders to include type definitions from. */
// "types": [], /* Type declaration files to be included in compilation. */
// "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
"esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
// "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */
/* Source Map Options */
// "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
// "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
// "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
// "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
/* Experimental Options */
// "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
// "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */
// "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
// "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */
},
"include": [
"src/**/*.ts"
Expand Down

0 comments on commit 2d571b7

Please sign in to comment.