feat: Add option to output colors

bindings/prql-elixir/native/prql/src/lib.rs

@@ -77,6 +77,8 @@ impl From<CompileOptions> for prql_compiler::Options {
             format: o.format,
             target: target_from_atom(o.target),
             signature_comment: o.signature_comment,
+            // TODO: add support for this
+            color: false,
         }
     }
 }

bindings/prql-java/src/lib.rs

@@ -27,6 +27,8 @@ pub extern "system" fn Java_org_prql_prql4j_PrqlCompiler_toSql(
         format: format != 0,
         target: prql_dialect,
         signature_comment: signature != 0,
+        // TODO: add support for this
+        color: false,
     };
     let result = prql_compiler::compile(&prql_query, &opt);
     java_string_with_exception(result, &env)

bindings/prql-js/src/lib.rs

@@ -110,6 +110,8 @@ impl From<CompileOptions> for prql_compiler::Options {
             format: o.format,
             target,
             signature_comment: o.signature_comment,
+            // TODO: offer this option in the API
+            color: false,
         }
     }
 }

bindings/prql-lib/src/lib.rs

@@ -323,5 +323,7 @@ fn convert_options(o: &Options) -> Result<prql_compiler::Options, prql_compiler:
         format: o.format,
         target,
         signature_comment: o.signature_comment,
+        // TODO: add support for this
+        color: false,
     })
 }

bindings/prql-python/src/lib.rs

@@ -102,6 +102,8 @@ fn convert_options(
         format: o.format,
         target,
         signature_comment: o.signature_comment,
+        // TODO: offer support
+        color: false,
     })
 }
 

prql-compiler/README.md

@@ -27,7 +27,8 @@ let prql = "from employees | select [name, age]";
 let opts = &Options {
     format: false,
     target: Target::Sql(Some(Dialect::SQLite)),
-    signature_comment: false
+    signature_comment: false,
+    color: false,
 };
 let sql = compile(&prql, opts).unwrap();
 assert_eq!("SELECT name, age FROM employees", sql);

prql-compiler/prqlc/src/watch.rs

@@ -27,6 +27,8 @@ pub fn run(command: &mut WatchArgs) -> Result<()> {
         format: !command.no_format,
         target: prql_compiler::Target::Sql(None),
         signature_comment: !command.no_signature,
+        // TODO: potentially offer this as an arg?
+        color: false,
     };
     let path = Path::new(&command.path);
 

prql-compiler/src/lib.rs

@@ -112,7 +112,8 @@ pub static PRQL_VERSION: Lazy<Version> =
 /// let opts = Options {
 ///     format: false,
 ///     target: Target::Sql(Some(Dialect::SQLite)),
-///     signature_comment: false
+///     signature_comment: false,
+///     color: false,
 /// };
 /// let sql = compile(&prql, &opts).unwrap();
 /// println!("PRQL: {}\nSQLite: {}", prql, &sql);
@@ -125,7 +126,7 @@ pub fn compile(prql: &str, options: &Options) -> Result<String, ErrorMessages> {
         .and_then(semantic::resolve)
         .and_then(|rq| sql::compile(rq, options))
         .map_err(error::downcast)
-        .map_err(|e| e.composed("", prql, false))
+        .map_err(|e| e.composed("", prql, options.color))
 }
 
 #[derive(Debug, Clone, Serialize, Deserialize)]
@@ -188,6 +189,9 @@ pub struct Options {
     ///
     /// Defaults to true.
     pub signature_comment: bool,
+
+    /// Whether to use ANSI colors in error messages.
+    pub color: bool,
 }
 
 impl Default for Options {
@@ -196,6 +200,7 @@ impl Default for Options {
             format: true,
             target: Target::Sql(None),
             signature_comment: true,
+            color: false,
         }
     }
 }
@@ -219,6 +224,11 @@ impl Options {
     pub fn some(self) -> Option<Self> {
         Some(self)
     }
+
+    pub fn with_color(mut self, color: bool) -> Self {
+        self.color = color;
+        self
+    }
 }
 
 #[doc = include_str!("../README.md")]