Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rightpoint/eject
An eject button for Interface Builder to generate swift code
https://github.com/rightpoint/eject
Last synced: 7 days ago
JSON representation
An eject button for Interface Builder to generate swift code
- Host: GitHub
- URL: https://github.com/rightpoint/eject
- Owner: Rightpoint
- License: mit
- Created: 2016-10-20T02:15:24.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2021-11-30T14:53:07.000Z (almost 3 years ago)
- Last Synced: 2024-08-16T10:42:09.692Z (3 months ago)
- Language: Swift
- Homepage:
- Size: 260 KB
- Stars: 522
- Watchers: 18
- Forks: 24
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Eject
Eject is a utility to transition from Interface Builder to programatic view layout. This is done by using code generation to create a `.swift` file to replace the view hierarchy managed by the `.xib` file.
## Why?
One common pain point with Interface Builder is that as a view becomes more dynamic and is managed more programatically, Interface Builder becomes less helpful. This tool lets developers use Interface Builder without that concern, giving them an Eject button to hit when Interace Builder starts getting in the way, and provides an easy path to transition to full programatic view layout.
### But But
Yes, I understand that this is probably a bad idea. But it might not be.
### Usage
Install with [homebrew](http://brew.sh):
```shell
brew install eject
```
Use on the command line:
```shell
eject --file /path/to/MassiveViewController.xib
```
Copy and paste code into .swift file, and remove the .xib:
```shell
rm /path/to/MassiveViewController.xib
```
Or to see what changed in a xib file by looking at the changes in generated code:
```shell
TMP=`mktemp` && git show HEAD:$XIB > $TMP && diff <(eject --file $XIB ) <(eject --file $TMP)
```
`eject` will generate code for everything it can in the `.xib` file. If there is any XML that `eject` does not understand, it will print out a warning message. Open an [Issue](https://github.com/Raizlabs/Eject/issues) with any warnings, bugs or ideas you may have.
### Features
- UIKit `.xib` support
- Constraints (using [Anchorage](https://github.com/Raizlabs/Anchorage/))
- Outlet and OutletCollection support
- Good variable names
- Use the user entered "user label" if present
- Snake case of the className with the namespace removed
- Constraint variable names are long, but descriptive, (labelBottomEqualToButtonTop)
- Code that compiles out of the box is a non-goal
- Will not generate `view1`, `view2` variable names to avoid compile errors. Supply user labels and re-generate.
### Does it work?
The [Unit Tests](EjectKitTests/EjectKitTests.swift#L136###testCollectionView) show how much work is done. UIKit coverage is configured by the [CocoaTouchBuilder](EjectKit/Builder/CocoaTouchBuilder.swift) using various [Builders](EjectKit/Builder). Some configuration is [generated](EjectKitTests/InspectorPropertyConfigurationTests.swift#34) from Interface Builder `.inspector` files.
This should still be considered an Alpha quality tool.
### Todo
- Enhance code generation approaches
- AppKit support
- Storyboard support?
- Use default values to remove un-needed code
- Better error reporting of un-interpreted flags
- Explore generating code as a method of diffing `.xib` files