Adding option .directory for scaffolding templates #2985

santi-d · 2021-05-19T17:17:12Z

Short description 📝

Adding the possibility to copy folders when scaffolding process is made

Checklist ✅

The code architecture and patterns are consistent with the rest of the codebase.
The changes have been tested following the documented guidelines.
The CHANGELOG.md has been updated to reflect the changes. In case of a breaking change, it's been flagged as such.
In case the PR introduces changes that affect users, the documentation has been updated.

natanrolnik · 2021-05-20T22:01:53Z

@santi-d we should document these additions here as well

…ort `.directory` option

santi-d · 2021-05-21T02:12:38Z

@santi-d we should document these additions here as well

Was modified the file commented and also modified unit test that refers to scaffolding.

pepicrft

Thanks a lot for adding this improvement @santi-d. One more thing that it'd be great to add to this PR is extending this fixture to include a directory, and adding an extra step to the acceptance test that uses that feature, to ensure that the directory is copied as expected. This will prevent future regressions in your implementation. You can read more about acceptance tests here

pepicrft · 2021-05-21T07:16:13Z

@all-contributors add @santi-d for code

allcontributors · 2021-05-21T07:16:22Z

@pepibumur

I've put up a pull request to add @santi-d! 🎉

CHANGELOG.md

Co-authored-by: Daniele Formichelli <df@bendingspoons.com>

…ox/santi-d

santi-d · 2021-05-21T16:36:05Z

Thanks a lot for adding this improvement @santi-d. One more thing that it'd be great to add to this PR is extending this fixture to include a directory, and adding an extra step to the acceptance test that uses that feature, to ensure that the directory is copied as expected. This will prevent future regressions in your implementation. You can read more about acceptance tests here

@pepibumur was modified fixture adding new template case with copy folder tree and acceptance testing was increased with this approach. thanks

…ox/santi-d

fortmarek

This is looking good 🖤 just some minor comments 🙂

fortmarek · 2021-05-22T11:36:24Z

Sources/ProjectDescription/Template/Template.swift

+    ///     - path: Path where will be copied the folder
+    ///     - sourcePath: Path of folder which will be copied
+    /// - Returns: `Template.File` that is `.file`
+    static func directory(path: String, sourcePath: Path) -> Template.File {


the naming of Template.File does not really make sense anymore. Maybe Template.Item? I am open to other suggestions as well

do you think is ok change also the signatures from files to items too (in all app)??
eg:

let template = Template( description: "", attributes: [ .required("name"), .optional("aName", default: "defaultName"), .optional("bName", default: ""), ], items: [ .string(path: "static.swift", contents: "content"), .file(path: "generated.swift", templatePath: "generate.swift"), .directory(path: "destinationFolder", sourcePath: "sourceFolder"), ] )

yes, but I'd also keep the current init and mark it deprecated, so this does not end up a breaking change.

Added new init and the tag for deprecation.

fortmarek · 2021-05-22T11:38:17Z

projects/docs/docs/commands/scaffold.md

@@ -54,4 +58,6 @@ Since platform is an optional argument, we can also call the command without the

 If `.string` and `.files` don't provide enough flexibility, you can leverage the [Stencil](https://github.com/stencilproject/Stencil) templating language via the `.file` case. Besides that, you can also use additional filters defined [here](https://github.com/SwiftGen/StencilSwiftKit#filters)

+Additionally is given `.directory` which gives the possibility to copy entire folders from one path inside another.


Suggested change

Additionally is given `.directory` which gives the possibility to copy entire folders from one path inside another.

You can also use `.directory` which gives the possibility to copy entire folders to a given path.

Changed, thanks :)

...s_app_with_templates/Tuist/Templates/custom_using_copy_folder/custom_using_copy_folder.swift

fortmarek · 2021-05-22T11:44:10Z

Sources/TuistScaffold/TemplateGenerator.swift

@@ -107,11 +107,19 @@ public final class TemplateGenerator: TemplateGenerating {
                } else {
                    renderedContents = fileContents
                }
+            case let .directory(path):


I'd test this in TemplateGeneratorTests

Added and tested :)

fortmarek · 2021-05-22T11:45:50Z

Sources/TuistScaffold/TemplateGenerator.swift

