short - Manage short directory symlinks
This document describes version 0.14 of short (from Perl distribution App-short), released on 2017-07-10.
Assuming you put your projects/repositories under ~/repos, e.g.:
~/repos
perl-Text-ANSITable/ cpan-Perinci-Sub-Exporter/ p5-Data-Format-Pretty/ p5-Data-Format-Pretty-HTML/ p5-Data-Format-Pretty-JSON/ some-other-project/ yet-another-project/
and you want to maintain a list of short symlink names in ~/proj, e.g.:
~/proj
ansitable -> ../repos/perl-Text-ANSITable perisexp -> ../repos/cpan-Perinci-Sub-Exporter dfp -> ../repos/p5-Data-Format-Pretty dfph -> ../repos/p5-Data-Format-Pretty-HTML dfpj -> ../repos/p5-Data-Format-Pretty-JSON
First, create ~/.config/short.conf:
~/.config/short.conf
long_dir = ~/repos short_dir = ~/proj ; only include dirs in long_dir matching these regexes long_include = ["^perl-", "^p5-", "^cpan-"]
Then you can:
# list all short names % short ls % short ls -l; # more detail # list all long names % short long % short long -l # list long names which do not have short symlinks yet % short missing % short missing -l # add short name % short add p5-Data-Format-Pretty-Console dfpc # return long directory (return undef when short name is unknown) % short get dfpc /home/ujang/repos/p5-Data-Format-Pretty-Console % cd `short get dfpc`
Pro-tip: install this bash function to be able to cd quickly to a short directory (tab completion is also provided):
# function definition cds () { if [[ "$1" = "" ]]; then echo "Please specify a short name"; return; fi local dir=`short get "$1"` if [[ "$dir" = "" ]]; then echo "Failed"; else cd "$dir"; fi } # tab completion _cds () { local cur=${COMP_WORDS[COMP_CWORD]} COMPREPLY=( `COMP_LINE="short get $cur" COMP_POINT=$[10+${#cur}] short` ) } # activate tab completion complete -F _cds cds
Afterwards, you can:
% cds ans<tab> % cds ansitable
NOTE: EARLY IMPLEMENTATION, MORE SUBCOMMANDS AND OPTIONS WILL BE ADDED IN THE FUTURE.
Perl project directories (typically CPAN distributions, Git repositories) usually have rather long names, e.g.:
perl-Text-ANSITable cpan-Perinci-Sub-Exporter p5-Data-Format-Pretty p5-Data-Format-Pretty-HTML p5-Data-Format-Pretty-JSON
In some places short single-word aliases are useful, e.g.:
ansitable perisexp dfp dfph dfpj
Where is this useful? First, when typing or cd-ing the directory names (even though there is shell tab completion, we still often have to type the names):
% cd proj/dfph; # shorter than: cd repos/p5-Data-Format-Pretty-HTML
Second is when referring in internal documents. Writing and reading the short names like dfpj is much more convenient and faster (as long as they are already familiar) than having to explicitly write Data::Format::Pretty::JSON every time. Especially if you, like me, have hundreds of projects and have to cross-reference one another when writing documentation, for example when writing todo lists:
dfpj
Data::Format::Pretty::JSON
* TODO dfp: Add support for more environment variables * TODO perisexp: Support Sub::Exporter-style interface * TODO ansitable: Optimize performance
The short names are implemented as just symlinks to the real names. And this script is just a simple CLI tool to help you manage them. I've used symlinks since at least 2002-2003, and have only started writing this tool in March 2015.
* marks required options.
*
Set path to configuration file.
Can be specified multiple times.
Set configuration profile to use.
Choose output format, e.g. json, text.
Default value:
undef
Display help message and exit.
Set output format to json.
When outputing as JSON, strip result envelope.
0
By default, when outputing as JSON, the full enveloped result is returned, e.g.:
[200,"OK",[1,2,3],{"func.extra"=>4}]
The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use `--naked-res` so you just get:
[1,2,3]
Do not use any configuration file.
Do not read environment for default options.
List available subcommands.
Display program's version and exit.
See --long-include.
--long-include
See --short.
--short
This script has shell tab completion capability with support for several shells.
To activate bash completion for this script, put:
complete -C short short
in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.
It is recommended, however, that you install modules using cpanm-shcompgen which can activate shell completion for scripts immediately.
To activate tcsh completion for this script, put:
complete short 'p/*/`short`/'
in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.
It is also recommended to install shcompgen (see above).
For fish and zsh, install shcompgen as described above.
This script can read configuration files. Configuration files are in the format of IOD, which is basically INI with some extra features.
By default, these names are searched for configuration filenames (can be changed using --config-path): ~/.config/short.conf, ~/short.conf, or /etc/short.conf.
--config-path
All found files will be read and merged.
To disable searching for configuration files, pass --no-config.
--no-config
To put configuration for a certain subcommand only, use a section name like [subcommand=NAME] or [SOMESECTION subcommand=NAME].
[subcommand=NAME]
[SOMESECTION subcommand=NAME]
You can put multiple profiles in a single file by using section names like [profile=SOMENAME] or [SOMESECTION profile=SOMENAME] or [subcommand=SUBCOMMAND_NAME profile=SOMENAME] or [SOMESECTION subcommand=SUBCOMMAND_NAME profile=SOMENAME]. Those sections will only be read if you specify the matching --config-profile SOMENAME.
[profile=SOMENAME]
[SOMESECTION profile=SOMENAME]
[subcommand=SUBCOMMAND_NAME profile=SOMENAME]
[SOMESECTION subcommand=SUBCOMMAND_NAME profile=SOMENAME]
--config-profile SOMENAME
You can also put configuration for multiple programs inside a single file, and use filter program=NAME in section names, e.g. [program=NAME ...] or [SOMESECTION program=NAME]. The section will then only be used when the reading program matches.
program=NAME
[program=NAME ...]
[SOMESECTION program=NAME]
Finally, you can filter a section by environment variable using the filter env=CONDITION in section names. For example if you only want a section to be read if a certain environment variable is true: [env=SOMEVAR ...] or [SOMESECTION env=SOMEVAR ...]. If you only want a section to be read when the value of an environment variable has value equals something: [env=HOSTNAME=blink ...] or [SOMESECTION env=HOSTNAME=blink ...]. If you only want a section to be read when the value of an environment variable does not equal something: [env=HOSTNAME!=blink ...] or [SOMESECTION env=HOSTNAME!=blink ...]. If you only want a section to be read when an environment variable contains something: [env=HOSTNAME*=server ...] or [SOMESECTION env=HOSTNAME*=server ...]. Note that currently due to simplistic parsing, there must not be any whitespace in the value being compared because it marks the beginning of a new section filter or section name.
env=CONDITION
[env=SOMEVAR ...]
[SOMESECTION env=SOMEVAR ...]
[env=HOSTNAME=blink ...]
[SOMESECTION env=HOSTNAME=blink ...]
[env=HOSTNAME!=blink ...]
[SOMESECTION env=HOSTNAME!=blink ...]
[env=HOSTNAME*=server ...]
[SOMESECTION env=HOSTNAME*=server ...]
List of available configuration parameters:
format (see --format) naked_res (see --naked-res)
long (see --long) long_dir (see --long-dir) long_include (see --long-include) short (see --short) short_dir (see --short-dir)
detail (see --detail) long_dir (see --long-dir) long_include (see --long-include) short_dir (see --short-dir)
long_dir (see --long-dir) long_include (see --long-include) short (see --short) short_dir (see --short-dir)
broken (see --broken) detail (see --detail) long_dir (see --long-dir) long_include (see --long-include) query (see --query) short_dir (see --short-dir)
Specify additional command-line options.
~/short.conf
/etc/short.conf
Please visit the project's homepage at https://metacpan.org/release/App-short.
Source repository is at https://github.com/perlancar/perl-App-short.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-short
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
perlancar <perlancar@cpan.org>
This software is copyright (c) 2017, 2015 by perlancar@cpan.org.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install App::short, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::short
CPAN shell
perl -MCPAN -e shell install App::short
For more information on module installation, please visit the detailed CPAN module installation guide.