Add support for copy files phase

[hebertialmeida]

Resolves #2075

Short description 📝

This adds the ability to copy files as a copy files phase.

Solution 📦

Copy the files and create references similiar to resources and add a PBXCopyFilesBuildPhase. One issue is that the packages are not "recognized" on Tuist, so I had to add some validations to check the UTI of a file in order to add the custom packages as whole file instead of its internal file list.

Implementation 👩‍💻👨‍💻

I've reused the implementation of resources for some steps or I've tried to follow the same pattern. One thing I considered is to add a static func for the CopyFilesAction instead of using init, just like TargetActions.

Sample usage:

Target(
    name: "App",
    platform: .macOS,
    product: .app,
    bundleId: "io.tuist.App",
    copyFiles: [
        .sharedSupport(
            name: "Copy Templates",
            subpath: "Templates",
            files: ["/SharedSupport/Templates/**"]
        ),
        .resources(
            name: "Copy Fonts",
            subpath: "Fonts",
            files: ["/Fonts/**"]
        )
    ]
)

• Validate api design
• Add tests
• Add fixture
• Update documentation
• Update CHANGELOG

[fortmarek]

Thanks for doing this! I have some initial remarks, maybe adding a fixture for the new API would help me understand some steps you have taken (especially the UTI handling)

[hebertialmeida]

Adding a little bit more of context to this.

On iOS apps everything is bundled under Copy Bundle Resources and the files you add for the app will be inside the app bundle. On macOS apps things are a little bit different, for example custom fonts have to be added to a custom folder via copy files phase and referred on .plist file using the key ATSApplicationFontsPath, not as simple as on iOS. Adding support or that will enable these apps to copy files/executables to the proper paths, things like themes, templates, fonts...

Many times these files are packages, basically a folder with a custom extension like .pages, .sketch but they are recognized by the OS as a single file because these apps register a UTI for that extension.

That's why I believe having the name property is important so you see a can organized list and make sense of what is each phase. In addition to that I think naming it CopyFilesPhase makes more sense than BundledFiles. In some places I've used the word Action but that's I'm not sure about that...

This is an example of my app:

Apple Pages also do the same thing:

https://help.apple.com/xcode/mac/10.2/#/dev50bab713d

[hebertialmeida]

Thanks for doing this! I have some initial remarks, maybe adding a fixture for the new API would help me understand some steps you have taken (especially the UTI handling)

Will do that!

[pepicrft]

It's looking great @hebertialmeida. Very solid work and consistent with the rest of the codebase 👏. I'm looking forward to seeing this feature on Tuist.
One more suggestion that I'd make is to make sure to update the CHANGELOG and the documentation website.

[kwridan]

Nice work on this @hebertialmeida - thanks for adding this!

@fortmarek and @pepibumur have covered most points, one addition to help us test this locally and show case this feature is to introduce a new fixture in fixtures/ that exercises the new additions.

[hebertialmeida]

I'm seeing the linter fail in lines I haven't touched, is that normal? Should I just fix it?

[kwridan]

I'm seeing the linter fail in lines I haven't touched, is that normal? Should I just fix it?

I think the linter flags any issues on the file level rather than the diff - should be ok to fix it. There are a few rake tasks to run the same checks as CI

bundle exec rake style_correct

[kwridan]

Thanks for all the updates @hebertialmeida - the PR is looking great!

[pepicrft]

Thank you very much @hebertialmeida for addressing the comments. There's only one more thing and we can merge the PR afterward, adding documentation. Since we are changing the public API that users have access to, I'd recommend updating this page to indicate that targets have now an attribute, and what the attribute is for.

[pepicrft]

@all-contributors add @hebertialmeida

[allcontributors]

@pepibumur

I couldn't determine any contributions to add, did you specify any contributions?
Please make sure to use valid contribution names.

[pepicrft]

@all-contributors add @hebertialmeida for code

[allcontributors]

@pepibumur

I've put up a pull request to add @hebertialmeida! 🎉

[hebertialmeida]

@pepibumur @fortmarek @kwridan thanks for the guidance and @natanrolnik for helping me build the project! I have updated the documentation and will merge that after all checks pass.

[hebertialmeida]

I can't merge it, so please merge it when you can...