Review related changes

software-mansion · Oct 14, 2024 · 35c6dee · 35c6dee
1 parent 83ff2aa
commit 35c6dee
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 34 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/extensions/scarb-doc/Cargo.toml b/extensions/scarb-doc/Cargo.toml
@@ -33,7 +33,6 @@ serde_json.workspace = true
 salsa.workspace = true
 smol_str.workspace = true
 thiserror.workspace = true
-semver.workspace = true
 
 [dev-dependencies]
 assert_fs.workspace = true

diff --git a/extensions/scarb-doc/src/db.rs b/extensions/scarb-doc/src/db.rs
@@ -18,8 +18,6 @@ use cairo_lang_syntax::node::db::{SyntaxDatabase, SyntaxGroup};
 use cairo_lang_utils::Upcast;
 
 use salsa;
-use scarb_metadata::PackageMetadata;
-use semver::Version;
 
 /// The Cairo compiler Salsa database tailored for scarb-doc usage.
 #[salsa::database(
@@ -33,12 +31,10 @@ use semver::Version;
 )]
 pub struct ScarbDocDatabase {
     storage: salsa::Storage<Self>,
-    main_package_name: String,
-    main_package_version: Version,
 }
 
 impl ScarbDocDatabase {
-    pub fn new(project_config: Option<ProjectConfig>, main_package: &PackageMetadata) -> Self {
+    pub fn new(project_config: Option<ProjectConfig>) -> Self {
         let plugin_suite = [get_default_plugin_suite(), starknet_plugin_suite()]
             .into_iter()
             .fold(PluginSuite::default(), |mut acc, suite| {
@@ -47,8 +43,6 @@ impl ScarbDocDatabase {
             });
         let mut db = Self {
             storage: Default::default(),
-            main_package_name: main_package.name.clone(),
-            main_package_version: main_package.version.clone(),
         };
 
         init_files_group(&mut db);
@@ -94,8 +88,6 @@ impl salsa::ParallelDatabase for ScarbDocDatabase {
     fn snapshot(&self) -> salsa::Snapshot<Self> {
         salsa::Snapshot::new(ScarbDocDatabase {
             storage: self.storage.snapshot(),
-            main_package_name: self.main_package_name.clone(),
-            main_package_version: self.main_package_version.clone(),
         })
     }
 }

diff --git a/extensions/scarb-doc/src/errors.rs b/extensions/scarb-doc/src/errors.rs
@@ -14,7 +14,7 @@ pub struct PackagesSerializationError(#[from] SerdeError);
 pub struct MissingPackageError(pub String);
 
 #[derive(Debug, Error)]
-#[error("Cairo's `Cfg` must serialize identically as Scarb Metadata's `Cfg`.")]
+#[error("cairo's `Cfg` must serialize identically as Scarb Metadata's `Cfg`")]
 pub struct CfgParseError(#[from] SerdeError);
 
 #[derive(Debug, Error)]

diff --git a/extensions/scarb-doc/src/lib.rs b/extensions/scarb-doc/src/lib.rs
@@ -2,7 +2,7 @@ use crate::db::ScarbDocDatabase;
 use crate::metadata::compilation::get_project_config;
 use anyhow::Result;
 use cairo_lang_compiler::diagnostics::DiagnosticsReporter;
-use cairo_lang_diagnostics::{FormattedDiagnosticEntry, Maybe, Severity};
+use cairo_lang_diagnostics::{FormattedDiagnosticEntry, Severity};
 use cairo_lang_filesystem::{
     db::{Edition, FilesGroup},
     ids::{CrateId, CrateLongId},
@@ -57,7 +57,7 @@ pub fn generate_packages_information(
 
         let project_config = get_project_config(metadata, package_metadata)?;
 
-        let db = ScarbDocDatabase::new(Some(project_config), package_metadata);
+        let db = ScarbDocDatabase::new(Some(project_config));
 
         let main_crate_id = db.intern_crate(CrateLongId::Real {
             name: package_metadata.name.clone().into(),
@@ -73,12 +73,8 @@ pub fn generate_packages_information(
             setup_diagnostics_reporter(&db, main_crate_id, package_compilation_unit)
                 .skip_lowering_diagnostics();
 
-        let crate_ = generate_language_elements_tree_for_package(
-            &db,
-            main_crate_id,
-            should_document_private_items,
-        )
-        .map_err(|_| DiagnosticError(package_metadata.name.clone()));
+        let crate_ = Crate::new(&db, main_crate_id, should_document_private_items)
+            .map_err(|_| DiagnosticError(package_metadata.name.clone()));
 
         if crate_.is_err() {
             diagnostics_reporter.ensure(&db)?;
@@ -95,16 +91,6 @@ pub fn generate_packages_information(
     Ok(packages_information)
 }
 
-fn generate_language_elements_tree_for_package(
-    db: &ScarbDocDatabase,
-    main_crate_id: CrateId,
-    document_private_items: bool,
-) -> Maybe<Crate> {
-    // let main_crate_id = db.get_main_crate_id();
-
-    Crate::new(db, main_crate_id, document_private_items)
-}
-
 fn setup_diagnostics_reporter<'a>(
     db: &ScarbDocDatabase,
     main_crate_id: CrateId,