Skip to content

Split rustdoc JSON types into separately versioned crate #81287

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Jan 29, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update crate name and add README
  • Loading branch information
CraftSpider committed Jan 27, 2021
commit 67b78a027111090feccc8434ce9634c9f65ec34d
16 changes: 8 additions & 8 deletions Cargo.lock
Original file line number Diff line number Diff line change
Expand Up @@ -1637,13 +1637,6 @@ version = "0.11.15"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "92c245af8786f6ac35f95ca14feca9119e71339aaab41e878e7cdd655c97e9e5"

[[package]]
name = "json-types"
version = "0.1.0"
dependencies = [
"serde",
]

[[package]]
name = "jsondocck"
version = "0.1.0"
Expand Down Expand Up @@ -4393,17 +4386,24 @@ version = "0.0.0"
dependencies = [
"expect-test",
"itertools 0.9.0",
"json-types",
"minifier",
"pulldown-cmark 0.8.0",
"regex",
"rustc-rayon",
"rustdoc-json-types",
"serde",
"serde_json",
"smallvec 1.4.2",
"tempfile",
]

[[package]]
name = "rustdoc-json-types"
version = "0.1.0"
dependencies = [
"serde",
]

[[package]]
name = "rustdoc-themes"
version = "0.1.0"
Expand Down
2 changes: 1 addition & 1 deletion src/librustdoc/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ smallvec = "1.0"
tempfile = "3"
itertools = "0.9"
regex = "1"
json-types = { path = "../rustdoc-json-types" }
rustdoc-json-types = { path = "../rustdoc-json-types" }

[dev-dependencies]
expect-test = "1.0"
2 changes: 1 addition & 1 deletion src/librustdoc/json/conversions.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ use rustc_hir::def::CtorKind;
use rustc_span::def_id::{DefId, CRATE_DEF_INDEX};
use rustc_span::Pos;

use json_types::*;
use rustdoc_json_types::*;

use crate::clean;
use crate::formats::item_type::ItemType;
Expand Down
2 changes: 1 addition & 1 deletion src/librustdoc/json/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ use rustc_middle::ty::TyCtxt;
use rustc_session::Session;
use rustc_span::edition::Edition;

use json_types as types;
use rustdoc_json_types as types;

use crate::clean;
use crate::config::{RenderInfo, RenderOptions};
Expand Down
2 changes: 1 addition & 1 deletion src/rustdoc-json-types/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[package]
name = "json-types"
name = "rustdoc-json-types"
version = "0.1.0"
authors = ["The Rust Project Developers"]
edition = "2018"
Expand Down
12 changes: 12 additions & 0 deletions src/rustdoc-json-types/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Rustdoc JSON Types

This crate exposes the Rustdoc JSON API as a set of types with serde implementations.
These types are part of the public interface of the rustdoc JSON output, and making them
their own crate allows them to be versioned and distributed without having to depend on
any rustc/rustdoc internals. This way, consumers can rely on this crate for both documentation
of the output, and as a way to read the output easily, and its versioning is intended to
follow semver guarantees about the version of the format. JSON format X will always be
compatible with rustdoc-json-types version N.

Currently, this crate is only used by rustdoc itself. Upon the stabilization of
rustdoc-json, it may be start to be distributed separately for consumers of the API.