Skip to content

Commit 740e877

Browse files
committed
Review URLs and make them relative
1 parent 24354c0 commit 740e877

32 files changed

+53
-53
lines changed

CHANGELOG.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
⚠️ 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.
88

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.
1010

1111
### Bug Fixes
1212

@@ -272,7 +272,7 @@ Read the [SwiftGen 6.0 Migration Guide](https://github.com/SwiftGen/SwiftGen/blo
272272

273273
⚠️ 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.
274274

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.
276276

277277
### Changes in other SwiftGen modules
278278

@@ -298,13 +298,13 @@ Read the [SwiftGen 5.0 Migration Guide](https://github.com/SwiftGen/SwiftGen/blo
298298

299299
#### Notable breaking changes from other SwiftGen repositories
300300

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.
302302
[David Jennes](https://github.com/djbe)
303303
[SwiftGen/templates#47](https://github.com/SwiftGen/templates/issues/47)
304-
* 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.
305305
[Olivier Halligon](https://github.com/AliSoftware)
306306
[SwiftGen/templates#65](https://github.com/SwiftGen/templates/issues/65)
307-
* 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.
308308
[David Jennes](https://github.com/djbe)
309309
[SwiftGen/SwiftGenKit#5](https://github.com/SwiftGen/SwiftGenKit/issues/5)
310310
* 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
410410

411411
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).
412412

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.
414414

415415
### Internal changes
416416

@@ -626,7 +626,7 @@ Note: The next minor version will focus on bringing more documentation for all t
626626

627627
> 💡 You can now **create your custom templates more easier than ever**, by cloning an existing template!
628628
>
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):
630630
>
631631
> * use `swiftgen templates cat strings --output strings-custom.stencil`
632632
> * modify the cloned `strings-custom.stencil` template to your liking

Documentation/Creating-your-templates.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Customize SwiftGen templates
22

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).
44

55
## Templates files on disk (Search Path priority)
66

@@ -91,4 +91,4 @@ Additionally to the [tags and filters](https://stencil.fuller.li/en/latest/built
9191

9292
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.
9393

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).

Documentation/MigrationGuide.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ All the migration guides for SwiftGen are spread out over a few files, depending
77
|-----------------|-----------------|---------|
88
| SwiftGen Migration Guide (this file) | All users of SwiftGen | Changes in configuration, CLI parameters and global changes overview |
99
| [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 |
1111
| [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 |
1212

1313
# SwiftGen 6.0 Migration Guide
@@ -114,7 +114,7 @@ For more information, read the [creating your own templates](Creating-your-templ
114114

115115
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, ...
116116

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.
118118

119119

120120
# SwiftGen 5.1 Migration Guide
@@ -202,7 +202,7 @@ For example:
202202
* 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;
203203
* 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.
204204

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).
206206

207207
### Some SwiftGen-specific Stencil filters evolved
208208

@@ -216,6 +216,6 @@ Also, a few dedicated Stencil filters provided by SwiftGen (via StencilSwiftKit)
216216
<details>
217217
<summary>Migration Guide</summary>
218218

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.
220220

221221
</details>

Documentation/SwiftGenKit Contexts/MigrationGuide.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ If you're migrating from SwiftGenKit 1.x to SwiftGenKit 2.0 — which is the cas
2828

2929
## Changes for template writers
3030

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.
3232

3333
### Common changes and the new `--param` flags
3434

@@ -40,7 +40,7 @@ You can also take advantage of that new `--param` feature to make your own templ
4040

4141
### Colors
4242

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)._
4444

4545
- `enumName` has been replaced by `param.enumName`[see above](#common-changes-and-the-new---param-flags).
4646
- `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.
4949

5050
### Fonts
5151

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)._
5353

5454
- `enumName` has been replaced by `param.enumName`[see above](#common-changes-and-the-new---param-flags).
5555
- for each `font`:
5656
- `fontName` has been replaced by the `name` property.
5757

5858
### XCAssets (formerly Images)
5959

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)._
6161

6262
- `enumName` has been replaced by `param.enumName`[see above](#common-changes-and-the-new---param-flags).
6363
- `images` is deprecated. The new root key is named `catalogs` and contains the structured information.
6464

6565
### Storyboards
6666

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)._
6868

6969
- `extraImports` has been renamed `modules` (see [SwiftGen/SwftGen#243](https://github.com/SwiftGen/SwiftGen/pull/243))
7070
- `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.
7474

7575
### Strings
7676

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)._
7878

7979
- `enumName` has been replaced by `param.enumName`[see above](#common-changes-and-the-new---param-flags).
8080
- `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.
122122

123123
### Storyboards ###
124124

125-
- `extraImports`: replaced by `modules` (https://github.com/AliSoftware/SwiftGen/pull/243)
125+
- `extraImports`: replaced by `modules` (https://github.com/SwiftGen/SwiftGen/pull/243)
126126
- `sceneEnumName`: has been replaced by `param. sceneEnumName`, should provide default value.
127127
- `segueEnumName`: has been replaced by `param. segueEnumName `, should provide default value.template using Stencil.
128128
- For each `scene`:

Documentation/templates/colors/literals-swift3.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ extension ColorName {
3737
}
3838
```
3939

40-
[Full generated code](https://github.com/SwiftGen/templates/blob/master/Tests/Fixtures/Generated/Colors/literals-swift3-context-defaults.swift)
40+
[Full generated code](../../../Tests/Fixtures/Generated/Colors/literals-swift3-context-defaults.swift)
4141

4242
## Usage example
4343

Documentation/templates/colors/literals-swift4.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ extension ColorName {
3737
}
3838
```
3939

40-
[Full generated code](https://github.com/SwiftGen/templates/blob/master/Tests/Fixtures/Generated/Colors/literals-swift4-context-defaults.swift)
40+
[Full generated code](../../../Tests/Fixtures/Generated/Colors/literals-swift4-context-defaults.swift)
4141

4242
## Usage example
4343

Documentation/templates/colors/swift3.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ struct ColorName {
4040
}
4141
```
4242

43-
[Full generated code](https://github.com/SwiftGen/templates/blob/master/Tests/Fixtures/Generated/Colors/swift3-context-defaults.swift)
43+
[Full generated code](../../../Tests/Fixtures/Generated/Colors/swift3-context-defaults.swift)
4444

4545
## Usage example
4646

Documentation/templates/colors/swift4.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ struct ColorName {
4040
}
4141
```
4242

43-
[Full generated code](https://github.com/SwiftGen/templates/blob/master/Tests/Fixtures/Generated/Colors/swift4-context-defaults.swift)
43+
[Full generated code](../../../Tests/Fixtures/Generated/Colors/swift4-context-defaults.swift)
4444

4545
## Usage example
4646

Documentation/templates/fonts/swift3.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ enum FontFamily {
3939
}
4040
```
4141

42-
[Full generated code](https://github.com/SwiftGen/templates/blob/master/Tests/Fixtures/Generated/Fonts/swift3-context-defaults.swift)
42+
[Full generated code](../../../Tests/Fixtures/Generated/Fonts/swift3-context-defaults.swift)
4343

4444
## Usage example
4545

Documentation/templates/fonts/swift4.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ enum FontFamily {
3939
}
4040
```
4141

42-
[Full generated code](https://github.com/SwiftGen/templates/blob/master/Tests/Fixtures/Generated/Fonts/swift4-context-defaults.swift)
42+
[Full generated code](../../../Tests/Fixtures/Generated/Fonts/swift4-context-defaults.swift)
4343

4444
## Usage example
4545

0 commit comments

Comments
 (0)