@@ -107,11 +107,19 @@ public final class TemplateGenerator: TemplateGenerating {
                } else {
                    renderedContents = fileContents
                }
+            case let .directory(path):
+                let destinationContainerPath = destinationPath.appending(components: [$0.path.pathString, path.basename])


I'd rename destinationContainerPath to destinationDirectoryPath.

Also nit: you can leverage the variadic arguments for appending() and rewrite .appending(components: [x, y]) to .appending(components: x, y)

cool, thanks

pepicrft · 2021-05-24T15:22:06Z

add @santi-d for code

fortmarek

Thanks a lot for this contribution! LGTM once the pipeline is green ✅

Santiago Delgado added 2 commits May 19, 2021 12:03

[WIP] Adding option for scaffolding files

585f74b

Use of file manager for copying folder, removed recursive copy files

c01d44a

santi-d changed the title ~~[WIP] Adding option for scaffolding files~~ Adding option .directory for scaffolding templates May 20, 2021

adding documentation in scaffold.md and unit test modified for supp…

1cca773

…ort `.directory` option

pepicrft approved these changes May 21, 2021

View reviewed changes

allcontributors bot mentioned this pull request May 21, 2021

docs: add santi-d as a contributor #2992

Merged

danieleformichelli reviewed May 21, 2021

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

Santiago A. Delgado and others added 3 commits May 21, 2021 09:26

Update CHANGELOG.md

de655a7

Co-authored-by: Daniele Formichelli <df@bendingspoons.com>

Adding acceptance testing

17fcccb

Merge branch 'sandbox/santi-d' of github.com:santi-d/tuist into sandb…

25b330f

…ox/santi-d

Santiago Delgado and others added 3 commits May 21, 2021 11:38

Merge branch 'main' into sandbox/santi-d

c5004b0

Merge branch 'main' into sandbox/santi-d

3326588

Merge branch 'sandbox/santi-d' of github.com:santi-d/tuist into sandb…

d67cac5

…ox/santi-d

fortmarek reviewed May 22, 2021

View reviewed changes

changing Template.File for Template.Item and other comment in PR

62549f6

fortmarek approved these changes May 24, 2021

View reviewed changes

Fixing references for items/files in templates

2e4763a

fortmarek merged commit 74fbf01 into tuist:main May 25, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding option .directory for scaffolding templates #2985

Adding option .directory for scaffolding templates #2985

santi-d commented May 19, 2021 •

edited

natanrolnik commented May 20, 2021

santi-d commented May 21, 2021

pepicrft left a comment

pepicrft commented May 21, 2021

allcontributors bot commented May 21, 2021

santi-d commented May 21, 2021

fortmarek left a comment

fortmarek May 22, 2021

santi-d May 22, 2021 •

edited

fortmarek May 23, 2021

santi-d May 23, 2021

fortmarek May 22, 2021

santi-d May 23, 2021

fortmarek May 22, 2021

santi-d May 23, 2021

fortmarek May 22, 2021

santi-d May 23, 2021

pepicrft commented May 24, 2021

fortmarek left a comment

		@@ -54,4 +58,6 @@ Since platform is an optional argument, we can also call the command without the

		If `.string` and `.files` don't provide enough flexibility, you can leverage the [Stencil](https://github.com/stencilproject/Stencil) templating language via the `.file` case. Besides that, you can also use additional filters defined [here](https://github.com/SwiftGen/StencilSwiftKit#filters)

		Additionally is given `.directory` which gives the possibility to copy entire folders from one path inside another.

	Additionally is given `.directory` which gives the possibility to copy entire folders from one path inside another.
	You can also use `.directory` which gives the possibility to copy entire folders to a given path.

Adding option .directory for scaffolding templates #2985

Adding option .directory for scaffolding templates #2985

Conversation

santi-d commented May 19, 2021 • edited

Short description 📝

Checklist ✅

natanrolnik commented May 20, 2021

santi-d commented May 21, 2021

pepicrft left a comment

Choose a reason for hiding this comment

pepicrft commented May 21, 2021

allcontributors bot commented May 21, 2021

santi-d commented May 21, 2021

fortmarek left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

santi-d May 22, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pepicrft commented May 24, 2021

fortmarek left a comment

Choose a reason for hiding this comment

santi-d commented May 19, 2021 •

edited

santi-d May 22, 2021 •

edited