Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jonasbn/bash_completion_perlcritic
Basic bash completion for perlcritic
https://github.com/jonasbn/bash_completion_perlcritic
bash bash-completion hacktoberfest perl perl-critic perlcritic
Last synced: 24 days ago
JSON representation
Basic bash completion for perlcritic
- Host: GitHub
- URL: https://github.com/jonasbn/bash_completion_perlcritic
- Owner: jonasbn
- License: mit
- Created: 2017-07-03T07:46:23.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-07-04T19:37:28.000Z (over 7 years ago)
- Last Synced: 2024-12-23T23:23:57.181Z (about 1 month ago)
- Topics: bash, bash-completion, hacktoberfest, perl, perl-critic, perlcritic
- Language: Shell
- Homepage:
- Size: 4.88 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Perl::Critic Bash Completion
Basic tab completion for [perlcritic](http://perlcritic.com/).
[](https://opensource.org/licenses/MIT)
# Introduction
This is a basic completion implementation for `perlcritic` (Perl::Critic) based on version 1.126.
## Usage
```
$ perlcritic --
```
## Download
```bash
$ curl https://raw.githubusercontent.com/jonasbn/bash_completion_perlcritic/master/perlcritic > perlcritic
```
## Installation
Where your completions are located might vary.
### Personal
If you want to install them for your personal use, do the following.
Create the file: `~/.bash_completion`, containing the code below:
```bash
for bcfile in ~/.bash_completion.d/* ; do
. $bcfile
done
```
Ref: [ServerFault.com: _Standard place for user defined bash_completion.d scripts?_](https://serverfault.com/questions/506612/standard-place-for-user-defined-bash-completion-d-scripts)
Create a directiory for your completions:
```bash
$ mkdir ~/.bash_completion.d
```
Copy your completions into the newly created directory:
```bash
$ cp perlcritic ~/.bash_completion.d/
```
Start a new shell and you should be good to go.
### System-wide example from Debian
Based on [an introduction](https://debian-administration.org/article/316/An_introduction_to_bash_completion_part_1) to `bash` completions on Debian.
```bash
$ sudo cp perlcritic /etc/bash_completion.d/
```
### System-wide example from OSX
This assumes you are using **Homebrew**
Do note that paths vary based on whether you are using `bash` 3 or 4
#### `bash` 3 (Formula: `bash-completions`):
```bash
$ cp perlcritic /usr/local/etc/bash_completion.d/
```
And to activate right away:
```bash
$ source /usr/local/etc/bash_completion.d/perlcritic
```
#### `bash` 4 (Formula: `bash-completions2`)
```bash
$ cp perlcritic /usr/local/share/bash-completion/completions/
```
And to activate right away:
```bash
$ source /usr/local/share/bash-completion/completions/perlcritic
```
## Motivation
`perlcritic` is an important tool in my toolchain, so I wanted to have easy access to all the options available.
## See Also
A more elaborate piece of documentation on `bash` completions is available from **The Linux Documentation Project** in the [Advanced Bash-Scripting Guide](http://tldp.org/LDP/abs/html/tabexpansion.html).
From the [GNU Documentation](https://www.gnu.org/software/bash/manual/html_node/Programmable-Completion.html).
Good two-part article, "An Introduction to Bash Completion": [Part 1](https://debian-administration.org/article/316/An_introduction_to_bash_completion_part_1) and [Part 2](https://debian-administration.org/article/317/An_introduction_to_bash_completion_part_2).
Please note that this experimental implementation has only been tested with `bash` version 4.
The most comprehensive collection of `bash` completions I have come across is [the one](https://github.com/scop/bash-completion) from the **Debian Linux distribution**. It is also the one offered for OSX via **Homebrew**.
## License
This is made available under the MIT license, see separate license file.
## Copyright
:copyright: jonasbn 2017