chore: update the document (#2)

Cargo.toml

@@ -2,11 +2,11 @@
 authors = ["ImJeremyHe<[email protected]>"]
 edition = "2018"
 name = "gents"
-version = "0.3.1"
+version = "0.3.2"
 license = "MIT"
 description = "generate typescript interfaces from rust code"
-repository = "https://github.com/proclml/LogiSheets/tree/master/crates/gents"
-keywords = ["typescript", "interface"]
+repository = "https://github.com/ImJeremyHe/gents"
+keywords = ["Typescript", "interface", "ts-rs", "Rust"]
 
 [dev-dependencies]
-gents_derives = {version = "0.3.1", path = "./derives"}
+gents_derives = {version = "0.3.2", path = "./derives"}

README.md

@@ -27,7 +27,7 @@ this group files generated will be placed in the same directory. **Group** is se
 dependecies. Therefore, `gents` requires you specify the *file_name* on structs
 or enums and specify the *dir* on group, while `ts-rs` requires specifing the *path* on every item.
 
-- `gents` helps you manage the export files. `gents` gathers all the dependencies automatically.
+- `gents` helps you manage the export files. And it gathers all the dependencies automatically.
 
 - Code generated by `ts-rs` is not match our coding style.
 
@@ -38,8 +38,8 @@ In your **Rust** code:
 You should import `gents` in your Cargo.toml.
 
 ```toml
-gents = "0.3.0"
-gents_derives = "0.3.0"
+gents = "0.3"
+gents_derives = "0.3"
 ```
 
 ```rust

derives/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "gents_derives"
-version = "0.3.1"
+version = "0.3.2"
 description = "provides some macros for gents"
 authors = ["ImJeremyHe<[email protected]>"]
 license = "MIT"

derives/src/container.rs

@@ -42,7 +42,7 @@ impl<'a> Contianer<'a> {
                     file_name = Some(s.value());
                 }
                 Meta(NameValue(m)) if m.path == RENAME => {
-                    let s = get_lit_str(&m.lit).expect("file_name requires lit str");
+                    let s = get_lit_str(&m.lit).expect("rename requires lit str");
                     rename = Some(s.value());
                 }
                 _ => panic!("unexpected attr"),

src/lib.rs

@@ -1,3 +1,54 @@
+//! # gents
+//! `gents` is a tool for generating `Typescript` files.
+//! You can easily use `serde-json` to establish the communication between `Rust` and `Typescript`.
+//! It is useful when you are developing
+//! a web service or a wasm project.
+//! ## Step1: Derive TS and set the `file_name`.
+//! ```
+//! use gents_derives::TS;
+//!
+//! #[derive(TS)]
+//! #[ts(file_name = "person.ts")]
+//! pub struct Person {
+//!     pub age: u16,
+//! }
+//! ```
+//!
+//! ## Step2: Set your rename policy.
+//! Currently, you can set `camelCase` using `rename_all`, or you
+//! can rename each field by using `rename`.
+//! ```
+//! use gents_derives::TS;
+//!
+//! #[derive(TS)]
+//! #[ts(file_name = "person.ts", rename_all = "camelCase")]
+//! pub struct Person {
+//!     pub age: u16,
+//!     #[ts(rename="name")]
+//!     pub en_name: String,
+//! }
+//! ```
+//!
+//! ## Step3: Register your root structs or enums
+//! ```no_run
+//! use gents::FileGroup;
+//! use gents_derives::TS;
+//! #[derive(TS)]
+//! #[ts(file_name = "person.ts")]
+//! pub struct Person{}
+//!
+//! fn main() {
+//!     let mut g = FileGroup::new();
+//!     g.add::<Person>();
+//!     g.gen_files("outdir", false); // false for not generating index.ts
+//! }
+//! ```
+//! `.add` adds the target and its dependencies into the `FileGroup` and their files
+//! will be generated in the same time.
+//!
+//! ## Step4: Run the binary
+//!
+
 mod descriptor;
 mod file_generator;
 mod utils;

tests/test.rs

@@ -34,11 +34,34 @@ pub enum Pet {
     None,
 }
 
+#[derive(TS)]
+#[ts(file_name = "skip.ts", rename_all = "camelCase")]
+pub struct TestSkip {
+    pub f1: u16,
+    #[ts(skip = true)]
+    pub f2: u32,
+    pub f3: u64,
+}
+
 #[cfg(test)]
 mod tests {
     use super::*;
     use gents::*;
 
+    #[test]
+    fn gen_skip_test() {
+        let mut manager = DescriptorManager::default();
+        TestSkip::_register(&mut manager);
+        let (_, content) = manager.gen_data().into_iter().next().unwrap();
+        assert_eq!(
+            content.trim(),
+            r#"export interface TestSkip {
+    f1: number
+    f3: number
+}"#
+        )
+    }
+
     #[test]
     fn gen_data_person_test() {
         let mut manager = DescriptorManager::default();