Unclear Readme

[BokaTano]

Hi, just saw your video.
This looks awesome!
How can I get it working, so that I can see warnings in Xcode? I do not fully understand the ReadMe. Do I need to add the RendererPlugin somewhere?
Thanks a lot 👏

[rock88]

Hi @BokaTano,

This repository contains two examples where you can see how to use this plugin: ExamplePackage and ExampleXcode (Plugin added to Xcode project, used tuist to generate Xcode project/workspace).

But let's add this plugin to the existing package, step by step. For example I want to add this plugin to The Composable Architecture, I will be using the latest version 1.10.4:

1. First need to add PeripheryPlugin to the package dependency as a regular package (since ComposableArchitecture contains Package@swift-5.9.swift, I'll add the plugin there, but usually adding it to Package.swift is enough):

  dependencies: [
    .package(url: "https://github.com/pointfreeco/swiftui-navigation", from: "1.1.0"),
    .package(url: "https://github.com/pointfreeco/xctest-dynamic-overlay", from: "1.1.0"),
+   .package(url: "https://github.com/rock88/PeripheryPlugin", from: "1.0.0"),
  ],

After resolving/reloading the package dependencies, you may see PeripheryPlugin in the package dependencies:

2. Now need to build the whole package or some specific target (for creating an Index/DataStore), let's build swift-composable-architecture-Package:

Cmd+B (Trust and enable macros if necessary):

3. At this step we can run Periphery plugin, right click on the package and choose Periphery plugin from the PeripheryPlugin section:

You can select some specific targets or all of them, let's select all and click Run:

4. In the Report Navigator tab, we can select the Package/Plug-in command invocation and see the Periphery output:

This is all about basic integration. Also I have no idea how to pass this output into the ComposableArchitecture build output (I think it's not possible at the moment), so let's move on.

5. To handle the output of Periphery during the ComposableArchitecture build phase and display all warnings in Xcode, need to add another plugin - PeripheryPlugin to the target.plugin section. Change Package@swift-5.9.swift as follows:

    .target(
      name: "ComposableArchitecture",
      dependencies: [
        ...
      ],
      resources: [
        .process("Resources/PrivacyInfo.xcprivacy")
-     ]
+     ],
+      plugins: [
+        .plugin(name: "PeripheryPlugin", package: "PeripheryPlugin")
+      ]
    ),

6. Build again and the Periphery output should appear in Xcode (may have to run Periphery again or reopen the package to have Xcode apply the PeripheryPlugin to the ComposableArchitecture target):

7. For provide a config for the Periphery we can create a .periphery.yml at root directory of the package with the following content:

retain_public: true
disable_redundant_public_analysis: true
retain_codable_properties: true

Run the Periphery plugin and build the package, we now see fewer warnings (48 vs 92):

8. For clean the Periphery output use the Periphery (Clean) plugin:

---

As you can see, in order to see new warnings, you need to build the package, run the Periphery plugin manually and build the package again. This is intentional and I'm not sure that the Periphery will work correctly if converted it from a command to a buildTool plugin (due to changes in the Index/DataStore, the build time will also be affected).

This is all about PeripheryPlugins 😁

[BokaTano]

Hello 👋,
thanks so much for the energy you put into explaining.
Unfortunately my colleagues and I could not really figure out how to follow your guide. Perhaps because we have a simpler setup. Just a Xcode Project generated by Xcode.
We also can not see 7 of your screenshots. I guess they are not sourced remotely.

What we were able to do:

1. Install periphery via homebrew and then the scan command in the terminal does work.
2. We installed your plugin as a new package via this repo: https://github.com/rock88/PeripheryPlugin
3. We ran the plugin via ctrl click on the project and our report tab, gave us "Activity Log Complete"
   

So where or what is the missing peace, that we can see the warnings in our project?
We tried cleaning, building, scaning, reopening Xcode in all different combinations :D

We also downloaded your example project and it did not work on our machines.

I hope we are not bothering, and thanks again for your interesting explanations :)

[rock88]

Hi @BokaTano,

Please make sure you select the Periphery command (not Periphery (Clean)).
After that, please attach the logs of the command invocation.

Currently, Periphery has one limitation that may prevent it from launching (if you use local Package.swift), all errors will be shown in the logs that I wrote about above.

[BokaTano]

On my machine I could not get further than invoking the plugin, it only gives the "Activity Log complete" when I close Xcode.

Plug-in command “Periphery”…_2024-06-07T10-46-56_2.txt

When my colleague has different logs I will add them :)

Edit: My colleagues also have the ever running plugin Problem.