cargo-json-docs 0.5.0

package/test/json.test.js

@@ -0,0 +1,24 @@
+import { test, expect } from 'vitest';
+import { DocumentationSource } from '../src/json';
+test('can get modification time', () => {
+    const source = new DocumentationSource('test/test_crate');
+    const modTime = source.lastModified();
+    expect(modTime).toBeInstanceOf(Date);
+    expect(modTime.getTime()).toBeGreaterThan(0);
+});
+test('can determine if generation is needed', () => {
+    const source = new DocumentationSource('test/test_crate');
+    const needsGen = source.shouldGenerate();
+    expect(typeof needsGen).toBe('boolean');
+});
+test('can generate JSON', () => {
+    const source = new DocumentationSource('test/test_crate');
+    source.generateJson();
+    let json = source.getJson();
+    expect(json).toBeDefined();
+    expect(json.index).toBeDefined();
+    // Should not be stale
+    const needsGenAfter = source.shouldGenerate();
+    expect(needsGenAfter).toBe(false);
+}, 10000); // Allow up to 10 seconds for generation
+//# sourceMappingURL=json.test.js.map

package/test/json.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"json.test.js","sourceRoot":"","sources":["json.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEtC,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAElD,IAAI,CAAC,2BAA2B,EAAE,GAAG,EAAE;IACnC,MAAM,MAAM,GAAG,IAAI,mBAAmB,CAAC,iBAAiB,CAAC,CAAC;IAC1D,MAAM,OAAO,GAAG,MAAM,CAAC,YAAY,EAAE,CAAC;IACtC,MAAM,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IACrC,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;AACjD,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,uCAAuC,EAAE,GAAG,EAAE;IAC/C,MAAM,MAAM,GAAG,IAAI,mBAAmB,CAAC,iBAAiB,CAAC,CAAC;IAC1D,MAAM,QAAQ,GAAG,MAAM,CAAC,cAAc,EAAE,CAAC;IACzC,MAAM,CAAC,OAAO,QAAQ,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;AAC5C,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,mBAAmB,EAAE,GAAG,EAAE;IAC3B,MAAM,MAAM,GAAG,IAAI,mBAAmB,CAAC,iBAAiB,CAAC,CAAC;IAC1D,MAAM,CAAC,YAAY,EAAE,CAAC;IAEtB,IAAI,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;IAC5B,MAAM,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC;IAC3B,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;IAEjC,sBAAsB;IACtB,MAAM,aAAa,GAAG,MAAM,CAAC,cAAc,EAAE,CAAC;IAC9C,MAAM,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AACtC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,wCAAwC"}

package/test/json.test.ts

@@ -0,0 +1,29 @@
+import { test, expect } from 'vitest';
+
+import { DocumentationSource } from '../src/json';
+
+test('can get modification time', () => {
+    const source = new DocumentationSource('test/test_crate');
+    const modTime = source.lastModified();
+    expect(modTime).toBeInstanceOf(Date);
+    expect(modTime.getTime()).toBeGreaterThan(0);
+});
+
+test('can determine if generation is needed', () => {
+    const source = new DocumentationSource('test/test_crate');
+    const needsGen = source.shouldGenerate();
+    expect(typeof needsGen).toBe('boolean');
+});
+
+test('can generate JSON', () => {
+    const source = new DocumentationSource('test/test_crate');
+    source.generateJson();
+
+    let json = source.getJson();
+    expect(json).toBeDefined();
+    expect(json.index).toBeDefined();
+
+    // Should not be stale
+    const needsGenAfter = source.shouldGenerate();
+    expect(needsGenAfter).toBe(false);
+}, 10000); // Allow up to 10 seconds for generation

package/test/test_crate/Cargo.lock

