Detect buffer newline style and honor it when saving

This commit is contained in:
Antonio Scandurra 2022-07-04 17:25:19 +02:00
parent f9bad2d81d
commit 3480b50920
8 changed files with 136 additions and 33 deletions

View file

@ -1,6 +1,7 @@
use anyhow::{anyhow, Result};
use fsevent::EventStream;
use futures::{Stream, StreamExt};
use language::NewlineStyle;
use smol::io::{AsyncReadExt, AsyncWriteExt};
use std::{
io,
@ -21,7 +22,7 @@ pub trait Fs: Send + Sync {
async fn remove_file(&self, path: &Path, options: RemoveOptions) -> Result<()>;
async fn open_sync(&self, path: &Path) -> Result<Box<dyn io::Read>>;
async fn load(&self, path: &Path) -> Result<String>;
async fn save(&self, path: &Path, text: &Rope) -> Result<()>;
async fn save(&self, path: &Path, text: &Rope, newline_style: NewlineStyle) -> Result<()>;
async fn canonicalize(&self, path: &Path) -> Result<PathBuf>;
async fn is_file(&self, path: &Path) -> bool;
async fn metadata(&self, path: &Path) -> Result<Option<Metadata>>;
@ -169,12 +170,19 @@ impl Fs for RealFs {
Ok(text)
}
async fn save(&self, path: &Path, text: &Rope) -> Result<()> {
async fn save(&self, path: &Path, text: &Rope, newline_style: NewlineStyle) -> Result<()> {
let buffer_size = text.summary().bytes.min(10 * 1024);
let file = smol::fs::File::create(path).await?;
let mut writer = smol::io::BufWriter::with_capacity(buffer_size, file);
let mut newline = false;
for chunk in text.chunks() {
writer.write_all(chunk.as_bytes()).await?;
for line in chunk.split('\n') {
if newline {
writer.write_all(newline_style.as_str().as_bytes()).await?;
}
writer.write_all(line.as_bytes()).await?;
newline = true;
}
}
writer.flush().await?;
Ok(())
@ -646,7 +654,7 @@ impl Fs for FakeFs {
Ok(text.clone())
}
async fn save(&self, path: &Path, text: &Rope) -> Result<()> {
async fn save(&self, path: &Path, text: &Rope, newline_style: NewlineStyle) -> Result<()> {
self.simulate_random_delay().await;
let mut state = self.state.lock().await;
let path = normalize_path(path);
@ -655,7 +663,11 @@ impl Fs for FakeFs {
if entry.metadata.is_dir {
Err(anyhow!("cannot overwrite a directory with a file"))
} else {
entry.content = Some(text.chunks().collect());
entry.content = Some(
text.chunks()
.map(|chunk| chunk.replace('\n', newline_style.as_str()))
.collect(),
);
entry.metadata.mtime = SystemTime::now();
state.emit_event(&[path]).await;
Ok(())

View file

@ -6054,7 +6054,7 @@ mod tests {
use gpui::{executor::Deterministic, test::subscribe};
use language::{
tree_sitter_rust, tree_sitter_typescript, Diagnostic, FakeLspAdapter, LanguageConfig,
OffsetRangeExt, Point, ToPoint,
NewlineStyle, OffsetRangeExt, Point, ToPoint,
};
use lsp::Url;
use serde_json::json;
@ -8547,9 +8547,13 @@ mod tests {
assert!(!buffer.has_conflict());
});
let new_contents = "AAAA\naaa\nBB\nbbbbb\n";
fs.save("/dir/the-file".as_ref(), &new_contents.into())
.await
.unwrap();
fs.save(
"/dir/the-file".as_ref(),
&new_contents.into(),
NewlineStyle::Unix,
)
.await
.unwrap();
// Because the buffer was not modified, it is reloaded from disk. Its
// contents are edited according to the diff between the old and new
@ -8584,6 +8588,7 @@ mod tests {
fs.save(
"/dir/the-file".as_ref(),
&"\n\n\nAAAA\naaa\nBB\nbbbbb\n".into(),
NewlineStyle::Unix,
)
.await
.unwrap();

View file

@ -24,7 +24,7 @@ use gpui::{
};
use language::{
proto::{deserialize_version, serialize_version},
Buffer, DiagnosticEntry, PointUtf16, Rope,
Buffer, DiagnosticEntry, NewlineStyle, PointUtf16, Rope,
};
use lazy_static::lazy_static;
use parking_lot::Mutex;
@ -595,7 +595,7 @@ impl LocalWorktree {
let text = buffer.as_rope().clone();
let fingerprint = text.fingerprint();
let version = buffer.version();
let save = self.write_file(path, text, cx);
let save = self.write_file(path, text, buffer.newline_style(), cx);
let handle = cx.handle();
cx.as_mut().spawn(|mut cx| async move {
let entry = save.await?;
@ -636,9 +636,10 @@ impl LocalWorktree {
&self,
path: impl Into<Arc<Path>>,
text: Rope,
newline_style: NewlineStyle,
cx: &mut ModelContext<Worktree>,
) -> Task<Result<Entry>> {
self.write_entry_internal(path, Some(text), cx)
self.write_entry_internal(path, Some((text, newline_style)), cx)
}
pub fn delete_entry(
@ -754,7 +755,7 @@ impl LocalWorktree {
fn write_entry_internal(
&self,
path: impl Into<Arc<Path>>,
text_if_file: Option<Rope>,
text_if_file: Option<(Rope, NewlineStyle)>,
cx: &mut ModelContext<Worktree>,
) -> Task<Result<Entry>> {
let path = path.into();
@ -763,8 +764,8 @@ impl LocalWorktree {
let fs = self.fs.clone();
let abs_path = abs_path.clone();
async move {
if let Some(text) = text_if_file {
fs.save(&abs_path, &text).await
if let Some((text, newline_style)) = text_if_file {
fs.save(&abs_path, &text, newline_style).await
} else {
fs.create_dir(&abs_path).await
}
@ -1653,6 +1654,7 @@ impl language::File for File {
buffer_id: u64,
text: Rope,
version: clock::Global,
newline_style: NewlineStyle,
cx: &mut MutableAppContext,
) -> Task<Result<(clock::Global, String, SystemTime)>> {
self.worktree.update(cx, |worktree, cx| match worktree {
@ -1660,7 +1662,7 @@ impl language::File for File {
let rpc = worktree.client.clone();
let project_id = worktree.share.as_ref().map(|share| share.project_id);
let fingerprint = text.fingerprint();
let save = worktree.write_file(self.path.clone(), text, cx);
let save = worktree.write_file(self.path.clone(), text, newline_style, cx);
cx.background().spawn(async move {
let entry = save.await?;
if let Some(project_id) = project_id {
@ -2841,6 +2843,7 @@ mod tests {
tree.as_local().unwrap().write_file(
Path::new("tracked-dir/file.txt"),
"hello".into(),
Default::default(),
cx,
)
})
@ -2850,6 +2853,7 @@ mod tests {
tree.as_local().unwrap().write_file(
Path::new("ignored-dir/file.txt"),
"world".into(),
Default::default(),
cx,
)
})