Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/luismayta/zsh-clean
functions for clean projects
https://github.com/luismayta/zsh-clean
automation clean peru plugin tools zsh
Last synced: 7 days ago
JSON representation
functions for clean projects
- Host: GitHub
- URL: https://github.com/luismayta/zsh-clean
- Owner: luismayta
- License: lgpl-3.0
- Created: 2019-09-15T01:24:20.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-09-09T23:18:31.000Z (about 2 months ago)
- Last Synced: 2024-09-10T03:38:52.645Z (about 2 months ago)
- Topics: automation, clean, peru, plugin, tools, zsh
- Language: Shell
- Homepage:
- Size: 6.35 MB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: docs/code_of_conduct.md
- Security: SECURITY.md
- Support: docs/support.md
- Roadmap: docs/roadmap.md
Awesome Lists containing this project
README
[](https://github.com/luismayta/zsh-clean/releases) [](https://github.com/luismayta/zsh-clean/actions?workflow=lint-code) [](https://github.com/pre-commit/pre-commit) [](https://conventionalcommits.org) [](https://keepachangelog.com)
# zsh-clean
zsh-clean for project
## Requirements
This is a list of plugins that need to be installed previously to enjoy all the goodies of this configuration:
- [zsh-core](https://github.com/hadenlabs/zsh-core)
- [gomplate](https://github.com/hairyhenderson/gomplate)
- [python](https://www.python.org)
- [taskfile](https://github.com/go-task/task)
## Installation
### [oh-my-zsh](https://github.com/ohmyzsh/ohmyzsh) users
If you're using [oh-my-zsh](https://github.com/ohmyzsh/ohmyzsh), install this plugin by doing the following:
1. Go to your oh-my-zsh custom plugins directory -`cd ~/.oh-my-zsh/custom/plugins`
2. Clone the plugin `bash git clone https://github.com/luismayta/zsh-clean`bash
3. Edit your `.zshrc` and add `plugins=( ... zsh-clean )` to your list of plugins
4. Open a new terminal and enjoy!
### [antigen](https://github.com/zsh-users/antigen) users
If you're using [Antigen](https://github.com/zsh-users/antigen), install this plugin by doing the following:
1. Add `antigen bundle luismayta/zsh-clean` to your `.zshrc` where you're adding your other plugins.
2. Either open a new terminal to force zsh to load the new plugin, or run `antigen bundle luismayta/zsh-clean` in a running zsh session.
3. Enjoy!
### [antibody](https://github.com/getantibody/antibody) users
If you're using [Antibody](https://github.com/getantibody/antibody), install this plugin by doing the following:
1. Add :
```{.sourceCode .bash}
antibody bundle luismayta/zsh-clean
```
to your `.zshrc` where you're adding your other plugins.
2. Either open a new terminal to force zsh to load the new plugin, or run `antibody bundle luismayta/zsh-clean` in a running zsh session.
3. Enjoy!
## Usage
# How to use this project
```bash
task setup
```
## Examples
### common
## Functions
zsh goenv includes a small utility `goenv` to fetch and install new packages.
#### `goenv::install`
Install goenv.
#### `goenv::load`
Load path goenv.
#### `goenv::upgrade`
Upgrade version goenv.
#### `goenv::package::all::install`
Install all package of goenv.
#### `goenv::install::versions`
Install versions of config for goenv.
#### `goenv::install::version::global`
Install a version global of goenv.
## Help
**Got a question?**
File a GitHub [issue](https://github.com/luismayta/zsh-clean/issues).
## Contributing
See [Contributing](./docs/contributing.md).
## Module Versioning
This Module follows the principles of [Semantic Versioning (SemVer)](https://semver.org/).
Using the given version number of `MAJOR.MINOR.PATCH`, we apply the following constructs:
1. Use the `MAJOR` version for incompatible changes.
1. Use the `MINOR` version when adding functionality in a backwards compatible manner.
1. Use the `PATCH` version when introducing backwards compatible bug fixes.
### Backwards compatibility in `0.0.z` and `0.y.z` version
- In the context of initial development, backwards compatibility in versions `0.0.z` is **not guaranteed** when `z` is increased. (Initial development)
- In the context of pre-release, backwards compatibility in versions `0.y.z` is **not guaranteed** when `y` is increased. (Pre-release)
## Copyright
Copyright © 2018-2022 [Hadenlabs](https://hadenlabs.com)
## Trademarks
All other trademarks referenced herein are the property of their respective owners.
## License
The code and styles are licensed under the LGPL-3.0 license [See project license.](LICENSE).
## Don't forget to 🌟 Star 🌟 the repo if you like zsh-clean
[Your feedback is appreciated](https://github.com/luismayta/zsh-clean/issues)