Put back aspect hint. Fix unit tests

Author: jflan-dd

docs/BUILD

@@ -21,7 +21,10 @@ _DOC_COMPONENTS = [
         out = "{}.md".format(component),
         input = "//xcodeproj/internal/docs:{}.bzl".format(component),
         tags = ["manual"],
-        deps = ["//xcodeproj/internal"],
+        deps = [
+            "//xcodeproj/internal",
+            "//xcodeproj/internal/files",
+        ],
     )
     for component in _DOC_COMPONENTS
 ]

docs/bazel.md

@@ -50,6 +50,8 @@ load("@rules_xcodeproj//xcodeproj:defs.bzl", "xcodeproj")
 - [Providers](#providers)
   - [`XcodeProjAutomaticTargetProcessingInfo`](#XcodeProjAutomaticTargetProcessingInfo)
   - [`XcodeProjInfo`](#XcodeProjInfo)
+- [Aspect Hints](#aspect-hints)
+  - [`xcodeproj_extra_files`](#xcodeproj_extra_files)
 
 # Core
 
@@ -1095,3 +1097,47 @@ Provides information needed to generate an Xcode project.
 | <a id="XcodeProjInfo-xcode_targets"></a>xcode_targets |  A `depset` of values from `xcode_targets.make`, which potentially will become targets in the Xcode project.    |
 
 
+# Aspect Hints
+
+Aspect hints that can be used to provide additional information during project generation.
+
+<a id="xcodeproj_extra_files"></a>
+
+## xcodeproj_extra_files
+
+<pre>
+xcodeproj_extra_files(<a href="#xcodeproj_extra_files-name">name</a>, <a href="#xcodeproj_extra_files-files">files</a>)
+</pre>
+
+This rule is used to surface extra files that should be included in the Xcode
+project navigator, but otherwise aren't inputs to a target. The provider
+created by this rule should be attached to the related target via an aspect
+hint.
+
+This is only used when xcodeproj.generation_mode = "incremental" is set.
+
+**EXAMPLE**
+
+```starlark
+swift_library(
+    ...
+    aspect_hints = [":library_extra_files"],
+    ...
+)
+
+# Display the README.md file located alongside the Swift library in Xcode
+xcodeproj_extra_files(
+    name = "library_extra_files",
+    files = ["README.md"],
+)
+```
+
+**ATTRIBUTES**
+
+
+| Name  | Description | Type | Mandatory | Default |
+| :------------- | :------------- | :------------- | :------------- | :------------- |
+| <a id="xcodeproj_extra_files-name"></a>name |  A unique name for this target.   | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required |  |
+| <a id="xcodeproj_extra_files-files"></a>files |  The list of extra files to surface in the Xcode navigator.   | <a href="https://bazel.build/concepts/labels">List of labels</a> | optional |  `[]`  |
+
+

test/internal/xcodeproj_extra_files/xcodeproj_extra_files_tests.bzl

@@ -1,12 +1,15 @@
 load("@bazel_skylib//lib:unittest.bzl", "asserts", "analysistest")
-load("//xcodeproj:xcodeproj_extra_files.bzl", "xcodeproj_extra_files", "XcodeProjExtraFilesHintInfo")
+load("//xcodeproj/internal/files:xcodeproj_extra_files.bzl", "xcodeproj_extra_files", "XcodeProjExtraFilesHintInfo")
 
 def _provider_contents_test_impl(ctx):
     env = analysistest.begin(ctx)
 
     target_under_test = analysistest.target_under_test(env)
 
-    asserts.equals(env, depset(["BUILD"]), target_under_test[XcodeProjExtraFilesHintInfo].files)
+    files_list = target_under_test[XcodeProjExtraFilesHintInfo].files.to_list()
+
+    asserts.equals(env, len(files_list), 1)
+    asserts.equals(env, files_list[0].path, "test/internal/xcodeproj_extra_files/BUILD")
 
     return analysistest.end(env)
 

xcodeproj/defs.bzl

@@ -23,6 +23,7 @@ load(
     _xcodeproj = "xcodeproj",
 )
 load("//xcodeproj/internal:xcodeprojinfo.bzl", _XcodeProjInfo = "XcodeProjInfo")
+load("//xcodeproj/internal/files:xcodeproj_extra_files.bzl", _xcodeproj_extra_files = "xcodeproj_extra_files")
 load("//xcodeproj/internal/xcschemes:xcschemes.bzl", _xcschemes = "xcschemes")
 
 # Re-exporting providers
@@ -34,6 +35,7 @@ project_options = _project_options
 top_level_target = _top_level_target
 top_level_targets = _top_level_targets
 xcodeproj = _xcodeproj
+xcodeproj_extra_files = _xcodeproj_extra_files
 xcode_provisioning_profile = _xcode_provisioning_profile
 
 # Re-exporting APIs

xcodeproj/internal/docs/aspect_hints.bzl

@@ -1,12 +1,8 @@
 """# Aspect Hints
 
-Some comment...
-
-```starlark
-load("@rules_xcodeproj//xcodeproj:xcodeproj_extra_files.bzl", "xcodeproj_extra_files")
-```
+Aspect hints that can be used to provide additional information during project generation.
 """
 
-load("//xcodeproj:xcodeproj_extra_files.bzl", _xcodeproj_extra_files = "xcodeproj_extra_files")
+load("//xcodeproj/internal/files:xcodeproj_extra_files.bzl", _xcodeproj_extra_files = "xcodeproj_extra_files")
 
 xcodeproj_extra_files = _xcodeproj_extra_files

xcodeproj/internal/docs/bazel.header.md

@@ -50,5 +50,7 @@ load("@rules_xcodeproj//xcodeproj:defs.bzl", "xcodeproj")
 - [Providers](#providers)
   - [`XcodeProjAutomaticTargetProcessingInfo`](#XcodeProjAutomaticTargetProcessingInfo)
   - [`XcodeProjInfo`](#XcodeProjInfo)
+- [Aspect Hints](#aspect-hints)
+  - [`xcodeproj_extra_files`](#xcodeproj_extra_files)
 
 # Core

xcodeproj/internal/files/incremental_input_files.bzl

@@ -11,7 +11,7 @@ load(
     "memory_efficient_depset",
 )
 load("//xcodeproj/internal:xcodeprojinfo.bzl", "XcodeProjInfo")
-load("//xcodeproj:xcodeproj_extra_files.bzl", "XcodeProjExtraFilesHintInfo")
+load(":xcodeproj_extra_files.bzl", "XcodeProjExtraFilesHintInfo")
 load(":incremental_resources.bzl", resources_module = "incremental_resources")
 load(":linker_input_files.bzl", "linker_input_files")