Merge pull request wtlin1228#2 from wtlin1228/feature/database-support

add database support

Author: wtlin1228

.gitignore

@@ -1,2 +1,3 @@
 /target
 /outputs
+/database

Cargo.lock

@@ -4,6 +4,7 @@ members = [
     "crates/cli",
     "crates/demo",
     "crates/dt_core",
+    "crates/dt_database",
     "crates/dt_graph",
     "crates/dt_i18n",
     "crates/dt_parser",
@@ -23,3 +24,5 @@ serde_json      = "1.0"
 swc_core        = { version = "0.104.2", features = ["common", "ecma_ast", "ecma_visit", "ecma_plugin_transform"] }
 swc_ecma_parser = { version = "0.150.0", features = ["typescript"] }
 clap            = { version = "4.5", features = ["derive"] }
+rusqlite        = { version = "0.32.1", features = ["bundled"] }
+indicatif       = "0.17.8"

Cargo.toml

@@ -79,6 +79,7 @@ flowchart TD
 
 reexport all the library crates:
 
+- database
 - graph
 - i18n
 - parser
@@ -88,6 +89,12 @@ reexport all the library crates:
 - scheduler
 - tracker
 
+### Database
+
+`Database` defines the models using in the `cli` and `api_server` crate.
+
+![ERD](./assets/erd.jpeg)
+
 ### Graph
 
 `DependOnGraph` takes the `SymbolDependency` one by one to construct a DAG. You have to add the `SymbolDependency` by topological order so that `DependOnGraph` can handle the wildcard import and export for you.
@@ -203,11 +210,58 @@ let paths = dt.trace("<module_path>", TraceTarget::LocalVar("variable_name")).un
 
 ### Demo
 
-See the `demo` crate. You can run `cargo run --bin demo -- -s ./test-project/everybodyyyy -d ~/tmp`.
+See the `demo` crate.
 
-### Portable
+```
+Track fine-grained symbol dependency graph
+
+Usage: demo -s <SRC> -d <DST>
+
+Options:
+  -s <SRC>       Path of project to trace
+  -d <DST>       Path of the output folder
+  -h, --help     Print help
+  -V, --version  Print version
+```
+
+### CLI
+
+See the `cli` crate.
+
+```
+Parse a project and serialize its output
 
-See the `cli` crate. You can run `cargo run --bin cli -- -i <INPUT> -o <OUTPUT>`.
+Usage: cli <COMMAND>
+
+Commands:
+  portable  Parse and export the project in portable format
+  database  Parse and export the project in database format
+  help      Print this message or the help of the given subcommand(s)
+
+Options:
+  -h, --help     Print help
+  -V, --version  Print version
+```
+
+Usage:
+
+- `cli portable -i <INPUT> -t <TRANSLATION_PATH> -o <OUTPUT>`
+- `cli database -i <INPUT> -t <TRANSLATION_PATH> -o <OUTPUT>`
+
+### API Server
+
+see the `api_server` crate. The database is the one generated by CLI with `database` command.
+
+```
+Start the server to provide search API
+
+Usage: api_server --db <DB>
+
+Options:
+      --db <DB>  The path of your database
+  -h, --help     Print help
+  -V, --version  Print version
+```
 
 ## Client