https://github.com/cldwalker/photon
Light Table plugin to quickly open your most active projects
https://github.com/cldwalker/photon
Last synced: 3 months ago
JSON representation
Light Table plugin to quickly open your most active projects
- Host: GitHub
- URL: https://github.com/cldwalker/photon
- Owner: cldwalker
- License: mit
- Created: 2014-04-06T16:26:26.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2014-04-06T17:20:46.000Z (about 12 years ago)
- Last Synced: 2025-02-14T18:16:31.990Z (over 1 year ago)
- Language: Clojure
- Homepage:
- Size: 395 KB
- Stars: 9
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
## Description
photon provides a fuzzy finder to open your most active projects. By configuring
it with the parent directories of those projects, almost anything you work on
can be keystrokes away.
## Install
Install this plugin with LT's plugin manager or clone this project to your LT
plugins directory.
## Usage
From the commandbar, choose `photon: Select folder to add`. This activates a
fuzzy finder with possible projects to add to your workspace. To bring up a
project, type the first few letters of a project's name. For example, say you
had these project directories:
```
~/code
├── fork
│ ├── CodeMirror
│ └── LightTable
└── repo
├── boson
└── lightning
```
Typing `C`, `L`, `b` or `l` would be enough to highlight any of these projects.
photon also provides a command to remove a project from your workspace, `photon:
Select folder to remove`.
## Configuration
By default photon only knows where your plugin directories are. The more
directories you tell photon about, the more convenience it will give you. For
example, let's add the parent directories from the Usage example:
```clj
;; In user.behaviors
:app [
...
(:lt.plugins.photon/set-directories
;; :plugins is an alias for your plugins directory
[:plugins "~/code/fork" "~/code/cjars")]
```
Note that this configuration won't change much since we specify parent directories.
As we add new projects under them, photon automatically picks up the new projects.
For another behaviors example, [see my configuration](https://github.com/cldwalker/ltfiles/blob/6390d95ebe71e11c6bc5eb86ac3d01a36b2b34c8/settings/user.behaviors#L93-L95).
Like any command, the commands to add and remove projects can be activated with
keybindings. For example:
```
;; in user.keymaps
:app {
...
"alt-a" [:photon.add-folder]}
```
## Bugs/Issues
Please report them [on github](http://github.com/cldwalker/photon/issues).
## Contributions
[See here](http://tagaholic.me/contributing.html) for contributing guidelines.
## Limitations
* Currently only adding projects/directories is supported. I didn't have a need for adding files.
I'm open to such a pull request as long as everything supports a directory and file.
* By default, the fuzzy finder shows your last selection which may reflect stale data. To get fresh
data, hit backspace or simply start typing.
## License
See LICENSE.txt