Create tool to regenerate the ABOUT.md

boa-dev · Feb 27, 2024 · ce7826d · ce7826d
1 parent 5ce93b2
commit ce7826d
Show file tree

Hide file tree

Showing 20 changed files with 121 additions and 92 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -76,3 +76,8 @@ updates:
     directory: /ffi/wasm/
     schedule:
       interval: daily
+  # TOOLS
+  - package-ecosystem: cargo
+    directory: /tools/
+    schedule:
+      interval: daily
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -13,6 +13,9 @@ members = [
     # OTHERS
     "examples",
     "cli",
+
+    # TOOLS
+    "tools/*",
 ]
 
 exclude = [
@@ -67,6 +70,8 @@ textwrap = "0.16.0"
 thin-vec = "0.2.13"
 time = {version = "0.3.34", no-default-features = true, features = ["local-offset", "large-dates", "wasm-bindgen", "parsing", "formatting", "macros"]}
 tinystr = "0.7.5"
+log = "0.4.20"
+simple_logger = "4.3.3"
 
 # ICU4X
 

diff --git a/cli/ABOUT.md b/cli/ABOUT.md
@@ -8,11 +8,10 @@ website][boa-web].
 Try out the most recent release with Boa's live demo
 [playground][boa-playground].
 
-# Boa Crates
+## Boa Crates
 
 - [**`boa_ast`**][ast] - Boa's ECMAScript Abstract Syntax Tree.
-- [**`boa_engine`**][engine] - Boa's implementation of ECMAScript builtin objects and
-  execution.
+- [**`boa_engine`**][engine] - Boa's implementation of ECMAScript builtin objects and execution.
 - [**`boa_gc`**][gc] - Boa's garbage collector.
 - [**`boa_interner`**][interner] - Boa's string interner.
 - [**`boa_parser`**][parser] - Boa's lexer and parser.

diff --git a/core/ast/ABOUT.md b/core/ast/ABOUT.md
@@ -8,7 +8,7 @@ website][boa-web].
 Try out the most recent release with Boa's live demo
 [playground][boa-playground].
 
-# Boa Crates
+## Boa Crates
 
 - [**`boa_ast`**][ast] - Boa's ECMAScript Abstract Syntax Tree.
 - [**`boa_engine`**][engine] - Boa's implementation of ECMAScript builtin objects and

diff --git a/core/engine/ABOUT.md b/core/engine/ABOUT.md
@@ -8,7 +8,7 @@ website][boa-web].
 Try out the most recent release with Boa's live demo
 [playground][boa-playground].
 
-# Boa Crates
+## Boa Crates
 
 - [**`boa_ast`**][ast] - Boa's ECMAScript Abstract Syntax Tree.
 - [**`boa_engine`**][engine] - Boa's implementation of ECMAScript builtin objects and

diff --git a/core/gc/ABOUT.md b/core/gc/ABOUT.md
@@ -8,7 +8,7 @@ website][boa-web].
 Try out the most recent release with Boa's live demo
 [playground][boa-playground].
 
-# Boa Crates
+## Boa Crates
 
 - [**`boa_ast`**][ast] - Boa's ECMAScript Abstract Syntax Tree.
 - [**`boa_engine`**][engine] - Boa's implementation of ECMAScript builtin objects and

diff --git a/core/icu_provider/ABOUT.md b/core/icu_provider/ABOUT.md
@@ -8,7 +8,7 @@ website][boa-web].
 Try out the most recent release with Boa's live demo
 [playground][boa-playground].
 
-# Boa Crates
+## Boa Crates
 
 - [**`boa_ast`**][ast] - Boa's ECMAScript Abstract Syntax Tree.
 - [**`boa_engine`**][engine] - Boa's implementation of ECMAScript builtin objects and

diff --git a/core/icu_provider/Cargo.toml b/core/icu_provider/Cargo.toml
@@ -20,8 +20,8 @@ once_cell = { workspace = true, default-features = false, features = ["critical-
 
 icu_datagen = { workspace = true, optional = true, features = ["networking", "use_wasm"] }
 icu_plurals = { workspace = true, optional = true, features = ["datagen", "experimental"] }
-log = { version = "0.4.20", optional = true }
-simple_logger = { version = "4.3.3", optional = true }
+log = { workspace = true, optional = true }
+simple_logger = { workspace = true, optional = true }
 
 [features]
 default = ["std"]

diff --git a/core/interner/ABOUT.md b/core/interner/ABOUT.md
@@ -8,7 +8,7 @@ website][boa-web].
 Try out the most recent release with Boa's live demo
 [playground][boa-playground].
 
-# Boa Crates
+## Boa Crates
 
 - [**`boa_ast`**][ast] - Boa's ECMAScript Abstract Syntax Tree.
 - [**`boa_engine`**][engine] - Boa's implementation of ECMAScript builtin objects and

diff --git a/core/macros/ABOUT.md b/core/macros/ABOUT.md
@@ -8,7 +8,7 @@ website][boa-web].
 Try out the most recent release with Boa's live demo
 [playground][boa-playground].
 
