Skip to content
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

fix: handle source property that's a string literal #2

Merged
merged 1 commit into from
Nov 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
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
51 changes: 47 additions & 4 deletions src/format_text.rs
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,14 @@ pub fn format_text(
return Ok(None);
};

Ok(format_root(input_text, &root_value, format_with_host))
Ok(match format_root(input_text, &root_value, format_with_host) {
Some(text) => {
#[cfg(debug_assertions)]
validate_output_json(&text)?;
Some(text)
}
None => None,
})
}

fn format_root(
Expand All @@ -53,6 +60,29 @@ fn format_root(
}
}

#[cfg(debug_assertions)]
fn validate_output_json(text: &str) -> Result<()> {
// ensures the output is correct in debug mode
let result = jsonc_parser::parse_to_ast(
text,
&CollectOptions {
comments: false,
tokens: false,
},
&ParseOptions {
allow_comments: true,
allow_loose_object_property_names: false,
allow_trailing_commas: true,
},
);
match result {
Ok(_) => Ok(()),
Err(err) => {
anyhow::bail!("dprint-plugin-jupyter produced invalid json. Please open an issue with reproduction steps at https://github.com/dprint/dprint-plugin-jupyter/issues\n{:#}\n\n== TEXT ==\n{}", err, text);
}
}
}

fn get_cell_text_change(
file_text: &str,
cell: &jsonc_parser::ast::Value,
Expand All @@ -74,7 +104,11 @@ fn get_cell_text_change(
// many plugins will add a final newline, but that doesn't look nice in notebooks, so trim it off
let formatted_text = formatted_text.trim_end();

let new_text = build_json_text(formatted_text, code_block.indent_text);
let new_text = if code_block.is_array {
build_array_json_text(formatted_text, code_block.indent_text)
} else {
serde_json::to_string(&formatted_text).unwrap()
};

Some(TextChange {
range: code_block.replace_range,
Expand All @@ -83,6 +117,9 @@ fn get_cell_text_change(
}

struct CodeBlockText<'a> {
// Can be either a string or an array of strings.
// (https://github.com/jupyter/nbformat/blob/0708dd627d9ef81b12f231defb0d94dd7e80e3f4/nbformat/v4/nbformat.v4.5.schema.json#L460C7-L468C8)
is_array: bool,
indent_text: &'a str,
replace_range: std::ops::Range<usize>,
source: String,
Expand All @@ -91,8 +128,10 @@ struct CodeBlockText<'a> {
fn analyze_code_block<'a>(cell: &jsonc_parser::ast::Object<'a>, file_text: &'a str) -> Option<CodeBlockText<'a>> {
let mut indent_text = "";
let mut replace_range = std::ops::Range::default();
let mut is_array = false;
let cell_source = match &cell.get("source")?.value {
jsonc_parser::ast::Value::Array(items) => {
is_array = true;
let mut strings = Vec::with_capacity(items.elements.len());
for (i, element) in items.elements.iter().enumerate() {
let string_lit = element.as_string_lit()?;
Expand All @@ -112,18 +151,22 @@ fn analyze_code_block<'a>(cell: &jsonc_parser::ast::Object<'a>, file_text: &'a s
}
text
}
jsonc_parser::ast::Value::StringLit(string) => string.value.to_string(),
jsonc_parser::ast::Value::StringLit(string) => {
replace_range = string.range.start..string.range.end;
string.value.to_string()
}
_ => return None,
};
Some(CodeBlockText {
is_array,
indent_text,
replace_range,
source: cell_source,
})
}

/// Turn the formatted text into a json array, split up by line breaks.
fn build_json_text(formatted_text: &str, indent_text: &str) -> String {
fn build_array_json_text(formatted_text: &str, indent_text: &str) -> String {
let mut new_text = String::new();
let mut current_end_index = 0;
for (i, line) in formatted_text.split('\n').enumerate() {
Expand Down
48 changes: 48 additions & 0 deletions tests/specs/Basic.txt
Original file line number Diff line number Diff line change
Expand Up @@ -83,3 +83,51 @@
"nbformat": 4,
"nbformat_minor": 2
}

== should format cell with string value ==
{
"cells": [
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"vscode": {
"languageId": "typescript"
}
},
"outputs": [],
"source": "code block 1\ntesting"
}
],
"metadata": {
"language_info": {
"name": "python"
}
},
"nbformat": 4,
"nbformat_minor": 2
}

[expect]
{
"cells": [
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"vscode": {
"languageId": "typescript"
}
},
"outputs": [],
"source": "code block 1\ntesting_typescript"
}
],
"metadata": {
"language_info": {
"name": "python"
}
},
"nbformat": 4,
"nbformat_minor": 2
}