( )⚙ D10912 rhg: add ui.plain() and check it before showing relative paths in status

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D10912

rhg: add ui.plain() and check it before showing relative paths in status
ClosedPublic

Authored by pulkit on Jun 25 2021, 5:34 AM.

Details

Reviewers
SimonSapin
martinvonz
Group Reviewers
hg-reviewers
Commits
rHG38deb65d4441: rhg: add ui.plain() and check it before showing relative paths in status
Summary

Adds a very basic replica of ui.plain().

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

pulkit created this revision.Jun 25 2021, 5:34 AM
SimonSapin added a subscriber: SimonSapin.Jun 25 2021, 5:48 AM
SimonSapin added inline comments.
rust/rhg/src/ui.rs
70–73

This can be spelled env::var("HGPLAIN").is_ok().

However env::var has two error cases. If we only want to check for the presence of a variable regardless of its Unicode validity, env::var_os("HGPLAIN").is_some() should be used instead.

baymax updated this revision to Diff 28698.Jun 25 2021, 7:59 AM

✅ refresh by Heptapod after a successful CI run (🐙 💚)

SimonSapin accepted this revision.Jun 29 2021, 11:54 AM
martinvonz accepted this revision.Oct 11 2021, 1:55 PM
This revision is now accepted and ready to land.Oct 11 2021, 1:55 PM

Revision Contents
Changeset List

PathPackages
Mrust/rhg/src/commands/status.rs (2 lines)
Mrust/rhg/src/ui.rs (20 lines)

Diff 30703

rust/rhg/src/commands/status.rs

status_prefix: &[u8], status_prefix: &[u8],
) -> Result<(), CommandError> { ) -> Result<(), CommandError> {
paths.sort_unstable(); paths.sort_unstable();
let mut relative: bool = let mut relative: bool =
config.get_bool(b"ui", b"relative-paths").unwrap_or(false); config.get_bool(b"ui", b"relative-paths").unwrap_or(false);
relative = config relative = config
.get_bool(b"commands", b"status.relative") .get_bool(b"commands", b"status.relative")
.unwrap_or(relative); .unwrap_or(relative);
if relative { if relative && !ui.plain() {
relativize_paths( relativize_paths(
repo, repo,
paths, paths,
|path: Cow<[u8]>| -> Result<(), UiError> { |path: Cow<[u8]>| -> Result<(), UiError> {
ui.write_stdout( ui.write_stdout(
&[status_prefix, b" ", path.as_ref(), b"\n"].concat(), &[status_prefix, b" ", path.as_ref(), b"\n"].concat(),
) )
}, },

rust/rhg/src/ui.rs

use format_bytes::format_bytes; use format_bytes::format_bytes;
use std::borrow::Cow; use std::borrow::Cow;
use std::env;
use std::io; use std::io;
use std::io::{ErrorKind, Write}; use std::io::{ErrorKind, Write};
#[derive(Debug)] #[derive(Debug)]
pub struct Ui { pub struct Ui {
stdout: std::io::Stdout, stdout: std::io::Stdout,
stderr: std::io::Stderr, stderr: std::io::Stderr,
} }
/// Write bytes to stderr /// Write bytes to stderr
pub fn write_stderr(&self, bytes: &[u8]) -> Result<(), UiError> { pub fn write_stderr(&self, bytes: &[u8]) -> Result<(), UiError> {
let mut stderr = self.stderr.lock(); let mut stderr = self.stderr.lock();
stderr.write_all(bytes).or_else(handle_stderr_error)?; stderr.write_all(bytes).or_else(handle_stderr_error)?;
stderr.flush().or_else(handle_stderr_error) stderr.flush().or_else(handle_stderr_error)
} }
/// is plain mode active
///
/// Plain mode means that all configuration variables which affect
/// the behavior and output of Mercurial should be
/// ignored. Additionally, the output should be stable,
/// reproducible and suitable for use in scripts or applications.
///
/// The only way to trigger plain mode is by setting either the
/// `HGPLAIN' or `HGPLAINEXCEPT' environment variables.
///
/// The return value can either be
/// - False if HGPLAIN is not set, or feature is in HGPLAINEXCEPT
/// - False if feature is disabled by default and not included in HGPLAIN
/// - True otherwise
pub fn plain(&self) -> bool {
// TODO: add support for HGPLAINEXCEPT
env::var_os("HGPLAIN").is_some()
}
} }
SimonSapinUnsubmitted
Not Done

This can be spelled env::var("HGPLAIN").is_ok().

However env::var has two error cases. If we only want to check for the presence of a variable regardless of its Unicode validity, env::var_os("HGPLAIN").is_some() should be used instead.

SimonSapin: This can be spelled `env::var("HGPLAIN").is_ok()`. However `env::var` has two error cases. If…
/// A buffered stdout writer for faster batch printing operations. /// A buffered stdout writer for faster batch printing operations.
pub struct StdoutBuffer<W: Write> { pub struct StdoutBuffer<W: Write> {
buf: io::BufWriter<W>, buf: io::BufWriter<W>,
} }
impl<W: Write> StdoutBuffer<W> { impl<W: Write> StdoutBuffer<W> {
pub fn new(writer: W) -> Self { pub fn new(writer: W) -> Self {
let buf = io::BufWriter::new(writer); let buf = io::BufWriter::new(writer);