-# Boa Crates
+## Boa Crates
 
 - [**`boa_ast`**][ast] - Boa's ECMAScript Abstract Syntax Tree.
 - [**`boa_engine`**][engine] - Boa's implementation of ECMAScript builtin objects and

diff --git a/core/parser/ABOUT.md b/core/parser/ABOUT.md
@@ -8,7 +8,7 @@ website][boa-web].
 Try out the most recent release with Boa's live demo
 [playground][boa-playground].
 
-# Boa Crates
+## Boa Crates
 
 - [**`boa_ast`**][ast] - Boa's ECMAScript Abstract Syntax Tree.
 - [**`boa_engine`**][engine] - Boa's implementation of ECMAScript builtin objects and

diff --git a/core/profiler/ABOUT.md b/core/profiler/ABOUT.md
@@ -8,7 +8,7 @@ website][boa-web].
 Try out the most recent release with Boa's live demo
 [playground][boa-playground].
 
-# Boa Crates
+## Boa Crates
 
 - [**`boa_ast`**][ast] - Boa's ECMAScript Abstract Syntax Tree.
 - [**`boa_engine`**][engine] - Boa's implementation of ECMAScript builtin objects and

diff --git a/core/runtime/ABOUT.md b/core/runtime/ABOUT.md
@@ -8,7 +8,7 @@ website][boa-web].
 Try out the most recent release with Boa's live demo
 [playground][boa-playground].
 
-# Boa Crates
+## Boa Crates
 
 - [**`boa_ast`**][ast] - Boa's ECMAScript Abstract Syntax Tree.
 - [**`boa_engine`**][engine] - Boa's implementation of ECMAScript builtin objects and

diff --git a/ffi/wasm/ABOUT.md b/ffi/wasm/ABOUT.md
diff --git a/ffi/wasm/src/lib.rs b/ffi/wasm/src/lib.rs
@@ -1,9 +1,4 @@
-//! An ECMAScript WASM implementation based on boa_engine.
-#![doc = include_str!("../ABOUT.md")]
-#![doc(
-    html_logo_url = "https://raw.githubusercontent.com/boa-dev/boa/main/assets/logo.svg",
-    html_favicon_url = "https://raw.githubusercontent.com/boa-dev/boa/main/assets/logo.svg"
-)]
+//! An ECMAScript WASM implementation based on `boa_engine`.
 #![cfg_attr(not(test), forbid(clippy::unwrap_used))]
 
 use boa_engine::{Context, Source};

diff --git a/tests/tester/ABOUT.md b/tests/tester/ABOUT.md
diff --git a/tests/tester/src/main.rs b/tests/tester/src/main.rs
@@ -2,11 +2,6 @@
 //!
 //! This crate will run the full ECMAScript test suite (Test262) and report compliance of the
 //! `boa` engine.
-#![doc = include_str!("../ABOUT.md")]
-#![doc(
-    html_logo_url = "https://raw.githubusercontent.com/boa-dev/boa/main/assets/logo.svg",
-    html_favicon_url = "https://raw.githubusercontent.com/boa-dev/boa/main/assets/logo.svg"
-)]
 #![cfg_attr(not(test), deny(clippy::unwrap_used))]
 #![allow(
     clippy::too_many_lines,

diff --git a/tools/scripts/Cargo.toml b/tools/scripts/Cargo.toml
@@ -0,0 +1,14 @@
+[package]
+name = "scripts"
+publish = false
+version = "0.0.0"
+edition.workspace = true
+rust-version.workspace = true
+
+[dependencies]
+cargo_metadata = "0.18.1"
+log.workspace = true
+simple_logger.workspace = true
+
+[lints]
+workspace = true
diff --git a/tools/scripts/src/bin/regenerate-about.rs b/tools/scripts/src/bin/regenerate-about.rs
@@ -0,0 +1,32 @@
+//! Regenerates the `ABOUT.md` document for all publishable crates.
+
+use std::{error::Error, path::Path};
+
+use log::{info, warn};
+
+fn main() -> Result<(), Box<dyn Error>> {
+    simple_logger::SimpleLogger::new().env().init()?;
+
+    let metadata = cargo_metadata::MetadataCommand::new()
+        .manifest_path("./Cargo.toml")
+        .exec()?;
+
+    for member_id in &metadata.workspace_members {
+        let member = &metadata[member_id];
+
+        info!("Checking member `{}`", member.manifest_path);
+
+        if member.publish.as_ref().is_some_and(Vec::is_empty) {
+            warn!("Skipping unpublishable member...");
+            continue;
+        }
+
+        let clone_path = member.manifest_path.with_file_name("ABOUT.md");
+
+        info!("Cloning ABOUT.md into path `{clone_path}`");
+
+        std::fs::copy(Path::new("./ABOUT.md"), clone_path)?;
+    }
+
+    Ok(())
+}