Code Monkey home page Code Monkey logo

counsel-projectile's Introduction

MELPA

Description

Projectile has native support for using ivy as its completion system. Counsel-projectile provides further ivy integration into projectile by taking advantage of ivy's mechanism to select from a list of actions and/or apply an action without leaving the completion session. It is inspired by helm-projectile.

Installation

Install the package from MELPA or el-get, or clone this repository somewhere in your load path.

Basic setup

You can use counsel-projectile (and in particular call the command counsel-projectile described below with C-c p SPC) without setting up anything. If you want counsel-projectile to install replacements for some standard projectile commands (see below again), add the following to your init file:

(counsel-projectile-on)

Usage

The main command is counsel-projectile, and can be called with C-c p SPC (assuming the variable projectile-keymap-prefix has been left at its default value, C-c p). This command behaves differently depending on whether you call it from inside a project or not:

  • If you are not inside a project, it calls the function counsel-projectile-switch-project. This uses ivy to display a list of all known projects and let you select a project to switch to. You can choose from a number of actions to be applied upon switching (using M-o or C-M-o, as usual with ivy).
  • If you are inside a project, it instead uses ivy to display a list of all project buffers and files. The project buffers are fontified, and the project files that are not currently open are shown as "virtual buffers" with a different font (as in the function ivy-switch-buffer). You can choose to visit the selected file / display the selected buffer in the current or another window. If you would rather switch to a different project, you can so with M-SPC.

Counsel-projectile also provides replacements for several standard projectile commands, which take advantage of ivy to let you choose from several actions. To install these replacements, call the command counsel-projectile-on. Here are the currently defined replacements, with their default key-bindings:

  • C-c p f counsel-projectile-find-file: find a project file,
  • C-c p d counsel-projectile-find-dir: find a project directory,
  • C-c p b counsel-projectile-switch-to-buffer: switch to a project buffer,
  • C-c p s s counsel-projectile-ag: search project files with ag,
  • C-c p p counsel-projectile-switch-project: switch to another project (see above).

If your default action for switching to a project (stored in the variable projectile-switch-project-action) is projectile-find-file (the default), then counsel-projectile-on also replaces it with counsel-projectile.

You can call the command counsel-projectile-off to undo all changes made by counsel-projectile-on.

Contributors

Many thanks to abo-abo and DamienCassou who encouraged and helped me to start this repository.

counsel-projectile's People

Contributors

abo-abo avatar bbigras avatar ericdanan avatar raxod502 avatar syohex avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.