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 graph_dominators;
69pub mod hex_util;
70pub mod id_prefix;
71pub mod index;
72pub mod iter_util;
73pub mod local_working_copy;
74pub mod lock;
75pub mod matchers;
76pub mod merge;
77pub mod merged_tree;
78pub mod merged_tree_builder;
79pub mod object_id;
80pub mod op_heads_store;
81pub mod op_store;
82pub mod op_walk;
83pub mod operation;
84#[expect(missing_docs)]
85pub mod protos;
86pub mod ref_name;
87pub mod refs;
88pub mod repo;
89pub mod repo_path;
90pub mod revset;
91mod revset_parser;
92pub mod rewrite;
93#[cfg(feature = "testing")]
94pub mod secret_backend;
95pub mod secure_config;
96pub mod settings;
97pub mod signing;
98pub mod tree_merge;
99// TODO: This file is mostly used for testing, whenever we no longer require it
100// in the lib it should be moved to the examples (e.g
101// "examples/simple-backend/").
102pub mod simple_backend;
103pub mod simple_op_heads_store;
104pub mod simple_op_store;
105pub mod ssh_signing;
106pub mod stacked_table;
107pub mod store;
108pub mod str_util;
109pub mod submodule_store;
110#[cfg(feature = "testing")]
111pub mod test_signing_backend;
112pub mod time_util;
113pub mod trailer;
114pub mod transaction;
115pub mod tree;
116pub mod tree_builder;
117pub mod union_find;
118pub mod view;
119pub mod working_copy;
120pub mod workspace;
121pub mod workspace_store;
122
123#[cfg(test)]
124mod tests {
125    use tempfile::TempDir;
126
127    // Copied from `testutils::TestResult` to remove dependency cycle.
128    pub type TestResult<T = ()> = eyre::Result<T>;
129
130    /// Unlike `testutils::new_temp_dir()`, this function doesn't set up
131    /// hermetic Git environment.
132    pub fn new_temp_dir() -> TempDir {
133        tempfile::Builder::new()
134            .prefix("jj-test-")
135            .tempdir()
136            .unwrap()
137    }
138}