Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
Stephan Casas committed Aug 4, 2022
0 parents commit e628a04
Show file tree
Hide file tree
Showing 15 changed files with 1,267 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Auto detect text files and perform LF normalization
* text=auto
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
assets/preview
assets/indices
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2022 Stephan Casas

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.
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# alfred-laravel-helper-docs

alfred-laravel-helper-docs offers you rapid access to documentation for Laravel's helper functions — including those for `Collection` and fluent strings.

**[Click Here to Download the Latest Release](https://github.com/stephancasas/alfred-laravel-helper-docs/releases/latest)**

<p align="center"><img src="./public/preview.gif" width="100%"></p>

## Usage

The workflow is triggered by the keyword `larahelp` but you may, of course, modify this in the Alfred workflow editor. Once activated, begin typing to search for a helper method.

Each method is decorated by an icon representative of its taxonomy (e.g. methods on `Arr` use a square brackets icon, collections use a "stack" icon). A preview of the method's description is shown below the method name.

Use the arrow keys to highlight your desired method, and press the **SHIFT** key to open a screenshot of the documentation in QuickLook. When done, press **SHIFT** or **ESCAPE** to dismiss the preview.

## Build

Screenshots and indices for the helper methods are built using NodeJS to execute Puppeteer. If you'd like to build the assets yourself, download the source and run `npm run build:collections` and `npm run build:helpers`. The required assets will be rendered in the `./assets/preview` and `./assets/indices` directory.

## Contributing / Standards

I built this in an hour. There are no standards.

## License

MIT — "Hell yeah, free software!"
Binary file added assets/icons/brackets-square.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/icons/function.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/icons/layer-group.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/icons/quote-right.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/icons/quotes.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/workflow.psd
Binary file not shown.
Loading

0 comments on commit e628a04

Please sign in to comment.