Adding support for project additional files #314

kwridan · 2019-03-31T19:38:37Z

Part of #202

Short description 📝

Often projects may include additional files or folder references that don't need to be part of any build phase (e.g. design references, documentation etc...)

Solution 📦

Workspace.swift manifest now supports additionalFiles, the same concept can be added to the Project.swift manifest with the same rules.

.glob(pattern: "Documentation/**"): glob pattern to one or more files
.folderReference(path: "Designs"): single path to a directory that is added as a folder reference

Example:

let project = Project(name: "App",
                      targets: [
                           // ...
                      ],
                      additionalFiles: [
                         "Dangerfile.swift"
                         "Documentation/**",
                         .folderReference(path: "Designs")
                     ])

Implementation 👩‍💻👨‍💻

Detail in a checklist the steps that you took to implement the PR.

Update Project manifest to include additionalFiles
Update models to translate globs to paths
Update ProjectFileElements to include additionalFiles
Include fixture
Update documentation
Update changelog

Test Plan ⚒

Run tuist generate within fixtures/ios_app_with_custom_workspace/App
Open the generated workspace
Verify Dangerfile.swift is included in the project but isn't part of the resource phase
Verify Documentation files are included (with the appropriate group structure that reflects the file system) and that the files aren't copied to resources
Verify Server folder reference is included

…ption

tuistbot · 2019-03-31T19:42:16Z

	1 Warning
⚠️	Have you introduced any user-facing changes? If so, please take some time to update the documentation. Keeping the documentation up to date makes it easier for users to learn how to use Tuist.

Generated by 🚫 Danger

codecov · 2019-03-31T19:50:41Z

Codecov Report

Merging #314 into master will increase coverage by 0.14%.
The diff coverage is 97.77%.

@@            Coverage Diff             @@
##           master     #314      +/-   ##
==========================================
+ Coverage   89.32%   89.47%   +0.14%     
==========================================
  Files         278      280       +2     
  Lines       10616    10707      +91     
==========================================
+ Hits         9483     9580      +97     
+ Misses       1133     1127       -6

Impacted Files	Coverage Δ
...rces/TuistKit/Generator/GeneratorModelLoader.swift	`90.82% <100%> (+0.62%)`	⬆️
...atorTests/Generator/ProjectFileElementsTests.swift	`99.68% <100%> (+0.01%)`	⬆️
Sources/ProjectDescription/Workspace.swift	`100% <100%> (+12.9%)`	⬆️
Sources/TuistGenerator/Generator.swift	`78.94% <100%> (ø)`	⬆️
...erator/Generator/WorkspaceStructureGenerator.swift	`77.27% <100%> (ø)`	⬆️
...tKitTests/Generator/GeneratorModelLoaderTest.swift	`98.36% <100%> (+0.17%)`	⬆️
...atorTests/Models/TestData/Workspace+TestData.swift	`100% <100%> (ø)`	⬆️
...nerator/TestData/ProjectDescription+TestData.swift	`100% <100%> (ø)`	⬆️
...ratorTests/Generator/WorkspaceGeneratorTests.swift	`93.69% <100%> (ø)`	⬆️
Sources/TuistGenerator/Models/Project.swift	`58% <100%> (+0.85%)`	⬆️
... and 10 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2726304...b640532. Read the comment docs.

ollieatkinson · 2019-04-01T10:06:33Z

Sources/ProjectDescription/Project.swift

-        case targets
-        case settings
-    }
+    public let additionalFiles: [WorkspaceElement]


Is this still a workspace element?

If we'd like to reuse the same type I'd change the name.

agreed - was looking for better names:

Reference, Element: too broad?

FileReference, FileElement: Folder references aren't files :/

Will think some more on suitable alternatives, if you had any please do share :)

I'd stick to the Xcode project's convention, FileElement

ollieatkinson

🔍 Changes look good to me! It's really nice to see that the work from implementing a better Workspace.swift is coming in handy!

pepicrft · 2019-04-01T12:40:58Z

fixtures/ios_app_with_custom_workspace/App/Server/server.py

@@ -0,0 +1,3 @@
+import json


heh - can replace this with a different fixture that doesn't look as dubious - the intention was to show case a folder reference to some sever looking code

- Renaming previous internal `FileElement` to `GroupFileElement`

kwridan added 5 commits March 31, 2019 19:47

Adding fixture

69a1717

Extract Workspace.Element > WorkspaceElement within ProjectDescri…

7f683e5

…ption

Updating models to reflect manifest changes of WorkspaceElement

b04dca3

Additional files are now included in the generated projects

2ddccc3

Updating fixture

9867a72

ollieatkinson reviewed Apr 1, 2019

View reviewed changes

ollieatkinson approved these changes Apr 1, 2019

View reviewed changes

pepicrft reviewed Apr 1, 2019

View reviewed changes

pepicrft approved these changes Apr 1, 2019

View reviewed changes

kwridan added 4 commits April 2, 2019 23:27

Renaming WorkspaceElement to FileElement

dc3364e

- Renaming previous internal `FileElement` to `GroupFileElement`

Updating fixture

f27422c

Updating documentation

c5ca621

Updating changelog

b640532

kwridan merged commit 8d7f15f into tuist:master Apr 3, 2019

kwridan deleted the feature/202-1-project-additional-files branch April 3, 2019 08:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding support for project additional files #314

Adding support for project additional files #314

kwridan commented Mar 31, 2019 •

edited

tuistbot commented Mar 31, 2019 •

edited

codecov bot commented Mar 31, 2019 •

edited

ollieatkinson Apr 1, 2019

pepicrft Apr 1, 2019

kwridan Apr 1, 2019

pepicrft Apr 2, 2019

ollieatkinson left a comment

pepicrft Apr 1, 2019

kwridan Apr 1, 2019 •

edited

Adding support for project additional files #314

Adding support for project additional files #314

Conversation

kwridan commented Mar 31, 2019 • edited

Short description 📝

Solution 📦

Implementation 👩‍💻👨‍💻

Test Plan ⚒

tuistbot commented Mar 31, 2019 • edited

codecov bot commented Mar 31, 2019 • edited

Codecov Report

ollieatkinson Apr 1, 2019

Choose a reason for hiding this comment

pepicrft Apr 1, 2019

Choose a reason for hiding this comment

kwridan Apr 1, 2019

Choose a reason for hiding this comment

pepicrft Apr 2, 2019

Choose a reason for hiding this comment

ollieatkinson left a comment

Choose a reason for hiding this comment

pepicrft Apr 1, 2019

Choose a reason for hiding this comment

kwridan Apr 1, 2019 • edited

Choose a reason for hiding this comment

kwridan commented Mar 31, 2019 •

edited

tuistbot commented Mar 31, 2019 •

edited

codecov bot commented Mar 31, 2019 •

edited

kwridan Apr 1, 2019 •

edited