https://github.com/artem-y/hexcode
A tool that finds Xcode color assets by hex code
https://github.com/artem-y/hexcode
cli color-assets hex ios macos rgb swift-package-manager tvos visionos watchos xcode xcodeproj xcworkspace
Last synced: 4 months ago
JSON representation
A tool that finds Xcode color assets by hex code
- Host: GitHub
- URL: https://github.com/artem-y/hexcode
- Owner: artem-y
- License: mit
- Created: 2023-06-16T22:13:43.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-14T23:49:50.000Z (6 months ago)
- Last Synced: 2025-01-15T00:33:53.206Z (6 months ago)
- Topics: cli, color-assets, hex, ios, macos, rgb, swift-package-manager, tvos, visionos, watchos, xcode, xcodeproj, xcworkspace
- Language: Swift
- Homepage:
- Size: 2.45 MB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
A tool that finds Xcode color assets by their hex codes. The idea behind this tool is to speed up and ease the process of finding assets that were already added to the project. This helps prevent accidental duplication when there are too many color assets to go through and they are easy to miss because they have different component representations.
### ⚠️Disclaimer:
For now, the tool only supports searching for exact values of color components as ints, floats or hexadecimals, without conversion between settings like content type (sRGB, Display P3, Gray Gamma 2.2 etc.), and ignoring some other settings like Gamut etc.
## Usage
By default, the tool can be used from the terminal to search for matches to a given color code:
```
hexcode #ffa500
```
...where `#ffa500` is a hex color code, with or without `#`, case-insensitive.
When used this way, `hexcode` will recursively search for the color assets matching the hex rgb value, starting from the current directory. The output will be one or more matching color set names, or a message in case it haven't found an asset with the given color. Color names include path to their color asset, relative to the project. The command also has some very simple error handling and might exit with error.
More arguments and options will be added in the future with new features, they can be found using the `--help` flag.
#### Default usage examples
Color found:
Color not found:
### Find Duplicates
Hexcode can also check a project or a directory for duplicated color assets.
```zsh
hexcode find-duplicates
```
Output example when there are duplicates:
```
#24658F MyProject/Assets.xcassets/AccentColor
#24658F MyProject/Colors.xcassets/defaultAccent
--
#999999 MyProject/Assets.xcassets/appColor/gray
#999999 MyProject/Colors.xcassets/neutralGray
```
Output when duplicates not found:
```
No duplicates found
```
## Installation
1. Clone the repository to your machine
2. Assuming the folder name "hexcode" has not changed, run in terminal:
```
cd hexcode
```
### Using Swift Package Manager:
Then run the following:
```
swift build -c release
mv .build/release/hexcode /usr/local/bin
```
(you might need `sudo` before the `mv` command, depending on your machine's configuration)
3. Run `which hexcode` to make sure it is now visible
Alternatively, it can be moved to some directory other than `/usr/local/bin`, just make sure that directory is included in `$PATH` if you want it visible from anywhere in terminal.
Or you can just run it as an executable Swift package [without installation](#running-without-installation), using Swift Package Manager commands.
### Using make:
From the root of the repository, run the following command:
```
make install
```
With no installation path provided, it will try to install `hexcode` to where it's already installed. If this is the first-time installation, the default path is `/usr/local/bin`.
There's also an option to provide a custom installation path:
```
make install
```
Just make sure it's added to the PATH or sourced if you want the command to be visible from anywhere without typing the full path to it. Depending on the installation path and current user, `make install` command might need `sudo` access.
### Running without installation:
From the `hexcode` directory (or passing it as `--package-path`), the command can be run as executable package without previous installation, for example:
```
swift run hexcode e8de2a --directory=$HOME/Documents/myProject
```
## Testing
- "If it is not tested, I will send it back."
- "If tests don't pass, I will send it back."
Tests should work both from Xcode (Cmd+U after opening `Package.swift`) and Terminal:
```
swift test
```
Core logic must be covered with tests that help decrease regression when developing new features, and also help understand how the app works.