https://github.com/brunogama/ios-pre-commit-hooks
pre-commit-hooks tailored for ios development. All linting and code fornatting follows Apple's Open Source projects code styling,
https://github.com/brunogama/ios-pre-commit-hooks
ios pre-commit pre-commit-hooks swift
Last synced: 9 months ago
JSON representation
pre-commit-hooks tailored for ios development. All linting and code fornatting follows Apple's Open Source projects code styling,
- Host: GitHub
- URL: https://github.com/brunogama/ios-pre-commit-hooks
- Owner: brunogama
- License: mit
- Created: 2024-12-31T21:06:36.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-10T03:19:57.000Z (11 months ago)
- Last Synced: 2025-06-06T21:15:01.180Z (10 months ago)
- Topics: ios, pre-commit, pre-commit-hooks, swift
- Language: Shell
- Homepage:
- Size: 175 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pre-Commit Configurations for iOS Development
**Why**? Developers function is to code and shouldn't care about formatting. So why not apply styling and linting in a pre-commit-hook?
This repository provides pre-commit hooks designed specifically for iOS development. These hooks help automate code quality checks and enforce coding standards, ensuring a smoother development experience.
## Features
- Automates code quality checks.
- Ensures adherence to coding standards.
- Identifies and resolves common issues before committing changes.
- The formatting and linting where based on Apple's open source projects
## Requirements
To use this project, you need to have the [pre-commit framework](https://pre-commit.com/) installed. Below are instructions for installing it using either [Homebrew](https://brew.sh/) or [Pyenv](https://github.com/pyenv/pyenv).
### Installing `pre-commit`
#### Using Homebrew
1. Open your terminal.
1. Run the following command to install `pre-commit`:
```bash
brew install pre-commit
```
1. Confirm the installation:
```bash
pre-commit --version
```
#### Using Pyenv
1. Make sure you have Python installed via Pyenv. If not, follow the [Pyenv installation guide](https://github.com/pyenv/pyenv#installation).
1. Install a Python version using Pyenv:
```bash
pyenv install # Replace with the desired Python version, e.g., 3.9.9
pyenv global # Set the installed version as the global default
```
1. Ensure `pip` is available:
```bash
pyenv exec python -m ensurepip --upgrade
```
1. Use `pip` to install `pre-commit`:
```bash
pip install pre-commit
```
1. Confirm the installation:
```bash
pre-commit --version
```
## Installation
Once the `pre-commit` framework is installed, set up the hooks by following these steps:
1. Open your terminal.
1. Run the following command:
```bash
curl -sSL https://raw.githubusercontent.com/brunogama/ios-pre-commit-hooks/main/install | bash
```
1. This command will:
- Download the necessary files.
- Execute the `install-hooks` script to set up your pre-commit environment.
## Contributing
Contributions are welcome! If you encounter issues or have suggestions for improvement, feel free to open an issue or submit a pull request.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
______________________________________________________________________
Let me know if you'd like further refinements!