Skip to content

Commit 8f26328

Browse files
committed
Release v1.3.1: Complete renaming from sf-symbols to sf-symbols-generator and build optimizations
1 parent f5b93a7 commit 8f26328

File tree

13 files changed

+43
-40
lines changed

13 files changed

+43
-40
lines changed

Package.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ let package = Package(
1010
],
1111
targets: [
1212
.executableTarget(
13-
name: "sf-symbols",
13+
name: "sf-symbols-generator",
1414
dependencies: [
1515
.product(name: "ArgumentParser", package: "swift-argument-parser")
1616
],

README.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
- [English](README.md) | [繁體中文](README_zh-TW.md)
66

77
[![Swift Version](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fleoho0722%2FSFSymbolsGenerator%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/leoho0722/SFSymbolsGenerator)
8-
[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fleoho0722%2FSFSymbolsGenerator%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/leoho0722/SFSymbolsGenerator)
8+
[![Supported Platforms](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fleoho0722%2FSFSymbolsGenerator%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/leoho0722/SFSymbolsGenerator)
99
![GitHub release (with filter)](https://img.shields.io/github/v/release/leoho0722/SFSymbolsGenerator?sort=semver&label=Release)
1010

1111
**Simplifying SF Symbols Enumeration Generation with Swift!**
@@ -57,44 +57,51 @@ Sources/
5757

5858
## 📦 Installation
5959

60+
### Homebrew Installation (Recommended)
61+
62+
```bash
63+
brew tap leoho0722/tap
64+
brew install sf-symbols-generator
65+
```
66+
6067
### From Releases
6168

6269
1. Download the latest binary from [GitHub Releases](https://github.com/leoho0722/SFSymbolsGenerator/releases)
6370
2. Extract and place the binary in your desired location
64-
3. Make it executable: `chmod +x sf-symbols`
71+
3. Make it executable: `chmod +x sf-symbols-generator`
6572

6673
### Build from Source
6774

6875
```bash
6976
git clone https://github.com/leoho0722/SFSymbolsGenerator.git
7077
cd SFSymbolsGenerator
7178
swift build -c release
72-
# Binary will be at .build/release/sf-symbols
79+
# Binary will be at .build/release/sf-symbols-generator
7380
```
7481

7582
## 🚀 Usage
7683

7784
### Command Structure
7885

7986
```bash
80-
sf-symbols generate <filepath> [--name <name>] [--enum-name <enum-name>] [--use-beta]
81-
sf-symbols version
87+
sf-symbols-generator generate <filepath> [--name <name>] [--enum-name <enum-name>] [--use-beta]
88+
sf-symbols-generator version
8289
```
8390

8491
### Generate Command
8592

8693
```bash
8794
# Basic usage
88-
sf-symbols generate /path/to/output
95+
sf-symbols-generator generate /path/to/output
8996

9097
# With custom filename
91-
sf-symbols generate /path/to/output --name CustomSymbols
98+
sf-symbols-generator generate /path/to/output --name CustomSymbols
9299

93100
# Using beta version
94-
sf-symbols generate /path/to/output --use-beta
101+
sf-symbols-generator generate /path/to/output --use-beta
95102

96103
# Complete example
97-
sf-symbols generate ~/Desktop --name MySymbols --use-beta
104+
sf-symbols-generator generate ~/Desktop --name MySymbols --use-beta
98105
```
99106

100107
### Command Options

README_zh-TW.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
- [English](README.md) | [繁體中文](README_zh-TW.md)
66

77
[![Swift 版本](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fleoho0722%2FSFSymbolsGenerator%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/leoho0722/SFSymbolsGenerator)
8-
[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fleoho0722%2FSFSymbolsGenerator%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/leoho0722/SFSymbolsGenerator)
8+
[![支援平台](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fleoho0722%2FSFSymbolsGenerator%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/leoho0722/SFSymbolsGenerator)
99
![GitHub release (with filter)](https://img.shields.io/github/v/release/leoho0722/SFSymbolsGenerator?sort=semver&label=Release)
1010

1111
**使用 Swift 簡化 SF Symbols 列舉產生!**
@@ -57,44 +57,51 @@ Sources/
5757

5858
## 📦 安裝方式
5959

60+
### Homebrew 安裝(推薦)
61+
62+
```bash
63+
brew tap leoho0722/tap
64+
brew install sf-symbols-generator
65+
```
66+
6067
### 從發布版本安裝
6168

6269
1.[GitHub Releases](https://github.com/leoho0722/SFSymbolsGenerator/releases) 下載最新的二進位檔案
6370
2. 解壓縮並將二進位檔案放置到您希望的位置
64-
3. 設為可執行:`chmod +x sf-symbols`
71+
3. 設為可執行:`chmod +x sf-symbols-generator`
6572

6673
### 從原始碼建置
6774

6875
```bash
6976
git clone https://github.com/leoho0722/SFSymbolsGenerator.git
7077
cd SFSymbolsGenerator
7178
swift build -c release
72-
# 二進位檔案將位於 .build/release/sf-symbols
79+
# 二進位檔案將位於 .build/release/sf-symbols-generator
7380
```
7481

7582
## 🚀 使用方法
7683

7784
### 命令結構
7885

7986
```bash
80-
sf-symbols generate <filepath> [--name <n>] [--enum-name <enum-name>] [--use-beta]
81-
sf-symbols version
87+
sf-symbols-generator generate <filepath> [--name <n>] [--enum-name <enum-name>] [--use-beta]
88+
sf-symbols-generator version
8289
```
8390

8491
### 產生命令
8592

8693
```bash
8794
# 基本用法
88-
sf-symbols generate /path/to/output
95+
sf-symbols-generator generate /path/to/output
8996

9097
# 自訂檔案名稱
91-
sf-symbols generate /path/to/output --name CustomSymbols
98+
sf-symbols-generator generate /path/to/output --name CustomSymbols
9299

93100
# 使用測試版本
94-
sf-symbols generate /path/to/output --use-beta
101+
sf-symbols-generator generate /path/to/output --use-beta
95102

96103
# 完整範例
97-
sf-symbols generate ~/Desktop --name MySymbols --use-beta
104+
sf-symbols-generator generate ~/Desktop --name MySymbols --use-beta
98105
```
99106

100107
### 命令選項

Sources/Application/Commands/Generate.swift

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ extension SFSymbolsGenerator {
2828
/// ## Usage
2929
///
3030
/// ```bash
31-
/// sf-symbols generate /path/to/output [--name CustomName] [--enum-name CustomEnum] [--use-beta]
31+
/// sf-symbols-generator generate /path/to/output [--name CustomName] [--enum-name CustomEnum] [--use-beta]
3232
/// ```
3333
///
3434
/// ## Generated Code Structure
@@ -39,8 +39,6 @@ extension SFSymbolsGenerator {
3939
/// - A custom `allCases` property that respects availability constraints
4040
/// - Proper handling of Swift keyword conflicts
4141
///
42-
/// - Author: Leo Ho
43-
/// - Since: 1.3.0
4442
struct GenerateCommand: AsyncParsableCommand {
4543

4644
/// Configuration for the generate subcommand

Sources/Application/Commands/Version.swift

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ extension SFSymbolsGenerator {
1919
/// ## Usage
2020
///
2121
/// ```bash
22-
/// sf-symbols version
22+
/// sf-symbols-generator version
2323
/// ```
2424
///
2525
/// ## Output
@@ -29,8 +29,6 @@ extension SFSymbolsGenerator {
2929
/// SFSymbolsGenerator version 1.3.0
3030
/// ```
3131
///
32-
/// - Author: Leo Ho
33-
/// - Since: 1.3.0
3432
struct VersionCommand: AsyncParsableCommand {
3533

3634
/// Configuration for the version subcommand

Sources/Domain/Models/Release+Extensions.swift

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@ import Foundation
1212
/// This extension adds computed properties and methods to make it easier to work with
1313
/// OS version release information when generating Swift availability annotations.
1414
///
15-
/// - Author: Leo Ho
16-
/// - Since: 1.0.0
1715
extension Release {
1816

1917
/// Generates a properly formatted availability string for Swift `@available` attributes.

Sources/Domain/Models/Symbol+Extensions.swift

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,6 @@ import Foundation
1313
/// names that can be used as enum case names. It handles various edge cases and naming
1414
/// conflicts that can occur when transforming symbol names.
1515
///
16-
/// - Author: Leo Ho
17-
/// - Since: 1.0.0
1816
extension Symbol {
1917

2018
/// Converts an SF Symbol name into a valid Swift enum case identifier.

Sources/Domain/Services/CodeGenerator.swift

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,12 @@ import Foundation
3535
/// if #available(iOS 13.0, macOS 10.15, *) {
3636
/// allCases.append(.arrowLeft)
3737
/// }
38+
///
3839
/// return allCases
3940
/// }
4041
/// }
4142
/// ```
4243
///
43-
/// - Author: Leo Ho
44-
/// - Since: 1.3.0
4544
struct CodeGenerator {
4645

4746
/// Generates Swift enumeration code for SF Symbols.

Sources/Domain/Services/PlistParser.swift

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@ struct PlistParser {
7272
/// print("Symbol: \(symbol.symbol), Released: \(symbol.released)")
7373
/// }
7474
/// ```
75+
///
7576
static func parse(from url: URL) async throws -> ([SymbolTuple], Releases) {
7677
do {
7778
let data = try Data(contentsOf: url)

Sources/Domain/Services/SFSymbolsFinder.swift

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ struct SFSymbolsFinder {
6161
/// // Find beta version
6262
/// let betaPlistURL = try SFSymbolsFinder.find(isBeta: true)
6363
/// ```
64+
///
6465
static func find(isBeta: Bool) throws -> URL {
6566
let fileManager = FileManager.default
6667
let appName = isBeta ? "SF Symbols beta.app" : "SF Symbols.app"

0 commit comments

Comments
 (0)