xontrib-superfile 0.0.2__tar.gz

xontrib_superfile-0.0.2/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2020, Noortheen Raja NJ
+Copyright (c) 2026, TechnoStrife
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

xontrib_superfile-0.0.2/PKG-INFO

@@ -0,0 +1,63 @@
+Metadata-Version: 2.1
+Name: xontrib-superfile
+Version: 0.0.2
+Summary: superfile support function for xonsh shell
+Keywords: xontrib,xonsh
+Author-Email: TechnoStrife <technostrife@gmail.com>
+License: MIT
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: System :: Shells
+Classifier: Topic :: System :: System Shells
+Classifier: Topic :: Terminals
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Project-URL: Documentation, https://github.com/TechnoStrife/xontrib-superfile/blob/master/README.md
+Project-URL: Code, https://github.com/TechnoStrife/xontrib-superfile
+Project-URL: Issue tracker, https://github.com/TechnoStrife/xontrib-superfile/issues
+Project-URL: repository, https://github.com/TechnoStrife/xontrib-superfile
+Requires-Python: >=3.7
+Requires-Dist: xonsh>=0.12
+Provides-Extra: dev
+Description-Content-Type: text/markdown
+
+# Overview
+[superfile](https://github.com/yorukot/superfile) support function for xonsh shell
+
+
+## Installation
+
+To install use pip:
+``` bash
+xpip install -U git+https://github.com/TechnoStrife/xontrib-superfile
+```
+
+pip package not implemented yet:
+``` bash
+xpip install xontrib-superfile
+```
+
+## Usage
+Enable `cd_on_quit` in [superfile config](https://superfile.dev/configure/superfile-config/):
+```
+cd_on_quit = true
+```
+
+This xontrib adds `sf` alias function. So commands like `cd` will work from superfile.
+``` bash
+$ xontrib load superfile
+$ sf
+```
+
+Now you can quit superfile normally and xonsh will cd into the last directory.
+
+`superfile` can also be launched with shortcut `Ctrl+N`. 
+This can be changed by `$XONSH_SUPERFILE_KEY="c-n"` or disabled with `$XONSH_SUPERFILE_KEY=""`. 
+(PS [PTK's keybinding guide](https://python-prompt-toolkit.readthedocs.io/en/master/pages/advanced_topics/key_bindings.html#list-of-special-keys) 
+for full list of key names.)
+
+## Credits
+
+This package was created from [xontrib broot example](https://github.com/jnoortheen/xontrib-broot).

xontrib_superfile-0.0.2/README.md

@@ -0,0 +1,38 @@
+# Overview
+[superfile](https://github.com/yorukot/superfile) support function for xonsh shell
+
+
+## Installation
+
+To install use pip:
+``` bash
+xpip install -U git+https://github.com/TechnoStrife/xontrib-superfile
+```
+
+pip package not implemented yet:
+``` bash
+xpip install xontrib-superfile
+```
+
+## Usage
+Enable `cd_on_quit` in [superfile config](https://superfile.dev/configure/superfile-config/):
+```
+cd_on_quit = true
+```
+
+This xontrib adds `sf` alias function. So commands like `cd` will work from superfile.
+``` bash
+$ xontrib load superfile
+$ sf
+```
+
+Now you can quit superfile normally and xonsh will cd into the last directory.
+
+`superfile` can also be launched with shortcut `Ctrl+N`. 
+This can be changed by `$XONSH_SUPERFILE_KEY="c-n"` or disabled with `$XONSH_SUPERFILE_KEY=""`. 
+(PS [PTK's keybinding guide](https://python-prompt-toolkit.readthedocs.io/en/master/pages/advanced_topics/key_bindings.html#list-of-special-keys) 
+for full list of key names.)
+
+## Credits
+
+This package was created from [xontrib broot example](https://github.com/jnoortheen/xontrib-broot).

xontrib_superfile-0.0.2/pyproject.toml

@@ -0,0 +1,50 @@
+[project]
+authors = [
+    { name = "TechnoStrife", email = "technostrife@gmail.com" },
+]
+requires-python = ">=3.7"
+dependencies = [
+    "xonsh>=0.12",
+]
+name = "xontrib-superfile"
+version = "0.0.2"
+description = "superfile support function for xonsh shell"
+readme = "README.md"
+keywords = [
+    "xontrib",
+    "xonsh",
+]
+classifiers = [
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Topic :: System :: Shells",
+    "Topic :: System :: System Shells",
+    "Topic :: Terminals",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+]
+
+[project.optional-dependencies]
+dev = []
+
+[project.license]
+text = "MIT"
+
+[project.urls]
+Documentation = "https://github.com/TechnoStrife/xontrib-superfile/blob/master/README.md"
+Code = "https://github.com/TechnoStrife/xontrib-superfile"
+"Issue tracker" = "https://github.com/TechnoStrife/xontrib-superfile/issues"
+repository = "https://github.com/TechnoStrife/xontrib-superfile"
+
+[tool.pdm.build]
+includes = [
+    "xontrib",
+]
+
+[build-system]
+requires = [
+    "pdm-backend>=2.0.0",
+]
+build-backend = "pdm.backend"

xontrib_superfile-0.0.2/xontrib/superfile.py

@@ -0,0 +1,58 @@
+import shutil
+import subprocess
+from pathlib import Path
+from xonsh.built_ins import XSH
+from xonsh.tools import uncapturable
+
+
+superfile = "superfile"  # for nixos
+if shutil.which("superfile") is None:
+    superfile = "spf"
+
+
+@uncapturable
+def _sf(args, stdin=None, stdout=None, stderr=None):
+    spf_last_dir = Path(XSH.env.get("HOME") + "/.local/state/superfile/lastdir")
+    status_code: int = subprocess.call(
+        (superfile,) + tuple(args),
+        stdin=stdin,
+        stderr=stderr,
+        stdout=stdout,
+    )
+    if status_code == 0 and spf_last_dir.is_file():
+        with spf_last_dir.open() as f:
+            content = f.read()
+            if content:
+                XSH.builtins.evalx(content)
+        spf_last_dir.unlink()
+
+    return status_code
+
+
+XSH.aliases["sf"] = _sf
+
+
+@XSH.builtins.events.on_ptk_create
+def custom_keybindings(bindings, **kw):
+    def handler(key_name: str, default: str):
+        def do_nothing(_):
+            pass
+
+        if key_name not in XSH.env:
+            key = default
+        else:
+            key = XSH.env.get(key_name)
+        if key:
+            return bindings.add(key)
+        return do_nothing
+
+    @handler("XONSH_SUPERFILE_KEY", "c-n")
+    def start_superfile(event):
+        _sf([])
+
+
+if __name__ == "__main__":
+    from xonsh.built_ins import XSH
+
+    XSH.load()
+    data = XSH.execer.eval("")