fix(linter): useNodejsImportProtocol takes in dependencies in consideration

CHANGELOG.md

@@ -41,6 +41,7 @@ our [guidelines for writing a good changelog entry](https://github.com/biomejs/b
 #### Bug fixes
 
 - `useConsistentArrayType` and `useShorthandArrayType` now ignore `Array` in the `extends` and `implements` clauses. Fix [#3247](https://github.com/biomejs/biome/issues/3247). Contributed by @Conaclos
+- Fixes [#3066](https://github.com/biomejs/biome/issues/3066) by taking into account the dependencies declared in the `package.json`. Contributed by @ematipico
 
 ## v1.8.2 (2024-06-20)
 

crates/biome_js_analyze/src/lib.rs

@@ -131,9 +131,7 @@ where
 
     services.insert_service(Arc::new(AriaRoles));
     services.insert_service(Arc::new(AriaProperties));
-    if let Some(manifest) = manifest {
-        services.insert_service(Arc::new(manifest));
-    }
+    services.insert_service(Arc::new(manifest));
     services.insert_service(source_type);
     (
         analyzer.run(AnalyzerContext {
@@ -238,6 +236,7 @@ mod tests {
     use biome_diagnostics::{Diagnostic, DiagnosticExt, PrintDiagnostic, Severity};
     use biome_js_parser::{parse, JsParserOptions};
     use biome_js_syntax::{JsFileSource, TextRange, TextSize};
+    use biome_project::{Dependencies, PackageJson};
     use std::slice;
 
     use crate::lint::correctness::use_exhaustive_dependencies::{Hook, HooksOptions};
@@ -256,7 +255,7 @@ mod tests {
             String::from_utf8(buffer).unwrap()
         }
 
-        const SOURCE: &str = r#"<div class={`px-2 foo p-4 bar ${variable}`}/>"#;
+        const SOURCE: &str = r#"import buffer from "buffer"; "#;
 
         let parsed = parse(SOURCE, JsFileSource::tsx(), JsParserOptions::default());
 
@@ -268,13 +267,15 @@ mod tests {
             dependencies_index: Some(1),
             stable_result: StableHookResult::None,
         };
-        let rule_filter = RuleFilter::Rule("nursery", "useSortedClasses");
+        let rule_filter = RuleFilter::Rule("style", "useNodejsImportProtocol");
 
         options.configuration.rules.push_rule(
             RuleKey::new("nursery", "useHookAtTopLevel"),
             RuleOptions::new(HooksOptions { hooks: vec![hook] }, None),
         );
 
+        let mut dependencies = Dependencies::default();
+        dependencies.add("buffer", "latest");
         analyze(
             &parsed.tree(),
             AnalysisFilter {
@@ -283,7 +284,10 @@ mod tests {
             },
             &options,
             JsFileSource::tsx(),
-            None,
+            Some(PackageJson {
+                dependencies,
+                ..Default::default()
+            }),
             |signal| {
                 if let Some(diag) = signal.diagnostic() {
                     error_ranges.push(diag.location().span.unwrap());

crates/biome_js_analyze/src/lint/style/use_nodejs_import_protocol.rs

@@ -1,11 +1,11 @@
 use biome_analyze::{
-    context::RuleContext, declare_rule, ActionCategory, Ast, FixKind, Rule, RuleDiagnostic,
-    RuleSource,
+    context::RuleContext, declare_rule, ActionCategory, FixKind, Rule, RuleDiagnostic, RuleSource,
 };
 use biome_console::markup;
 use biome_js_syntax::{inner_string_text, AnyJsImportLike, JsSyntaxKind, JsSyntaxToken};
 use biome_rowan::BatchMutationExt;
 
+use crate::services::manifest::Manifest;
 use crate::{globals::is_node_builtin_module, JsRuleAction};
 
 declare_rule! {
@@ -14,6 +14,13 @@ declare_rule! {
     /// The rule marks traditional imports like `import fs from "fs";` as invalid,
     /// suggesting the format `import fs from "node:fs";` instead.
     ///
+    /// The rule also isn't triggered if there are dependencies declared in the `package.json` that match
+    /// the name of a built-in Node.js module.
+    ///
+    /// :::caution
+    /// The rule doesn't support dependencies installed inside a monorepo.
+    /// :::
+    ///
     /// ## Examples
     ///
     /// ### Invalid
@@ -51,7 +58,7 @@ declare_rule! {
 }
 
 impl Rule for UseNodejsImportProtocol {
-    type Query = Ast<AnyJsImportLike>;
+    type Query = Manifest<AnyJsImportLike>;
     type State = JsSyntaxToken;
     type Signals = Option<Self::State>;
     type Options = ();
@@ -62,7 +69,15 @@ impl Rule for UseNodejsImportProtocol {
             return None;
         }
         let module_name = node.module_name_token()?;
-        is_node_module_without_protocol(&inner_string_text(&module_name)).then_some(module_name)
+        let module_name_trimmed = inner_string_text(&module_name);
+        if ctx.is_dependency(&module_name_trimmed)
+            || ctx.is_dev_dependency(&module_name_trimmed)
+            || ctx.is_peer_dependency(&module_name_trimmed)
+            || ctx.is_optional_dependency(&module_name_trimmed)
+        {
+            return None;
+        }
+        is_node_module_without_protocol(&module_name_trimmed).then_some(module_name)
     }
 
     fn diagnostic(_: &RuleContext<Self>, module_name: &Self::State) -> Option<RuleDiagnostic> {

crates/biome_js_analyze/src/services/manifest.rs

@@ -9,24 +9,40 @@ use std::sync::Arc;
 
 #[derive(Debug, Clone)]
 pub struct ManifestServices {
-    pub(crate) manifest: Arc<PackageJson>,
+    pub(crate) manifest: Arc<Option<PackageJson>>,
 }
 
 impl ManifestServices {
     pub(crate) fn is_dependency(&self, specifier: &str) -> bool {
-        self.manifest.dependencies.contains(specifier)
+        self.manifest
+            .as_ref()
+            .as_ref()
+            .map(|pkg| pkg.dependencies.contains(specifier))
+            .unwrap_or_default()
     }
 
     pub(crate) fn is_dev_dependency(&self, specifier: &str) -> bool {
-        self.manifest.dev_dependencies.contains(specifier)
+        self.manifest
+            .as_ref()
+            .as_ref()
+            .map(|pkg| pkg.dev_dependencies.contains(specifier))
+            .unwrap_or_default()
     }
 
     pub(crate) fn is_peer_dependency(&self, specifier: &str) -> bool {
-        self.manifest.peer_dependencies.contains(specifier)
+        self.manifest
+            .as_ref()
+            .as_ref()
+            .map(|pkg| pkg.peer_dependencies.contains(specifier))
+            .unwrap_or_default()
     }
 
     pub(crate) fn is_optional_dependency(&self, specifier: &str) -> bool {
-        self.manifest.optional_dependencies.contains(specifier)
+        self.manifest
+            .as_ref()
+            .as_ref()
+            .map(|pkg| pkg.optional_dependencies.contains(specifier))
+            .unwrap_or_default()
     }
 }
 
@@ -35,7 +51,7 @@ impl FromServices for ManifestServices {
         rule_key: &RuleKey,
         services: &ServiceBag,
     ) -> biome_diagnostics::Result<Self, MissingServicesDiagnostic> {
-        let manifest: &Arc<PackageJson> = services.get_service().ok_or_else(|| {
+        let manifest: &Arc<Option<PackageJson>> = services.get_service().ok_or_else(|| {
             MissingServicesDiagnostic::new(rule_key.rule_name(), &["PackageJson"])
         })?;
 

crates/biome_js_analyze/tests/specs/style/useNodejsImportProtocol/invalid.js.snap

@@ -1595,5 +1595,3 @@ invalid.js:65:26 lint/style/useNodejsImportProtocol  FIXABLE  ━━━━━━
 
 
 ```
-
-

crates/biome_js_analyze/tests/specs/style/useNodejsImportProtocol/validDep.js

@@ -0,0 +1 @@
+import Buffer from "buffer";

crates/biome_js_analyze/tests/specs/style/useNodejsImportProtocol/validDep.js.snap

@@ -0,0 +1,9 @@
+---
+source: crates/biome_js_analyze/tests/spec_tests.rs
+expression: validDep.js
+---
+# Input
+```jsx
+import Buffer from "buffer";
+
+```

crates/biome_js_analyze/tests/specs/style/useNodejsImportProtocol/validDep.package.json

@@ -0,0 +1,5 @@
+{
+  "dependencies": {
+    "buffer": "latest"
+  }
+}

crates/biome_project/src/lib.rs

@@ -8,7 +8,7 @@ use biome_diagnostics::serde::Diagnostic;
 use biome_parser::diagnostic::ParseDiagnostic;
 use biome_rowan::Language;
 pub use license::generated::*;
-pub use node_js_project::{NodeJsProject, PackageJson};
+pub use node_js_project::{Dependencies, NodeJsProject, PackageJson};
 use std::any::TypeId;
 use std::fmt::Debug;
 use std::path::Path;

crates/biome_project/src/node_js_project/mod.rs

@@ -1,6 +1,6 @@
 mod package_json;
 
-pub use crate::node_js_project::package_json::PackageJson;
+pub use crate::node_js_project::package_json::{Dependencies, PackageJson};
 use crate::{Manifest, Project, ProjectAnalyzeDiagnostic, ProjectAnalyzeResult, LICENSE_LIST};
 use biome_json_syntax::JsonRoot;
 use biome_rowan::Language;

crates/biome_project/src/node_js_project/package_json.rs

@@ -39,6 +39,10 @@ impl Dependencies {
     pub fn contains(&self, specifier: &str) -> bool {
         self.0.contains_key(specifier)
     }
+
+    pub fn add(&mut self, dependency: impl Into<String>, version: impl Into<Version>) {
+        self.0.insert(dependency.into(), version.into());
+    }
 }
 
 #[derive(Debug, Clone)]
@@ -47,6 +51,18 @@ pub enum Version {
     Literal(String),
 }
 
+impl From<&str> for Version {
+    fn from(value: &str) -> Self {
+        Self::Literal(value.to_string())
+    }
+}
+
+impl From<String> for Version {
+    fn from(value: String) -> Self {
+        Self::Literal(value)
+    }
+}
+
 impl Deserializable for PackageJson {
     fn deserialize(
         value: &impl DeserializableValue,