Skip to main content

jj_lib/
lib.rs

1// Copyright 2020 The Jujutsu Authors
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// https://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15//! Jujutsu version control system.
16
17#![warn(missing_docs)]
18#![deny(unused_must_use)]
19#![forbid(unsafe_code)]
20
21// Needed so that proc macros can be used inside jj_lib and by external crates
22// that depend on it.
23// See:
24// - https://github.com/rust-lang/rust/issues/54647#issuecomment-432015102
25// - https://github.com/rust-lang/rust/issues/54363
26extern crate self as jj_lib;
27
28#[macro_use]
29pub mod content_hash;
30
31pub mod absorb;
32pub mod annotate;
33pub mod backend;
34pub mod bisect;
35pub mod commit;
36pub mod commit_builder;
37pub mod config;
38mod config_resolver;
39pub mod conflict_labels;
40pub mod conflicts;
41pub mod copies;
42pub mod dag_walk;
43pub mod dag_walk_async;
44pub mod default_index;
45pub mod default_submodule_store;
46pub mod diff;
47pub mod diff_presentation;
48pub mod dsl_util;
49pub(crate) mod eol;
50pub mod evolution;
51pub mod extensions_map;
52pub mod file_util;
53pub mod files;
54pub mod fileset;
55mod fileset_parser;
56pub mod fix;
57pub mod fmt_util;
58pub mod fsmonitor;
59#[cfg(feature = "git")]
60pub mod git;
61#[cfg(feature = "git")]
62pub mod git_backend;
63#[cfg(feature = "git")]
64mod git_subprocess;
65pub mod gitignore;
66pub mod gpg_signing;
67pub mod graph;
68pub mod hex_util;
69pub mod id_prefix;
70pub mod index;
71pub mod iter_util;
72pub mod local_working_copy;
73pub mod lock;
74pub mod matchers;
75pub mod merge;
76pub mod merged_tree;
77pub mod merged_tree_builder;
78pub mod object_id;
79pub mod op_heads_store;
80pub mod op_store;
81pub mod op_walk;
82pub mod operation;
83#[expect(missing_docs)]
84pub mod protos;
85pub mod ref_name;
86pub mod refs;
87pub mod repo;
88pub mod repo_path;
89pub mod revset;
90mod revset_parser;
91pub mod rewrite;
92#[cfg(feature = "testing")]
93pub mod secret_backend;
94pub mod secure_config;
95pub mod settings;
96pub mod signing;
97pub mod tree_merge;
98// TODO: This file is mostly used for testing, whenever we no longer require it
99// in the lib it should be moved to the examples (e.g
100// "examples/simple-backend/").
101pub mod simple_backend;
102pub mod simple_op_heads_store;
103pub mod simple_op_store;
104pub mod ssh_signing;
105pub mod stacked_table;
106pub mod store;
107pub mod str_util;
108pub mod submodule_store;
109#[cfg(feature = "testing")]
110pub mod test_signing_backend;
111pub mod time_util;
112pub mod trailer;
113pub mod transaction;
114pub mod tree;
115pub mod tree_builder;
116pub mod union_find;
117pub mod view;
118pub mod working_copy;
119pub mod workspace;
120pub mod workspace_store;
121
122#[cfg(test)]
123mod tests {
124    use tempfile::TempDir;
125
126    // Copied from `testutils::TestResult` to remove dependency cycle.
127    pub type TestResult<T = ()> = eyre::Result<T>;
128
129    /// Unlike `testutils::new_temp_dir()`, this function doesn't set up
130    /// hermetic Git environment.
131    pub fn new_temp_dir() -> TempDir {
132        tempfile::Builder::new()
133            .prefix("jj-test-")
134            .tempdir()
135            .unwrap()
136    }
137}