Problem with including macros to project locally

[timoninas]

Here I try to include my macros locally into the project. But eventually have this issue in logs:
Error: external macro implementation type 'MyLocalMcr.MockekeMacro' could not be found for macro 'Mockeke()'

I'm using 2.42.0 XcodeGen

My yml config:

name: TemplateProject
options:
  deploymentTarget:
    iOS: "15.0"

settings:
  base:
    MARKETING_VERSION: 1.0

targetTemplates:
  Framework:
    type: framework
    platform: iOS
    settings:
      BUILD_LIBRARY_FOR_DISTRIBUTION: true
    info:
      path: Info.plist

packages:
  MyLocalMcr:
    path: ./../MyLocalMcr   // Here I try to include it

targets:
  TemplateProjectDemo:
    type: application
    platform: iOS
    deploymentTarget: "15.0"
    info:
      path: TemplateProjectDemo/Info.plist
      properties:
        NSAppTransportSecurity:
          NSAllowsArbitraryLoads: true
    sources:
      - TemplateProjectDemo
    dependencies:
      - framework: Products/xc/TemplateProject.xcframework
      - package: MyLocalMcr
        linkType: static
        destinationFilters: [iOS, macOS]
      - framework: Products/xc/OtherFramework1.xcframework
      - framework: Products/xc/OtherFramework1.xcframework
      - framework: Products/xc/OtherFramework1.xcframework

Could you please provide examples: how to include macros into the project (as local package, or as target, etc)
Because I have faced it today and it's stumbling block for my project :(

MyLocalMcr is SPM package

import CompilerPluginSupport
import PackageDescription

let package = Package(
    name: "MyLocalMcr",
    platforms: [.macOS(.v10_15), .iOS(.v13), .tvOS(.v13), .macCatalyst(.v13)],
    products: [
        .library(
            name: "MyLocalMcr",
            targets: ["MyLocalMcr"]
        )
    ],
    dependencies: [
        .package(url: "https://github.com/apple/swift-syntax.git", from: "509.0.0")
    ],
    targets: [
        .macro(
            name: "MyLocalMcrMacros",
            dependencies: [
                .product(name: "SwiftSyntaxMacros", package: "swift-syntax"),
                .product(name: "SwiftCompilerPlugin", package: "swift-syntax")
            ]
        ),

        .target(name: "MyLocalMcr", dependencies: ["MyLocalMcrMacros"])
    ]
)

XcodeGen macros error
Macros doesn't work with XcodeGen

[2gury]

I've the same problem recently. Could you make some resolution about it? 🙏

[timoninas]

Hello, @yonaskolb!
I've seen this issue #1428
And thought you could help me with this issue or provide examples of including macros into the project/sdk package 🙏

[Lutzifer]

@timoninas can you create a minimal example of your project as a repo to look at?

[renaudjennymonese]

FWIW, I was able to potentially reproduce the issue (and find a solution for my project), but now I believe the problem is not strictly related to XCodeGen.
tl;dr: don't forget to add the package dependency to (all) your module targets as well!

Here is a quick glance of my project.yml that I used to reproduce a similar issue

name: XCodeGenMacros
options:
  bundleIdPrefix: com.xcodegen.macros
packages:
  swift-perception:
    url: https://github.com/pointfreeco/swift-perception
    from: 1.6.0
configs:
  Test Debug: debug
  Staging Debug: debug
  Production Debug: debug
  Test Release: release
  Staging Release: release
  Production Release: release
targets:
  XCodeGenMacrosApp:
    type: application
    platform: iOS
    deploymentTarget: "15.0"
    sources: [XCodeGenMacrosApp]
    settings:
      base:
        CODE_SIGN_ENTITLEMENTS: XCodeGenMacrosApp.entitlements
        GENERATE_INFOPLIST_FILE: true
    dependencies:
    - target: TargetModule
    - package: swift-perception
      products:
        - Perception
        - PerceptionCore
  TargetModule:
    type: library.static
    platform: iOS
    deploymentTarget: "15.0"
    sources: [TargetModule]
    dependencies:
    - package: swift-perception
      products:
        - Perception
        - PerceptionCore
schemes:
  dev:
    build:
      targets:
        XCodeGenMacrosApp: [run, test, profile, analyze, archive]
    run:
      commandLineArguments:
        "-_UIConstraintBasedLayoutPlaySoundOnUnsatisfiable YES": true
      config: Test Debug
    test:
      config: Test Debug
      targets: [XCodeGenMacrosApp]
      gatherCoverageData: true
    profile:
      config: Test Debug
    analyze:
      config: Test Debug
    archive:
      config: Test Release

See the TargetModule module I've added with some UI code that uses Perception dependency. It's explicitly added.
The XCodeGenMacrosApp has a dependence to TargetModule

My initial mistake was to omit to write once again

    dependencies:
    - package: swift-perception
      products:
        - Perception
        - PerceptionCore

As it was already written for the "main" application. My assumption was to think that it's done once in the project, so everything should be fine. But I'm only partially wrong! And everything is confusing because of this partially 😭 .

Interestingly, with just that

  XCodeGenMacrosApp:
    type: application
    ...
    dependencies:
    - target: TargetModule
    - package: swift-perception
      products:
        - Perception
        - PerceptionCore
  TargetModule:
    type: library.static
    ...

So by omitting to declare the dependency again for TargetModule. I'm able to still import Perception and use some of the available methods, like in the SwiftUI views I can use WithPerceptionTracking and it compiles and run!

I hope that will help some of you.