Publish v1.0
Some checks failed
gitea-openium/resgen.swift/pipeline/head There was a failure building this commit
Some checks failed
gitea-openium/resgen.swift/pipeline/head There was a failure building this commit
Reviewed-on: #1
This commit is contained in:
183
README.md
183
README.md
@ -4,18 +4,19 @@ ResgenSwift is a package, fully written in Swift, to help you automatize ressour
|
||||
|
||||
> 🧐 For all commands, see samples files in `SampleFiles`
|
||||
|
||||
# Fonts
|
||||
## Fonts
|
||||
|
||||
Font generator generates an extension of `UIFont` (or a custom class). It also prints `UIAppFonts` to put in your project `.plist`.
|
||||
iOS required to use the **real name** of the font, this name can be different from its filename. To get the **real name**, it uses `fc-scan`.
|
||||
|
||||
**Example**
|
||||
|
||||
```
|
||||
swift run -c release FontTool $FORCE_FLAG "./Fonts/fonts.txt" \
|
||||
```sh
|
||||
swift run -c release ResgenSwift fonts $FORCE_FLAG "./Fonts/fonts.txt" \
|
||||
--extension-output-path "./Fonts/Generated" \
|
||||
--extension-name "AppFont" \
|
||||
--extension-suffix "GreatApp"
|
||||
--extension-suffix "GreatApp" \
|
||||
--static-members true
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
@ -25,21 +26,21 @@ swift run -c release FontTool $FORCE_FLAG "./Fonts/fonts.txt" \
|
||||
3. `--extension-output-path`: path where to generate generated extension
|
||||
4. `--extension-name` *(optional)* : name of thee class to add the extension
|
||||
5. `--extension-suffix` *(optional)* : additional text which is added to the filename (ex: `AppFont+GreatApp.swift`)
|
||||
|
||||
> ⚠️ If extension name is not set or is `UIFont`, it will generate static property on `UIFont` instead of method in your custom class.
|
||||
6. `--static-members` *(optional)*: generate static properties or not
|
||||
|
||||
|
||||
# Colors
|
||||
## Colors
|
||||
|
||||
Colors generator generates an extension of `UIColor` (or a custom class) along with colorsets in specified xcassets.
|
||||
|
||||
```
|
||||
swift run -c release ColorTool $FORCE_FLAG "./Colors/colors.txt" \
|
||||
```sh
|
||||
swift run -c release ResgenSwift colors $FORCE_FLAG "./Colors/colors.txt" \
|
||||
--style all \
|
||||
--xcassets-path "./Colors/colors.xcassets" \
|
||||
--extension-output-path "./Colors/Generated/" \
|
||||
--extension-name "AppColor" \
|
||||
--extension-suffix "GreatApp"
|
||||
--extension-suffix "GreatApp" \
|
||||
--static-members true
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
@ -50,23 +51,22 @@ swift run -c release ColorTool $FORCE_FLAG "./Colors/colors.txt" \
|
||||
4. `--extension-output-path`: path where to generate generated extension
|
||||
5. `--extension-name` *(optional)* : name of class to add the extension
|
||||
6. `--extension-suffix` *(optional)* : additional text which is added to filename (ex: `AppColor+GreatApp.swift`)
|
||||
7. `--static-members` *(optional)*: generate static properties or not
|
||||
|
||||
> ⚠️ If extension name is not set or is `UIColor`, it will generate static property on `UIColor`.
|
||||
|
||||
|
||||
# Strings
|
||||
## Strings
|
||||
|
||||
Strings command allows to generate `strings` files along with extensions to access those strings easily. It can do it 2 ways: Twine and Stringium. It is not recommended to use Twine except on legacy projects or while migrating to ResgenSwift, because it use https://github.com/openium/twine. Using Stringium is recommended because it does not required external dependency and allow more customisation.
|
||||
|
||||
## Twine (not recommended)
|
||||
### Twine (not recommended)
|
||||
|
||||
```
|
||||
swift run -c release Strings twine $FORCE_FLAG "./Twine/strings.txt" \
|
||||
```sh
|
||||
swift run -c release ResgenSwift strings twine $FORCE_FLAG "./Twine/strings.txt" \
|
||||
--output-path "./Twine/Generated" \
|
||||
--langs "fr en en-us" \
|
||||
--default-lang "en" \
|
||||
--extension-output-path "./Twine/Generated"
|
||||
```
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
|
||||
@ -76,16 +76,17 @@ swift run -c release Strings twine $FORCE_FLAG "./Twine/strings.txt" \
|
||||
4. `--default-lang`: default lang that will be in `Base.lproj`. It must be in `langs` as well
|
||||
4. `--extension-output-path`: path where to generate generated extension
|
||||
|
||||
## Stringium (recommended)
|
||||
### Stringium (recommended)
|
||||
|
||||
```
|
||||
swift run -c release Strings stringium $FORCE_FLAG "./Strings/strings.txt" \
|
||||
```sh
|
||||
swift run -c release ResgenSwift strings stringium $FORCE_FLAG "./Strings/strings.txt" \
|
||||
--output-path "./Strings/Generated" \
|
||||
--langs "fr en en-us" \
|
||||
--default-lang "en" \
|
||||
--extension-output-path "./Strings/Generated" \
|
||||
--extension-name "AppString" \
|
||||
--extension-suffix "GreatApp"
|
||||
--extension-suffix "GreatApp" \
|
||||
--static-members true
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
@ -97,19 +98,20 @@ swift run -c release Strings stringium $FORCE_FLAG "./Strings/strings.txt" \
|
||||
4. `--extension-output-path`: path where to generate generated extension
|
||||
5. `--extension-name` *(optional)* : name of class to add the extension
|
||||
6. `--extension-suffix` *(optional)* : additional text which is added to filename (ex: `AppString+GreatApp.swift`)
|
||||
7. `--static-members` *(optional)*: generate static properties or not
|
||||
|
||||
> ⚠️ If extension name is not set or is `String`, it will generate static property on `String`.
|
||||
|
||||
# Tags
|
||||
## Tags
|
||||
|
||||
Tags is also a subcommand of `Strings`. Input files are formatted the same way. Tags will generate properties which return exactly what is specified in the input file. It was designed to be used for analytics purpose and to be shared with any other platform to have the same analytics keys.
|
||||
|
||||
```
|
||||
swift run -c release Strings tags $FORCE_FLAG "./Tags/tags.txt" \
|
||||
```sh
|
||||
swift run -c release ResgenSwift strings tags $FORCE_FLAG "./Tags/tags.txt" \
|
||||
--lang "ium" \
|
||||
--extension-output-path "./Tags/Generated" \
|
||||
--extension-name "AppTags" \
|
||||
--extension-suffix "GreatApp"
|
||||
--extension-suffix "GreatApp" \
|
||||
--static-members true
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
@ -120,19 +122,21 @@ swift run -c release Strings tags $FORCE_FLAG "./Tags/tags.txt" \
|
||||
4. `--extension-output-path`: path where to generate generated extension
|
||||
5. `--extension-name` *(optional)* : name of class to add the extension
|
||||
6. `--extension-suffix` *(optional)* : additional text which is added to filename (ex: `AppTags+GreatApp.swift`)
|
||||
7. `--static-members` *(optional)*: generate static properties or not
|
||||
|
||||
> ⚠️ If extension name is not set or is `Tags`, it will generate static property on `Tags`. This class may not exists in your project, just create an empty class named `Tags` is necessary.
|
||||
> ⚠️ If extension name is not set or is `Tags`, it will generate the following typaloas `typealias Tags = String`.
|
||||
|
||||
# Images
|
||||
## Images
|
||||
|
||||
Images generator will generate images assets along with extensions to access those images easily.
|
||||
|
||||
```
|
||||
swift run -c release Imagium $FORCE_FLAG "./Images/images.txt" \
|
||||
```sh
|
||||
swift run -c release ResgenSwift images $FORCE_FLAG "./Images/images.txt" \
|
||||
--xcassets-path "./Images/app.xcassets" \
|
||||
--extension-output-path "./Images/Generated" \
|
||||
--extension-name "AppImage" \
|
||||
--extension-suffix "GreatApp"
|
||||
--extension-suffix "GreatApp" \
|
||||
--static-members true
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
@ -143,9 +147,120 @@ swift run -c release Imagium $FORCE_FLAG "./Images/images.txt" \
|
||||
4. `--extension-output-path`: path where to generate generated extension
|
||||
5. `--extension-name` *(optional)* : name of class to add the extension
|
||||
6. `--extension-suffix` *(optional)* : additional text which is added to filename (ex: `AppImage+GreatApp.swift`)
|
||||
7. `--static-members` *(optional)*: generate static properties or not
|
||||
|
||||
> ⚠️ If extension name is not set or is `UIImage`, it will generate static property on `UIImage`.
|
||||
|
||||
# TODO
|
||||
## All at once
|
||||
|
||||
[ ] Allow static variable generation on custom extension
|
||||
Another command exists to generate all ressources at the same time: `generate`. It use the following commands: `Fonts`, `Colors`, `Strings/Stringium`, `Strings/Tags`, `Images`.
|
||||
|
||||
All parameters can be specified in a configuration file in `Yaml`:
|
||||
|
||||
> Order of configuration types does not matter. Order them to fit your needs.
|
||||
|
||||
```yaml
|
||||
---
|
||||
colors:
|
||||
-
|
||||
inputFile: String
|
||||
style: [light/all]
|
||||
xcassetsPath: String
|
||||
extensionOutputPath: String
|
||||
extensionName: String?
|
||||
extensionSuffix: String?
|
||||
staticMembers: Bool?
|
||||
|
||||
fonts:
|
||||
-
|
||||
inputFile: String
|
||||
extensionOutputPath: String
|
||||
extensionName: String?
|
||||
extensionSuffix: String?
|
||||
staticMembers: Bool?
|
||||
|
||||
images:
|
||||
-
|
||||
inputFile: String
|
||||
xcassetsPath: String
|
||||
extensionOutputPath: String
|
||||
extensionName: String?
|
||||
extensionSuffix: String?
|
||||
staticMembers: Bool?
|
||||
|
||||
strings:
|
||||
-
|
||||
inputFile: String
|
||||
outputPath: String
|
||||
langs: String
|
||||
defaultLang: String
|
||||
extensionOutputPath: String
|
||||
extensionName: String?
|
||||
extensionSuffix: String?
|
||||
staticMembers: Bool?
|
||||
|
||||
tags:
|
||||
-
|
||||
inputFile: String
|
||||
lang: String
|
||||
extensionOutputPath: String
|
||||
extensionName: String?
|
||||
extensionSuffix: String?
|
||||
staticMembers: Bool?
|
||||
```
|
||||
|
||||
### Multiple configurations
|
||||
|
||||
In some case, you may need to have 2 colors files in your projects. You will need 2 colors configurations. Every configuration type is an array and can contains as many configurations as you need.
|
||||
|
||||
Sample for 2 colors configurations:
|
||||
|
||||
```yaml
|
||||
...
|
||||
colors:
|
||||
-
|
||||
inputFile: String
|
||||
style: [light/all]
|
||||
xcassetsPath: String
|
||||
extensionOutputPath: String
|
||||
extensionName: String?
|
||||
extensionSuffix: String?
|
||||
staticMembers: Bool?
|
||||
-
|
||||
inputFile: String
|
||||
style: [light/all]
|
||||
xcassetsPath: String
|
||||
extensionOutputPath: String
|
||||
extensionName: String?
|
||||
extensionSuffix: String?
|
||||
staticMembers: Bool?
|
||||
...
|
||||
```
|
||||
|
||||
### No configuration
|
||||
|
||||
In some case, you may not need to generate tags for example. You must specified `tags` as an empty array :
|
||||
|
||||
```yaml
|
||||
...
|
||||
tags: []
|
||||
...
|
||||
```
|
||||
|
||||
### Usage
|
||||
|
||||
```sh
|
||||
swift run -c release ResgenSwift generate path/to/configuration.yml --project-directory ${PROJECT_DIR}
|
||||
```
|
||||
|
||||
> ⚠️ Every path in `configuration.yml` will be prepended by content of `--project-directory` if they are relative path (not starting with `/`)
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
Simple run `./install.sh`. Binary will be install in `/usr/local/bin`. Then, use ResgenSwift like any other command:
|
||||
|
||||
Example:
|
||||
|
||||
```sh
|
||||
ResgenSwift generate path/to/configuration.yml --project-directory ${PROJECT_DIR}
|
||||
```
|
||||
Reference in New Issue
Block a user