@@ -0,0 +1,74 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 4
+
+[[package]]
+name = "proc-macro2"
+version = "1.0.105"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "535d180e0ecab6268a3e718bb9fd44db66bbbc256257165fc699dadf70d16fe7"
+dependencies = [
+ "unicode-ident",
+]
+
+[[package]]
+name = "quote"
+version = "1.0.43"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "dc74d9a594b72ae6656596548f56f667211f8a97b3d4c3d467150794690dc40a"
+dependencies = [
+ "proc-macro2",
+]
+
+[[package]]
+name = "serde"
+version = "1.0.228"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9a8e94ea7f378bd32cbbd37198a4a91436180c5bb472411e48b5ec2e2124ae9e"
+dependencies = [
+ "serde_core",
+]
+
+[[package]]
+name = "serde_core"
+version = "1.0.228"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "41d385c7d4ca58e59fc732af25c3983b67ac852c1a25000afe1175de458b67ad"
+dependencies = [
+ "serde_derive",
+]
+
+[[package]]
+name = "serde_derive"
+version = "1.0.228"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d540f220d3187173da220f885ab66608367b6574e925011a9353e4badda91d79"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "syn"
+version = "2.0.114"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d4d107df263a3013ef9b1879b0df87d706ff80f65a86ea879bd9c31f9b307c2a"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "unicode-ident",
+]
+
+[[package]]
+name = "test_crate"
+version = "0.1.0"
+dependencies = [
+ "serde",
+]
+
+[[package]]
+name = "unicode-ident"
+version = "1.0.22"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9312f7c4f6ff9069b165498234ce8be658059c6728633667c526e27dc2cf1df5"

package/test/test_crate/Cargo.toml

@@ -0,0 +1,7 @@
+[package]
+name = "test_crate"
+version = "0.1.0"
+edition = "2024"
+
+[dependencies]
+serde = { version = "1.0" }

package/test/test_crate/src/lib.rs

@@ -0,0 +1,50 @@
+// function
+pub fn add(left: u64, right: u64) -> u64 {
+    left + right
+}
+
+// re-export
+pub use serde::{Serialize, Deserialize};
+
+pub mod nested_module {
+    pub use serde::ser::*;
+}
+
+pub struct TestStructPlain {
+    pub field1: u32,
+    pub field2: String,
+}
+impl TestStructPlain {
+    pub fn new(field1: u32, field2: String) -> Self {
+        Self { field1, field2 }
+    }
+}
+impl TestStructPlain {
+    pub fn method_plain(&self) -> String {
+        format!("field1: {}, field2: {}", self.field1, self.field2)
+    }
+}
+
+pub struct TestStructTuple(pub u32, pub String);
+impl TestStructTuple {
+    pub fn new(field1: u32, field2: String) -> Self {
+        Self(field1, field2)
+    }
+}
+
+pub const TEST_CONST: u32 = 42;
+pub type TestTypeAlias = u64;
+
+mod module_a;
+pub use module_a::TestEnum;
+
+pub mod module_b;
+
+#[macro_export]
+macro_rules! test_macro {
+    ($name:ident) => {
+        pub fn $name() -> String {
+            stringify!($name).to_string()
+        }
+    };
+}

package/test/test_crate/src/module_a.rs

@@ -0,0 +1,16 @@
+pub enum TestEnum {
+    VariantOne,
+    VariantTwo(u32),
+    VariantThree { name: String, value: u64 },
+}
+impl TestEnum {
+    pub fn describe(&self) -> String {
+        match self {
+            TestEnum::VariantOne => "This is Variant One".to_string(),
+            TestEnum::VariantTwo(v) => format!("This is Variant Two with value {}", v),
+            TestEnum::VariantThree { name, value } => {
+                format!("This is Variant Three with name {} and value {}", name, value)
+            }
+        }
+    }
+}

package/test/test_crate/src/module_b/inner_b.rs

@@ -0,0 +1,10 @@
+pub trait InnerBTrait {
+    type AssociatedType;
+    const ASSOCIATED_CONST: u32;
+
+    fn inner_method(&self) -> String;
+
+    fn provided_method(&self) -> String {
+        "This is a provided method from InnerBTrait".to_string()
+    }
+}

package/test/test_crate/src/module_b.rs

@@ -0,0 +1 @@
+pub mod inner_b;

package/tsconfig.json

@@ -0,0 +1,23 @@
+{
+  "compilerOptions": {
+    "outDir": "./dist",
+    "rootDir": "./src",
+
+    "module": "commonjs",
+    "target": "es2020",
+    "moduleResolution": "node",
+
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+
+    "strict": true,
+    "noUncheckedIndexedAccess": true,
+    "exactOptionalPropertyTypes": true,
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+
+    "typeRoots": ["./src", "./node_modules/@types"]
+  },
+  "include": ["src"]
+}