You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CHANGELOG.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@
6
6
7
7
⚠️ This major version is a big milestone in which a lot of refactoring and cleaning has been done. Many features added over previous releases have been reworked and unified, while also preparing SwiftGen for future additions. This means that you'll need to adapt your configuration files (or command line invocations) and custom templates to work with this new major version.
8
8
9
-
Read the [SwiftGen 6.0 Migration Guide](https://github.com/SwiftGen/SwiftGen/blob/master/Documentation/MigrationGuide.md#swiftgen-60-migration-guide) for a list of changes you'll need to apply.
9
+
Read the [SwiftGen 6.0 Migration Guide](Documentation/MigrationGuide.md#swiftgen-60-migration-guide) for a list of changes you'll need to apply.
10
10
11
11
### Bug Fixes
12
12
@@ -272,7 +272,7 @@ Read the [SwiftGen 6.0 Migration Guide](https://github.com/SwiftGen/SwiftGen/blo
272
272
273
273
⚠️ This major version is a big milestone in which a lot of refactoring and cleaning has been done. Many features added over previous releases have been reworked and unified, while also preparing SwiftGen for future additions. This means that you'll need to adapt your command line invocations and custom templates to work with this new major version.
274
274
275
-
Read the [SwiftGen 5.0 Migration Guide](https://github.com/SwiftGen/SwiftGen/blob/master/Documentation/MigrationGuide.md#swiftgen-50-migration-guide) for a list of changes you'll need to apply.
275
+
Read the [SwiftGen 5.0 Migration Guide](Documentation/MigrationGuide.md#swiftgen-50-migration-guide) for a list of changes you'll need to apply.
276
276
277
277
### Changes in other SwiftGen modules
278
278
@@ -298,13 +298,13 @@ Read the [SwiftGen 5.0 Migration Guide](https://github.com/SwiftGen/SwiftGen/blo
298
298
299
299
#### Notable breaking changes from other SwiftGen repositories
300
300
301
-
* Many deprecated templates have been removed (or merged), and others have been renamed to reflect new behaviours. Please check the [templates migration guide](https://github.com/SwiftGen/templates/blob/master/Documentation/MigrationGuide.md#deprecated-templates-in-20-swiftgen-50) for more information.
301
+
* Many deprecated templates have been removed (or merged), and others have been renamed to reflect new behaviours. Please check the [templates migration guide](Documentation/templates/MigrationGuide.md#deprecated-templates-in-20-swiftgen-50) for more information.
* There have been some breaking changes in the generated code for storyboards. Please check the [templates migration guide](https://github.com/SwiftGen/templates/blob/master/Documentation/MigrationGuide.md#deprecated-templates-in-20-swiftgen-50) for more information, where we also provide a compatibility template.
304
+
* There have been some breaking changes in the generated code for storyboards. Please check the [templates migration guide](Documentation/templates/MigrationGuide.md#deprecated-templates-in-20-swiftgen-50) for more information, where we also provide a compatibility template.
* Removed deprecated template context variables, and restructured many others. Please check the [SwiftGenKit migration guide](https://github.com/SwiftGen/SwiftGenKit/blob/master/Documentation/MigrationGuide.md#swiftgenkit-20-swiftgen-50) for more information.
307
+
* Removed deprecated template context variables, and restructured many others. Please check the [SwiftGenKit migration guide](Documentation/SwiftGenKit%20Contexts/MigrationGuide.md#swiftgenkit-20-swiftgen-50) for more information.
* Some filters have been removed in favour of Stencil's built in versions, and other filters have been updated to accept parameters. Please consult the [StencilSwiftKit migration guide](https://github.com/SwiftGen/StencilSwiftKit/blob/master/Documentation/MigrationGuide.md#stencilswiftkit-20-swiftgen-50) for more information.
@@ -410,7 +410,7 @@ In preparation for an upcoming cleanup of SwiftGen to remove some legacy code as
410
410
411
411
As a result, if you wrote custom templates, you should already prepare for the upcoming 5.0 by migrating your templates to use the new variables (already avaiable in SwiftGen 4.2 / SwiftGenKit 1.0).
412
412
413
-
See [#244](https://github.com/SwiftGen/SwiftGen/issues/244) and [the Migration Guide in the Wiki](https://github.com/SwiftGen/SwiftGen/wiki/Migration-Guides) for a list of deprcations and their replacements.
413
+
See [#244](https://github.com/SwiftGen/SwiftGen/issues/244) and [the Migration Guide](Documentation/MigrationGuide.md) for a list of deprecations and their replacements.
414
414
415
415
### Internal changes
416
416
@@ -626,7 +626,7 @@ Note: The next minor version will focus on bringing more documentation for all t
626
626
627
627
> 💡 You can now **create your custom templates more easier than ever**, by cloning an existing template!
628
628
>
629
-
> e.g. to clone [the default `strings-default.stencil` template](https://github.com/SwiftGen/SwiftGen/blob/master/templates/strings-default.stencil):
629
+
> e.g. to clone [the default `strings-default.stencil` template](https://github.com/SwiftGen/SwiftGen/blob/3.0.0/templates/strings-default.stencil):
630
630
>
631
631
> * use `swiftgen templates cat strings --output strings-custom.stencil`
632
632
> * modify the cloned `strings-custom.stencil` template to your liking
Copy file name to clipboardExpand all lines: Documentation/Creating-your-templates.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Customize SwiftGen templates
2
2
3
-
This document describes how to make your own templates for SwiftGen, so it can generate code more to your liking and code following your own coding conventions. For in depth documentation of the bundled templates, we refer you to the documentation for [each specific template](https://github.com/SwiftGen/templates/tree/master/Documentation).
3
+
This document describes how to make your own templates for SwiftGen, so it can generate code more to your liking and code following your own coding conventions. For in depth documentation of the bundled templates, we refer you to the documentation for [each specific template](templates).
4
4
5
5
## Templates files on disk (Search Path priority)
6
6
@@ -91,4 +91,4 @@ Additionally to the [tags and filters](https://stencil.fuller.li/en/latest/built
91
91
92
92
When SwiftGen generates your code, it provides a context (a dictionary) with the variables containing what assets/colors/strings/… the subcommand did detect, to render your Stencil template using those variables.
93
93
94
-
A full documentation of the produced context for each command can be found in the [SwiftGenKit documentation](https://github.com/SwiftGen/SwiftGen/blob/master/Documentation/SwiftGenKit%20Contexts/).
94
+
A full documentation of the produced context for each command can be found in the [SwiftGenKit documentation](SwiftGenKit%20Contexts).
Copy file name to clipboardExpand all lines: Documentation/MigrationGuide.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ All the migration guides for SwiftGen are spread out over a few files, depending
7
7
|-----------------|-----------------|---------|
8
8
| SwiftGen Migration Guide (this file) | All users of SwiftGen | Changes in configuration, CLI parameters and global changes overview |
9
9
|[Templates Migration Guide](templates/MigrationGuide.md)| Users of SwiftGen's bundled templates (`templateName` option) | Some templates may have been renamed, removed or merged, or their functionality may have changed |
10
-
|[SwiftGenKit Migration Guide](SwiftGenKit Contexts/MigrationGuide.md) | Template writers | Changes in names of variables provided by SwiftGenKit to your templates |
10
+
|[SwiftGenKit Migration Guide](SwiftGenKit%20Contexts/MigrationGuide.md)| Template writers | Changes in names of variables provided by SwiftGenKit to your templates |
11
11
|[StencilSwiftKit Migration Guide](https://github.com/SwiftGen/StencilSwiftKit/blob/master/Documentation/MigrationGuide.md)| Template writers | Changes in extra filters and tags for use in templates |
12
12
13
13
# SwiftGen 6.0 Migration Guide
@@ -114,7 +114,7 @@ For more information, read the [creating your own templates](Creating-your-templ
114
114
115
115
SwiftGen 6.0 uses the latest Stencil and StencilSwiftKit libraries, so there are plenty of new features for template writers, such as variable subscripting, an `indent` filter, better error reporting, ...
116
116
117
-
There have been a few minor context changes, see [SwiftGenKit's own Migration Guide](SwiftGenKit Contexts/MigrationGuide.md#swiftgenkit-20-swiftgen-50-migration-guide) for more information.
117
+
There have been a few minor context changes, see [SwiftGenKit's own Migration Guide](SwiftGenKit%20Contexts/MigrationGuide.md#swiftgenkit-20-swiftgen-50-migration-guide) for more information.
118
118
119
119
120
120
# SwiftGen 5.1 Migration Guide
@@ -202,7 +202,7 @@ For example:
202
202
* for the `xcassets` command — previously named `images` — the root key isn't the `images` array anymore, but the `catalogs` key instead, listing all the Assets Catalogs that SwiftGen parsed;
203
203
* for strings, now that SwiftGen support more than one `.strings` localizations table, the root key you iterate over isn't `strings` or `structuredStrings` but is not a `tables` array, and its structure has changed a bit.
204
204
205
-
These are just a few of the changes to the structure of the variables passed by SwiftGenKit to your templates. To learn more about all the variables which have been renamed, removed or added and the new structures for each SwiftGen command, see [SwiftGenKit's own Migration Guide](SwiftGenKit Contexts/MigrationGuide.md#swiftgenkit-20-swiftgen-50-migration-guide).
205
+
These are just a few of the changes to the structure of the variables passed by SwiftGenKit to your templates. To learn more about all the variables which have been renamed, removed or added and the new structures for each SwiftGen command, see [SwiftGenKit's own Migration Guide](SwiftGenKit%20Contexts/MigrationGuide.md#swiftgenkit-20-swiftgen-50-migration-guide).
206
206
207
207
### Some SwiftGen-specific Stencil filters evolved
208
208
@@ -216,6 +216,6 @@ Also, a few dedicated Stencil filters provided by SwiftGen (via StencilSwiftKit)
216
216
<details>
217
217
<summary>Migration Guide</summary>
218
218
219
-
If you're still using SwiftGen 4.x, you should at least consider follow the [SwiftGen 4.2 Migration Guide](SwiftGenKit Contexts/MigrationGuide.md#swiftgen-42-migration-guide) to prepare your migration to SwiftGen 5.0 smoothly, by getting rid of deprecated variables in your contexts.
219
+
If you're still using SwiftGen 4.x, you should at least consider follow the [SwiftGen 4.2 Migration Guide](SwiftGenKit%20Contexts/MigrationGuide.md#swiftgen-42-migration-guide) to prepare your migration to SwiftGen 5.0 smoothly, by getting rid of deprecated variables in your contexts.
Copy file name to clipboardExpand all lines: Documentation/SwiftGenKit Contexts/MigrationGuide.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,7 +28,7 @@ If you're migrating from SwiftGenKit 1.x to SwiftGenKit 2.0 — which is the cas
28
28
29
29
## Changes for template writers
30
30
31
-
As a reminder, you can find all the documentation for the context structures provided as variables to your templates [in the Documentation folder of this repository](https://github.com/SwiftGen/SwiftGenKit/tree/master/Documentation/) — one MarkDown file for each SwiftGen subcommand / SwiftGenKit parser.
31
+
As a reminder, you can find all the documentation for the context structures provided as variables to your templates [in the Contexts Documentation folder of this repository](.) — one MarkDown file for each SwiftGen subcommand / SwiftGenKit parser.
32
32
33
33
### Common changes and the new `--param` flags
34
34
@@ -40,7 +40,7 @@ You can also take advantage of that new `--param` feature to make your own templ
40
40
41
41
### Colors
42
42
43
-
_📖 see the full context structure [in the documentation here](https://github.com/SwiftGen/SwiftGenKit/blob/master/Documentation/Colors.md)._
43
+
_📖 see the full context structure [in the documentation here](Colors.md)._
44
44
45
45
-`enumName` has been replaced by `param.enumName` — [see above](#common-changes-and-the-new---param-flags).
46
46
-`colors` has been replaced by the `palettes` array, each entry having a `name` and a `colors` property.
@@ -49,22 +49,22 @@ _📖 see the full context structure [in the documentation here](https://github.
49
49
50
50
### Fonts
51
51
52
-
_📖 see the full context structure [in the documentation here](https://github.com/SwiftGen/SwiftGenKit/blob/master/Documentation/Fonts.md)._
52
+
_📖 see the full context structure [in the documentation here](Fonts.md)._
53
53
54
54
-`enumName` has been replaced by `param.enumName` — [see above](#common-changes-and-the-new---param-flags).
55
55
- for each `font`:
56
56
-`fontName` has been replaced by the `name` property.
57
57
58
58
### XCAssets (formerly Images)
59
59
60
-
_📖 see the full context structure [in the documentation here](https://github.com/SwiftGen/SwiftGenKit/blob/master/Documentation/Assets.md)._
60
+
_📖 see the full context structure [in the documentation here](Assets.md)._
61
61
62
62
-`enumName` has been replaced by `param.enumName` — [see above](#common-changes-and-the-new---param-flags).
63
63
-`images` is deprecated. The new root key is named `catalogs` and contains the structured information.
64
64
65
65
### Storyboards
66
66
67
-
_📖 see the full context structure [in the documentation here](https://github.com/SwiftGen/SwiftGenKit/blob/master/Documentation/Storyboards.md)._
67
+
_📖 see the full context structure [in the documentation here](Storyboards.md)._
68
68
69
69
-`extraImports` has been renamed `modules` (see [SwiftGen/SwftGen#243](https://github.com/SwiftGen/SwiftGen/pull/243))
70
70
-`sceneEnumName` has been replaced by `param.sceneEnumName` — [see above](#common-changes-and-the-new---param-flags).
@@ -74,7 +74,7 @@ _📖 see the full context structure [in the documentation here](https://github.
74
74
75
75
### Strings
76
76
77
-
_📖 see the full context structure [in the documentation here](https://github.com/SwiftGen/SwiftGenKit/blob/master/Documentation/Strings.md)._
77
+
_📖 see the full context structure [in the documentation here](Strings.md)._
78
78
79
79
-`enumName` has been replaced by `param.enumName` — [see above](#common-changes-and-the-new---param-flags).
80
80
-`strings` and `structuredStrings` have been replaced by the `tables` array, where each table has a structured `levels` property.
@@ -122,7 +122,7 @@ They will no longer be available after the next major release of SwiftGen 5.0.
122
122
123
123
### Storyboards ###
124
124
125
-
-`extraImports`: replaced by `modules` (https://github.com/AliSoftware/SwiftGen/pull/243)
125
+
-`extraImports`: replaced by `modules` (https://github.com/SwiftGen/SwiftGen/pull/243)
126
126
-`sceneEnumName`: has been replaced by `param. sceneEnumName`, should provide default value.
127
127
-`segueEnumName`: has been replaced by `param. segueEnumName `, should provide default value.template using Stencil.
0 commit comments