PLUGINAPI-145 Adapt plugin-api to support hidden files analysis (#232)

Author: jonas-wielage-sonarsource

CHANGELOG.md

@@ -1,6 +1,9 @@
 # Changelog
 
 ## 12.0
+* Introduced support for hidden file analysis:
+  * Introduce `org.sonar.api.batch.fs.IndexedFile.isHidden`.
+  * Introduce `org.sonar.api.batch.sensor.SensorDescriptor.processesHiddenFiles`.
 * Remove `org.sonar.api.issue.DefaultTransitions.SET_AS_IN_REVIEW`.
 * Remove `org.sonar.api.issue.DefaultTransitions.OPEN_AS_VULNERABILITY`.
 * Remove `org.sonar.api.issue.Issue.STATUS_IN_REVIEW`.

plugin-api/src/main/java/org/sonar/api/batch/fs/IndexedFile.java

@@ -113,4 +113,13 @@ public interface IndexedFile extends InputPath {
    * @since 6.2
    */
   InputStream inputStream() throws IOException;
+
+  /**
+   * Check if the file is hidden by the file system.
+   * Implementations depend on the runtime context, returns false by default.
+   * @since 12.0
+   */
+  default boolean isHidden() {
+    return false;
+  }
 }

plugin-api/src/main/java/org/sonar/api/batch/sensor/SensorDescriptor.java

@@ -20,6 +20,7 @@
 package org.sonar.api.batch.sensor;
 
 import java.util.function.Predicate;
+import org.sonar.api.batch.fs.IndexedFile;
 import org.sonar.api.batch.fs.InputFile;
 import org.sonar.api.config.Configuration;
 import org.sonar.api.scanner.sensor.ProjectSensor;
@@ -91,4 +92,13 @@ public interface SensorDescriptor {
    * @since 9.3
    */
   SensorDescriptor processesFilesIndependently();
+
+  /**
+   * Advertise that this sensor processes hidden files.
+   * By default, sensors will not receive hidden files, specifically where {@link IndexedFile#isHidden()} evaluates to true.
+   * If hidden file processing is activated, the sensor signals that it processes files where {@link IndexedFile#isHidden()} is true.
+   * Depending on the runtime context, the {@link org.sonar.api.batch.fs.FileSystem} will then supply additional hidden files to the sensor.
+   * @since 12.0
+   */
+  SensorDescriptor processesHiddenFiles();
 }

plugin-api/src/test/java/org/sonar/api/batch/fs/IndexedFileTest.java

@@ -0,0 +1,98 @@
+/*
+ * Sonar Plugin API
+ * Copyright (C) 2009-2025 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+package org.sonar.api.batch.fs;
+
+import java.io.File;
+import java.io.InputStream;
+import java.net.URI;
+import java.nio.file.Path;
+import javax.annotation.CheckForNull;
+import org.junit.jupiter.api.Test;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+
+class IndexedFileTest {
+
+  @Test
+  void file_should_be_hidden_on_default() {
+    IndexedFile file = new MyIndexedFile();
+
+    assertThat(file.isHidden()).isFalse();
+  }
+
+  private static class MyIndexedFile implements IndexedFile {
+    @Override
+    public String key() {
+      return "";
+    }
+
+    @Override
+    public boolean isFile() {
+      return false;
+    }
+
+    @Override
+    public String relativePath() {
+      return "";
+    }
+
+    @Override
+    public String absolutePath() {
+      return "";
+    }
+
+    @Override
+    public File file() {
+      return new File("");
+    }
+
+    @Override
+    public Path path() {
+      return file().toPath();
+    }
+
+    @Override
+    public URI uri() {
+      return file().toURI();
+    }
+
+    @Override
+    public String filename() {
+      return "";
+    }
+
+    @CheckForNull
+    @Override
+    public String language() {
+      return "";
+    }
+
+    @Override
+    public InputFile.Type type() {
+      return null;
+    }
+
+    @Override
+    public InputStream inputStream() {
+      return null;
+    }
+  }
+}