Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anki-code/xontrib-onepath
Associate files and directories with app or alias and run it without preceding commands in xonsh shell.
https://github.com/anki-code/xontrib-onepath
shell xonsh xontrib
Last synced: about 2 months ago
JSON representation
Associate files and directories with app or alias and run it without preceding commands in xonsh shell.
- Host: GitHub
- URL: https://github.com/anki-code/xontrib-onepath
- Owner: anki-code
- License: bsd-2-clause
- Created: 2020-09-14T20:12:11.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-04-07T15:18:48.000Z (over 1 year ago)
- Last Synced: 2024-10-12T15:56:38.064Z (2 months ago)
- Topics: shell, xonsh, xontrib
- Language: Python
- Homepage:
- Size: 74.2 KB
- Stars: 18
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-xontribs - onepath - When you click to a file or folder in graphical OS they will be opened in associated app.The xontrib-onepath brings the same logic for the xonsh shell. Type the filename or pathwithout preceding command and an associated action will be executed. The actions are customizable. (Plugins / Prompt tweaks)
README
When you click to a file or folder in graphical OS they will be opened in associated app. The xontrib-onepath brings the same logic to the xonsh shell. Type the filename or path without preceding command and an associated action will be executed. The actions are customizable.
If you like the idea click ⭐ on the repo and tweet.
## Install
```bash
xpip install -U xontrib-onepath
echo 'xontrib load onepath' >> ~/.xonshrc
# Reload xonsh
```
## Examples
```bash
# Run: # Action that will be executed:
/ # cd /
executable_script # ./executable_script
.xonshrc # vim ~/.xonshrc
~/Downloads/logo.png # xdg-open ~/Downloads/logo.png
git # git
./git # cd ./git
```
## Default actions
If typed command is a registered name (i.e. `git`) and `which` command returns the path (i.e. `/usr/bin/git`) it will be executed.
In other case the typed path will be used to make action. Default actions:
| Priority | Type | Action |
|---|---|---|
| 1 | `` | `cd` |
| 2 | `` | `` |
| 3 | `text/` | `vim`|
| 4 | `image/` | `xdg-open` |
#### Help to add more types and best default actions. PRs are welcome!
You can add platform and tool depend actions:
```xsh
import shutil as _shutil
from xonsh.platform import ON_LINUX #, ON_DARWIN, ON_WINDOWS, ON_WSL, IN_APPIMAGE, ON_CYGWIN, ON_MSYS, ON_POSIX, ON_FREEBSD, ON_DRAGONFLY, ON_NETBSD, ON_OPENBSD
xontrib load onepath
if ON_LINUX and _shutil.which('nvim'):
$XONTRIB_ONEPATH_ACTIONS['text/'] = 'nvim'
```
## File types
| # | Type | Example |
|---|---------|----------|
| 1 | Full path to file. | `~/.xonshrc` |
| 2 | File name. | `file.txt` |
| 3 | File extension. | `*.txt` |
| 4 | MIME type/subtype and extension. | `text/plain.txt` |
| 5 | MIME type/subtype. | `text/plain` |
| 6 | MIME type. | `text/` |
| 7 | Any file. | `` (constant) |
| 8 | Any executable file. | `` (constant)|
| 9 | Any directory. | `` (constant) |
| 10| Any file or directory. | `*` (constant) |
To get MIME type for the file run `file --mime-type --brief `.
## Examples of actions
Use `XONTRIB_ONEPATH_ACTIONS` environment variable to add new actions.
If you need more complex actions use [callable xonsh aliases](https://xon.sh/tutorial.html#callable-aliases).
### Simple actions
```python
$XONTRIB_ONEPATH_ACTIONS['text/'] = 'vim' # Use vim to open any text file
$XONTRIB_ONEPATH_ACTIONS['.xonshrc'] = 'vim' # vim for `.xonshrc` file
$XONTRIB_ONEPATH_ACTIONS['*.log'] = 'tail' # tail for text type *.log files
$XONTRIB_ONEPATH_ACTIONS['text/plain.txt'] = 'less' # less for plain text *.txt files
$XONTRIB_ONEPATH_ACTIONS[''] = 'ls' # list the files in the directory
$XONTRIB_ONEPATH_ACTIONS['application/zip'] = 'als' # list files in zip file using atool
```
#### Run xsh regardless the execution permissions
```python
$XONTRIB_ONEPATH_ACTIONS = {'*.xsh':'xonsh', **$XONTRIB_ONEPATH_ACTIONS} # Insert on top
xontrib load onepath
script.xsh # the same as: chmod +x script.xsh && ./script.xsh
```
#### View CSV tables using pandas
```python
import pandas as pd
def _view_csv_with_pandas(args):
print(pd.read_csv(args[0]))
aliases['view_csv_with_pandas'] = _view_csv_with_pandas
del _view_csv_with_pandas
$XONTRIB_ONEPATH_ACTIONS['application/csv'] = 'view_csv_with_pandas'
```
#### cd & ls
```python
def _cdls(args):
cd @(args[0])
if int($(ls | wc -l).strip()) < 100:
ls --group-directories-first -a --color
aliases['cdls'] = _cdls
del _cdls
$XONTRIB_ONEPATH_ACTIONS[''] = 'cdls'
```
## Debug
To enable debug mode run `$XONTRIB_ONEPATH_DEBUG = True`.
## Known issues
### ImportError: failed to find libmagic
Install libmagic: `brew install libmagic`.
### NTFS in Linux: all files have execute permission
If you mount NTFS partition with default permissions then all files will have execute permission
and `onepath` will execute them instead of action. The right way
is to [change default `/etc/fstab` settings](https://askubuntu.com/questions/113733/how-do-i-correctly-mount-a-ntfs-partition-in-etc-fstab).
Example:
```bash
sudo umount /d
sudo mount -o uid=1000,gid=1000,dmask=027,fmask=137 /d
ls -la /d
```
## Links
* This package is the part of [ergopack](https://github.com/anki-code/xontrib-ergopack) - the pack of ergonomic xontribs.
* This package was created with [xontrib template](https://github.com/xonsh/xontrib-template).