Add docs (#12)

* fix: examples

* chore: open missing docs lint

* add docs and fix Sass::new panic

* chore: clippy derive_partial_eq_without_eq

Author: ahabhgk

.vscode/setting.json

@@ -0,0 +1,5 @@
+{
+  "rust-analyzer.cargo.features": [
+    "legacy"
+  ]
+}

Cargo.toml

@@ -1,5 +1,5 @@
 [package]
-name = "sass-embedded-host-rust"
+name = "sass-embedded"
 version = "0.1.0"
 authors = ["ahabhgk <[email protected]>"]
 edition = "2021"

README.md

@@ -2,6 +2,16 @@
 
 🦀 A Rust library that will communicate with [Embedded Dart Sass](https://github.com/sass/dart-sass-embedded) using the [Embedded Sass protocol](https://github.com/sass/embedded-protocol).
 
+```rust
+use sass_embedded::{Sass, StringOptions};
+
+let mut sass = Sass::new("path/to/sass_embedded").unwrap();
+let res = sass.compile_string("a {b: c}", StringOptions::default()).unwrap();
+println!("{:?}", res);
+```
+
+For more details, checkout the [docs.rs](https://docs.rs/sass-embedded)
+
 ## Contributing
 
 1. Install the [Protocol Buffer Compiler](https://grpc.io/docs/protoc-installation/).

examples/big_scss/main.rs

@@ -1,25 +1,25 @@
 use std::time;
 
-use sass_embedded_host_rust::{Options, Sass};
+use sass_embedded::{Options, Sass, StringOptions};
 
 fn exe_path() -> std::path::PathBuf {
   std::path::PathBuf::from(concat!(env!("CARGO_MANIFEST_DIR")))
-    .join("sass_embedded")
+    .join("ext/sass/sass-embedded")
     .join("dart-sass-embedded")
 }
 
 fn main() {
-  let path = exe_path()
-    .parent()
-    .unwrap()
-    .parent()
-    .unwrap()
+  let path = std::path::PathBuf::from(concat!(env!("CARGO_MANIFEST_DIR")))
     .join("examples/big_scss/big.scss");
   let now = time::Instant::now();
-  let mut sass = Sass::new(exe_path());
+  let mut sass = Sass::new(exe_path()).unwrap();
   let _ = sass.compile(&path, Options::default()).unwrap();
   let _ = sass.compile(&path, Options::default()).unwrap();
   let _ = sass.compile(&path, Options::default()).unwrap();
   let _ = sass.compile(&path, Options::default()).unwrap();
   dbg!(now.elapsed());
+
+  dbg!(sass
+    .compile_string("a {b: c}", StringOptions::default())
+    .unwrap());
 }

examples/bootstrap5/main.rs

@@ -1,27 +1,23 @@
 use std::time;
 
 #[cfg(feature = "legacy")]
-use sass_embedded_host_rust::legacy::LegacyOptionsBuilder;
-use sass_embedded_host_rust::{Options, Sass};
+use sass_embedded::legacy::LegacyOptionsBuilder;
+use sass_embedded::{Options, Sass};
 
 fn exe_path() -> std::path::PathBuf {
   std::path::PathBuf::from(concat!(env!("CARGO_MANIFEST_DIR")))
-    .join("sass_embedded")
+    .join("ext/sass/sass-embedded")
     .join("dart-sass-embedded")
 }
 
 fn main() {
-  let path = exe_path()
-    .parent()
-    .unwrap()
-    .parent()
-    .unwrap()
+  let path = std::path::PathBuf::from(concat!(env!("CARGO_MANIFEST_DIR")))
     .join("examples/bootstrap5/bootstrap/scss");
   let bootstrap = path.join("bootstrap.scss");
   let bootstrap_grid = path.join("bootstrap-grid.scss");
   let bootstrap_reboot = path.join("bootstrap-reboot.scss");
   let bootstrap_utilities = path.join("bootstrap-utilities.scss");
-  let mut sass = Sass::new(exe_path());
+  let mut sass = Sass::new(exe_path()).unwrap();
   let _ = sass.compile(&bootstrap, Options::default()).unwrap();
   let _ = sass.compile(&bootstrap_grid, Options::default()).unwrap();
   let _ = sass.compile(&bootstrap_reboot, Options::default()).unwrap();