Vis

Generate solution diagrams from code.

In essence, the tools detect variables and new expressions of certain types and translate that in a relationship graph. E.g. given

``typescript
interface IArchMarker {}

class Foo implements IArchMarker {}
class Bar implements IArchMarker {
constructor(private rel: Foo) {}
}

const fooNode = new Foo();
const barNode = new Bar(fooNode);

`

after executing
vis --acceptTypes IArchMarker

will produce something akin to

┌───────────────────┐ ┌──────────────────┐
│ │ │ │
│ barNode: Bar ├──────────► fooNode: Foo │
│ │ │ │
└───────────────────┘ └──────────────────┘

There are two tools available:

Vis

The all-in-one tool to generate an SVG from a codebase.

`sh vis
vis - Generate solution diagrams from code

Options:
--help Show help [boolean]
--version Show version number [boolean]
--acceptTypes List of regexes of base classes/types to include.
[array] [default: ["Archetype",".TerraformResource."]]
--includeFiles List of regexes of files to include. Defaults to accept
any. [array] [default: []]
--excludeFiles List of regexes of files to exclude.
[array] [default: ["maxim.*.ts"]]
--verbose Print debugging info onto stderr [boolean] [default: false]
--tsConfigPath Path of the tsconfig.json
[string] [default: "./tsconfig.json"]
--clusterAllTypes When specified will visually cluster all nodes of the same
type [boolean] [default: false]
--clusterTypes List of regexes of base classes/types to cluster together.
Defaults to Api [array] [default: ["Api"]]
--clusterNone Don't cluster together any types. When present, wins over
any other clustering options. [boolean] [default: false]

`

Code2graph

Prints a JSON of the graph to the stdout.
Here's an example from @arnoto/hello-world.architecture, using

`typescript
export const helloFunc = new Func({
code: () => ({ message: 'hello world' })
});

export const helloApi = new Api({
target: helloFunc
});
`

`json
❯ ./node_modules/.bin/code2graph
[
{
"name": "helloFunc",
"class": "Func",
"refs": [
"helloApi"
]
},
{
"name": "helloApi",
"class": "Api",
"refs": []
}
]
`

`sh code2graph
code2graph - parse a typescript project and print its architectural graph in
JSON

Options:
--help Show help [boolean]
--version Show version number [boolean]
--acceptTypes List of regexes of base classes/types to include.
[array] [default: ["Archetype",".TerraformResource."]]
--includeFiles List of regexes of files to include. Defaults to accept any.
[array] [default: []]
--excludeFiles List of regexes of files to exclude.
[array] [default: ["maxim.*.ts"]]
--verbose Print debugging info onto stderr [boolean] [default: false]
--tsConfigPath Path of the tsconfig.json[string] [default: "./tsconfig.json"]

`

On ts project references

By default, typescript will use d.ts files for cross-project references.
If, on the other hand, the library's package.json specifies types field to
point to src/main.ts, then the actual initialisation is found and references
are detected correctly.

E.g. good:

`typescript
export const helloFunc = new Func({
code: () => ({ message: 'hello world' })
});

export const helloApi = new Api({
target: helloFunc
});

`

Not so good (the target: helloFunc is lost):

`typescript
export declare const helloFunc: Func message: string;
}>;
export declare const helloApi: Api message: string;
}, void & Object>;

``