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

feat(jsonc): added jsonc support #1234

Merged
merged 6 commits into from
Jan 6, 2025
Merged
Show file tree
Hide file tree
Changes from 3 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
15 changes: 15 additions & 0 deletions examples/deno-jsonc/deno.jsonc
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
// THIS FILE HAS ALL KINDS OF COMMENTS POSSIBLE TO TEST JSONC
{
//some random comment
"tasks": {
// random afterline comment
/* :) */ "dev": "deno run --watch main.ts",
"start": "deno start main.ts"
} /*
This
is some multiline comment
*/,
"imports": {
"@std/assert": "jsr:@std/assert@1"
}
}
18 changes: 18 additions & 0 deletions examples/deno-jsonc/deno.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 7 additions & 0 deletions examples/deno-jsonc/main.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
export function add(a: number, b: number): number {
return a + b;
}
// Learn more at https://docs.deno.com/runtime/manual/examples/module_metadata#concepts
if (import.meta.main) {
console.log("Add 2 + 3 =", add(2, 3));
}
6 changes: 6 additions & 0 deletions examples/deno-jsonc/main_test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
import { assertEquals } from "@std/assert";
import { add } from "./main.ts";

Deno.test(function addTest() {
assertEquals(add(2, 3), 5);
});
50 changes: 50 additions & 0 deletions src/nixpacks/app.rs
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,48 @@
Ok(toml_file)
}

/// Parse jsonc files as json by ignoring all kinds of comments
pub fn read_jsonc<T>(&self, name: &str) -> Result<T>
where
T: DeserializeOwned,
{
let mut cleaned_jsonc = String::new();
let contents = self.read_file(name)?;
let mut chars = contents.chars().peekable();
while let Some(current_char) = chars.next() {
match current_char {
'/' if chars.peek() == Some(&'/') => {
while let Some(&next_char) = chars.peek() {
chars.next();
if next_char == '\n' {
break;
}
}
}
'/' if chars.peek() == Some(&'*') => {
chars.next();
loop {
match chars.next() {
Some('*') if chars.peek() == Some(&'/') => {
chars.next();
break;
}
None => break,
_ => continue,
}
}
}
_ => cleaned_jsonc.push(current_char),
}
}
println!("{}", cleaned_jsonc);

Check failure on line 227 in src/nixpacks/app.rs

View workflow job for this annotation

GitHub Actions / Lints

variables can be used directly in the `format!` string
shubhexists marked this conversation as resolved.
Show resolved Hide resolved
let value: T = serde_json::from_str(&cleaned_jsonc.as_str()).with_context(|| {

Check failure on line 228 in src/nixpacks/app.rs

View workflow job for this annotation

GitHub Actions / Lints

this expression creates a reference which is immediately dereferenced by the compiler
let relative_path = self.strip_source_path(Path::new(name)).unwrap();
format!("Error reading {} as JSONC", relative_path.to_str().unwrap())
})?;
Ok(value)
}

/// Try to yaml-parse a file.
pub fn read_yaml<T>(&self, name: &str) -> Result<T>
where
Expand Down Expand Up @@ -281,6 +323,14 @@
Ok(())
}

#[test]
fn test_read_jsonc_file() -> Result<()> {
let app = App::new("./examples/deno-jsonc")?;
let value: Map<String, Value> = app.read_jsonc("deno.jsonc")?;
assert!(value.get("tasks").is_some());
Ok(())
}

#[test]
fn test_read_toml_file() -> Result<()> {
let app = App::new("./examples/rust-rocket")?;
Expand Down
2 changes: 1 addition & 1 deletion src/providers/deno.rs
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ impl DenoProvider {
if app.includes_file("deno.json") || app.includes_file("deno.jsonc") {
let deno_json: DenoJson = app
.read_json("deno.json")
.or_else(|_| app.read_json("deno.jsonc"))?;
.or_else(|_| app.read_jsonc("deno.jsonc"))?;

if let Some(tasks) = deno_json.tasks {
if let Some(start) = tasks.start {
Expand Down
Loading