Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jpablo/type-explorer
Code exploration via diagrams
https://github.com/jpablo/type-explorer
Last synced: about 2 months ago
JSON representation
Code exploration via diagrams
- Host: GitHub
- URL: https://github.com/jpablo/type-explorer
- Owner: jpablo
- License: apache-2.0
- Created: 2021-09-27T07:35:11.000Z (over 3 years ago)
- Default Branch: dev
- Last Pushed: 2024-09-18T07:32:59.000Z (4 months ago)
- Last Synced: 2024-09-18T10:23:02.125Z (4 months ago)
- Language: Scala
- Homepage:
- Size: 7.26 MB
- Stars: 18
- Watchers: 3
- Forks: 0
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Type Explorer
Explore the types of your Scala code in a visual way.
# Install
Download the latest release from [here](https://github.com/juanpablo-r/type-explorer/releases).
Unzip the file and add `type-explorer-$version/bin` to your `$PATH`.
There are two files in the `bin` folder:
- `type-explorer`: The main executable
- `type-explorer-compile-project.sh`: A script to compile your project with semanticdb enabled.
## Requirements
- JVM 8 or higher
- SBT based project
# Compile your code
`type-explorer-compile-project.sh` will compile the project in the current directory.
```bash
❯ cd akka-persistence-jdbc
❯ type-explorer-compile-project.sh
```
To compile a single module:
```bash
❯ type-explorer-compile-project.sh module-name
```
# Run
```bash
❯ type-explorer
--------------------------------------------------
Welcome to Type Explorer!
name: type-explorer-shared, version: 0.2.0, scalaVersion: 3.3.1, sbtVersion: 1.9.6
Open your browser at http://localhost:8090/
Press Ctrl-C to stop the server
--------------------------------------------------
```
# Examples
Scala standard library.
```bash
❯ git clone https://github.com/scala/scala.git
❯ cd scala
❯ pwd
/Users/jpablo/GitHub/scala
❯ type-explorer-compile-project.sh
❯ find . -name "*.semanticdb" | wc -l
1215
```
Initial screen
Select folder containing semanticdb files and name project
Add a type to the diagram
Add all parents
# License
[License](./LICENSE)
Copyright 2024 Juan Pablo Romero and the type-explorer contributors.