https://github.com/wwilsman/zsh-clean-project

ZSH plugin to remove files from projects (automatically by default)
https://github.com/wwilsman/zsh-clean-project

Last synced: about 2 months ago
JSON representation

ZSH plugin to remove files from projects (automatically by default)

• Host: GitHub
• URL: https://github.com/wwilsman/zsh-clean-project
• Owner: wwilsman
• Created: 2017-06-02T20:05:33.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2018-02-01T16:45:51.000Z (over 6 years ago)
• Last Synced: 2024-01-24T16:48:13.349Z (4 months ago)
• Language: Shell
• Size: 1.95 KB
• Stars: 10
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Lists

• awesome-zsh-plugins - clean-project - Remove files from projects (automatically by default). Useful for keeping `.DS_Store` and `Thumbs.db` files from cluttering your directories. (Plugins / ZSH on Windows)
• fucking-awesome-zsh-plugins - clean-project - Remove files from projects (automatically by default). Useful for keeping `.DS_Store` and `Thumbs.db` files from cluttering your directories. (Plugins / ZSH on Windows)
• fucking-awesome-zsh-plugins - clean-project - Remove files from projects (automatically by default). Useful for keeping `.DS_Store` and `Thumbs.db` files from cluttering your directories. (Plugins / ZSH on Windows)
• awesome-zsh-plugins - clean-project - Remove files from projects (automatically by default). Useful for keeping `.DS_Store` and `Thumbs.db` files from cluttering your directories. (Plugins / ZSH on Windows)
• awesome-zsh-plugins - clean-project - Remove files from projects (automatically by default). Useful for keeping `.DS_Store` and `Thumbs.db` files from cluttering your directories. (Plugins / Zinit (née zplugin))

README

        
# ZSH Clean Project

Removes files from projects optionally ignoring paths. A project is

determined by the presence of a git repo. `clean_project` does nothing

when not inside of a project.

## Installation with Antigen

```bash

antigen bundle wwilsman/zsh-clean-project

```

## Usage

```bash

clean_project -h

```

### Environment Variables

These should be set before first loading the plugin as `chpwd` is

triggered immediately and can clean files in your current project.

```bash

# Automatically clean the project after chpwd

AUTO_CLEAN_PROJECT=true

# Default file name patterns to clean

AUTO_CLEAN_PROJECT_FILE_PATTERNS=(

  ".DS_Store"

  "Thumbs.db"

)

# Default path patterns to ignore (project root relative)

AUTO_CLEAN_PROJECT_IGNORE_PATHS=(

  "./node_modules/*"

  "./bower_components/*"

)

# Output a message after auto cleaning

AUTO_CLEAN_PROJECT_SILENT=false

# The message output after auto cleaning

AUTO_CLEAN_PROJECT_SILENT="Automatically removed the following files:"

```