search

DFreds / code-peek-atom

Atom package to peek functions in different files
MIT License
22 stars 10 forks source link
atom atom-editor atom-package

readme

Code Peek

This package allows you to quickly peek and edit functions contained in other files instead of having to open the file separately. This was inspired by Brackets' quick edit feature and Maushundb's Quick Editor for CSS/LESS/SCSS.

Code Peek Demo

Full change log here.

Supported Files

Currently, supported files include:

Adding A Language

If you'd like to add your own language, send me a regex string or make a pull request that adds one that will correctly find the first line of a function using a known name for that language in all cases. Currently, Code Peek supports languages that use curly brackets to indicate the start and end of a function as well as tab based languages such as Python.

The regular expressions for the supported files are located here.

Installation

apm install code-peek

Or search for code-peek in the Atom settings view.

Configuration

Ask If Save On Modified

By default, clicking the "Close without saving" button after a file is modified using Code Peek will ask the user if they want to save their changes. This configuration option can be toggled off to stop the dialogue box from appearing.

Ignored Paths

This setting provides a way to exclude certain paths or files from being found by Code Peek. Please note that any files or directories in 'Core -> Ignored Names' will be ignored even if you do not list it here. Additionally, any files and directories ignored by the current project's VCS system will be ignored if the 'Core -> Exclude VCS Ignored Paths' is checked. See the description of that setting for more details.

Code Peek Location

This setting dictates where the Code Peek panel should appear. By default, it will appear at the bottom of the screen. Additional options include top, left, right, header, footer, and modal.

Max Height

By default, the maximum height of the Code Peek panel is 300px. This configuration option can be set to change the height, and supports a range from 200px to 800px. This only affects panels where the location is top, bottom, header, footer, or modal.

Max Width

By default, the maximum width of the Code Peek panel is 500px. This configuration option can be set to change the width, and supports a range from 200px to 1000px. This only affects panels where the location is left or right.

Key Bindings

The default cmd-alt-e or ctrl-alt-e will toggle code-peek while the cursor is over a function of a supported type.

This can be edited by defining key bindings as shown below.

'.platform-darwin atom-text-editor':
  'cmd-alt-e': 'code-peek:peekFunction'
  'shift-escape': 'code-peek:toggleCodePeekOff'

'.platform-linux atom-text-editor, .platform-win32 atom-text-editor':
  'ctrl-alt-e': 'code-peek:peekFunction'
  'shift-escape': 'code-peek:toggleCodePeekOff'

Other Projects

Test Navigator

I created Test Navigator to allow you to quickly navigate between implementation and test files. Check it out!