add typos.yml and fix typos

Signed-off-by: Andrei Gherghescu <[email protected]>

Author: andrei-ng

.github/workflows/ci.yml .github/workflows/pr.yml.github/workflows/ci.yml renamed to .github/workflows/pr.yml

@@ -1,4 +1,4 @@
-name: CI
+name: PR checks
 
 on:
   workflow_dispatch:

.github/workflows/typos.yml

@@ -0,0 +1,16 @@
+name: Typos
+
+on:
+  workflow_dispatch:
+  pull_request:
+    branches: [ main ]
+  push:
+    branches: [ main ]
+
+jobs:
+  typos:
+    name: Check for typos
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: crate-ci/typos@master

CHANGELOG.md

@@ -6,14 +6,14 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [0.13.0] - 2025-xx-xx
 ### Changed
-- [[#277](https://github.com/plotly/plotly.rs/pull/277)] Removed `wasm` feature flag and put evrything behind target specific dependencies. Added `.cargo/config.toml` for configuration flags needed by `getrandom` version 0.3 on `wasm` targets.
+- [[#277](https://github.com/plotly/plotly.rs/pull/277)] Removed `wasm` feature flag and put everything behind target specific dependencies. Added `.cargo/config.toml` for configuration flags needed by `getrandom` version 0.3 on `wasm` targets.
 - [[#281](https://github.com/plotly/plotly.rs/pull/281)] Update to askama 0.13.0
 - [[#287](https://github.com/plotly/plotly.rs/pull/287)] Added functionality for callbacks (using wasm)
 - [[#289](https://github.com/plotly/plotly.rs/pull/289)] Fixes Kaleido static export for MacOS targets by removing `--disable-gpu` flag for MacOS 
 - [[#291](https://github.com/plotly/plotly.rs/pull/291)] Remove `--disable-gpu` flag for Kaleido static-image generation for all targets. 
 - [[#299](https://github.com/plotly/plotly.rs/pull/299)] Added customdata field to HeatMap
 - [[#303](https://github.com/plotly/plotly.rs/pull/303)] Split layout mod.rs into modules
-- [[#304](https://github.com/plotly/plotly.rs/pull/304)] Refactored examples to allow fo generation of full html files 
+- [[#304](https://github.com/plotly/plotly.rs/pull/304)] Refactored examples to allow for generation of full html files 
 - [[#320](https://github.com/plotly/plotly.rs/pull/320)] Make offline_js_sources function `pub`
 - [[#321](https://github.com/plotly/plotly.rs/pull/321)] Make 'online_cdn_js' function also `pub` for consistenccy
 
@@ -86,7 +86,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 - [[#154](https://github.com/plotly/plotly.rs/pull/154)] Improve ergonomics of `Title` and `LegendGroupTitle` structs: `new` method now takes no arguments as per other structs, whilst a new `with_text()` constructor is added for convenience. Where other structs contain a `Title` (and `LegendGroupTitle`), users  can now call the `title()` (and `legend_group_title()`) method with anything that `impl`s `Into<Title>`, viz. `String`, `&String`, `&str` and `Title`.
 - [[#157](https://github.com/plotly/plotly.rs/pull/157)] Fix `HeatMap`'s setters for correctly setting `zmin`, `zmax` and `zmin` independent of `Z` input type.
 - [[#159](https://github.com/plotly/plotly.rs/pull/159)] Make `heat_map` module public to expose `Smoothing enum`.
-- [[#161](https://github.com/plotly/plotly.rs/pull/161)] Added `Axis` `scaleanchor` settter.
+- [[#161](https://github.com/plotly/plotly.rs/pull/161)] Added `Axis` `scaleanchor` setter.
 - [[#163](https://github.com/plotly/plotly.rs/pull/163)] Added `DensityMapbox`.
 - [[#166](https://github.com/plotly/plotly.rs/pull/166)] Added subplot example with multiple titles.
 - [[#178](https://github.com/plotly/plotly.rs/pull/178)] Fix setter for `Axis::matches` to take string arg.
@@ -119,7 +119,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [0.8.1] - 2022-09-25
 ### Added
-- Button support (i.e. [updatemenus](https://plotly.com/javascript/reference/layout/updatemenus/)) contibuted by [@sreenathkrishnan](https://github.com/sreenathkrishnan). Details and examples in this well written PR [#99](https://github.com/plotly/plotly.rs/pull/99).
+- Button support (i.e. [updatemenus](https://plotly.com/javascript/reference/layout/updatemenus/)) contributed by [@sreenathkrishnan](https://github.com/sreenathkrishnan). Details and examples in this well written PR [#99](https://github.com/plotly/plotly.rs/pull/99).
 - Internally, there is now a `plotly-derive` crate which defines a `FieldSetter` procedural macro. This massively cuts down the amount of code duplication by generating the setter methods based on the struct fields. Again thanks to @sreenathkrishnan for this effort.
 
 ## [0.8.0] - 2022-08-26

README.md

@@ -148,7 +148,7 @@ Alternatively, enable only the `kaleido` feature and manually install Kaleido.
 # Cargo.toml
 
 [dependencies]
-plotly = { version = "0.12", features = ["kaleido"] }
+plotly = { version = "0.13", features = ["kaleido"] }
 ```
 
 With the feature enabled, plots can be saved as any of `png`, `jpeg`, `webp`, `svg`, `pdf` and `eps`. Note that the plot will be a static image, i.e. they will be non-interactive.
@@ -167,7 +167,7 @@ plot.write_image("out.png", ImageFormat::PNG, 800, 600, 1.0);
 
 ## Usage Within a Wasm Environment
 
-`Plotly.rs` can be used with a Wasm-based frontend framework. The needed dependencies are automatically enabled on `wasm32` targets. Note that the `kaleido` feature is not supported in Wasm enviroments and will throw a compilation error if enabled. 
+`Plotly.rs` can be used with a Wasm-based frontend framework. The needed dependencies are automatically enabled on `wasm32` targets. Note that the `kaleido` feature is not supported in Wasm environments and will throw a compilation error if enabled. 
 
 First, make sure that you have the Plotly JavaScript library in your base HTML template:
 

_typos.toml

@@ -0,0 +1,17 @@
+[files]
+extend-exclude = [
+    "**/*.js",
+    "**/*min.js",
+    "docs/book/plotly.min.js",
+    "docs/book/ferris.js",
+    "plotly/resource/plotly.min.js",
+    "plotly_static/resource/plotly.min.js",
+    "plotly_static/resource/html2pdf.bundle.min.js",
+    "plotly_static/resource/tex-mml-chtml-3.2.0.js",
+    "plotly_static/resource/tex-svg-3.2.2.js"
+] 
+
+
+[default.extend-words]
+# Don't correct the scene projection type "Winkel tripel"
+tripel = "tripel"

docs/book/src/getting_started.md

@@ -91,15 +91,26 @@ plot.write_image("/home/user/plot_name.ext", ImageFormat::PNG, 1280, 900, 1.0);
 
 The extension in the file-name path is optional as the appropriate extension (`ImageFormat::PNG`) will be included. Note that in all functions that save files to disk, both relative and absolute paths are supported.
 
-## Saving Plots
+## Saving Plots with Kaleido (legacy)
 
 To add the ability to save plots in the following formats: png, jpeg, webp, svg, pdf and eps, you can use the `kaleido` feature. This feature depends on [plotly/Kaleido](https://github.com/plotly/Kaleido): a cross-platform open source library for generating static images. All the necessary binaries have been included with `plotly_kaleido` for `Linux`, `Windows` and `MacOS`. Previous versions of [plotly.rs](https://github.com/plotly/plotly.rs) used the `orca` feature, however, this has been deprecated as it provided the same functionality but required additional installation steps. To enable the `kaleido` feature add the following to your `Cargo.toml`:
 
 ```toml
 [dependencies]
-plotly = { version = "0.12", features = ["kaleido"] }
+plotly = { version = "0.13", features = ["kaleido"] }
 ```
 
+## Static Image Export with WebDriver (recommended)
+
+For static image export using WebDriver and headless browsers, you can use the `plotly_static` feature. This feature supports the same formats as Kaleido (png, jpeg, webp, svg, pdf) but uses WebDriver for the static export process. To enable static export, add the following to your `Cargo.toml`:
+
+```toml
+[dependencies]
+plotly = { version = "0.13", features = ["static_export_default"] }
+```
+
+The `static_export_default` feature includes Chrome WebDriver support with automatic download. For Firefox support, use `static_export_geckodriver` instead. See the [Static Image Export](../fundamentals/static_image_export.md) chapter for a detailed usage example.
+
 ## WebAssembly Support
 
 As of v0.8.0, [plotly.rs](https://github.com/plotly/plotly.rs) can now be used in a `Wasm` environment by enabling the `wasm` feature in your `Cargo.toml`:

examples/customization/consistent_static_format_export/README.md

@@ -1,6 +1,6 @@
 # SVG Export Example
 
-This example demonstrates exporting a plot to SVG, PNG, and PDF using plotly.rs and keeping font size and style consistent accross SVG and other formats. 
+This example demonstrates exporting a plot to SVG, PNG, and PDF using plotly.rs and keeping font size and style consistent across SVG and other formats. 
 
 This example is based on [GitHub Issue #171](https://github.com/plotly/plotly.rs/issues/171).
 

examples/static_export/README.md

@@ -4,7 +4,7 @@ This example demonstrates how to use the `plotly_static` crate for exporting Plo
 
 The `plotly_static` provides a interface for converting Plotly plots into various static image formats (PNG, JPEG, WEBP, SVG, PDF) using WebDriver and headless browsers.
 
-In this example it is shown how to use the `StaticExporter` with the old style Kaleido API and also with the new style API. Using the former API is fine for one time static exports, but that API will crate an instance of the `StaticExporter` for each `write_image` call. The new style API is recommended for performance as the same instance of the `StaticExporter` can be reused accross mutliple exports.  
+In this example it is shown how to use the `StaticExporter` with the old style Kaleido API and also with the new style API. Using the former API is fine for one time static exports, but that API will crate an instance of the `StaticExporter` for each `write_image` call. The new style API is recommended for performance as the same instance of the `StaticExporter` can be reused across multiple exports.  
 
 See also the `Static Image Export` section in the book for a more detailed description.
 

plotly/src/common/mod.rs

@@ -1060,7 +1060,7 @@ pub enum PatternShape {
     #[serde(rename = "")]
     None,
     #[serde(rename = "-")]
-    HorizonalLine,
+    HorizontalLine,
     #[serde(rename = "|")]
     VerticalLine,
     #[serde(rename = "/")]
@@ -2263,7 +2263,7 @@ mod tests {
     #[test]
     fn serialize_pattern_shape() {
         assert_eq!(to_value(PatternShape::None).unwrap(), json!(""));
-        assert_eq!(to_value(PatternShape::HorizonalLine).unwrap(), json!("-"));
+        assert_eq!(to_value(PatternShape::HorizontalLine).unwrap(), json!("-"));
         assert_eq!(to_value(PatternShape::VerticalLine).unwrap(), json!("|"));
         assert_eq!(
             to_value(PatternShape::RightDiagonalLine).unwrap(),
@@ -2294,7 +2294,7 @@ mod tests {
     fn serialize_pattern() {
         let pattern = Pattern::new()
             .shape_array(vec![
-                PatternShape::HorizonalLine,
+                PatternShape::HorizontalLine,
                 PatternShape::VerticalLine,
             ])
             .fill_mode(PatternFillMode::Overlay)

plotly/src/plot.rs

@@ -791,7 +791,7 @@ impl Plot {
     }
 
     #[cfg(target_family = "wasm")]
-    /// Convert a `Plot` to a native Javasript `js_sys::Object`.
+    /// Convert a `Plot` to a native JavaScript `js_sys::Object`.
     pub fn to_js_object(&self) -> wasm_bindgen_futures::js_sys::Object {
         use wasm_bindgen_futures::js_sys;
         use wasm_bindgen_futures::wasm_bindgen::JsCast;