https://github.com/iquiw/company-restclient

Company-mode completion back-end for restclient-mode
https://github.com/iquiw/company-restclient

Last synced: 3 months ago
JSON representation

Company-mode completion back-end for restclient-mode

• Host: GitHub
• URL: https://github.com/iquiw/company-restclient
• Owner: iquiw
• Created: 2014-12-23T12:43:04.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2019-04-26T13:14:44.000Z (almost 6 years ago)
• Last Synced: 2024-08-05T06:06:27.174Z (6 months ago)
• Language: Emacs Lisp
• Size: 19.5 KB
• Stars: 60
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst

Awesome Lists containing this project

README

        
=====================================

 company-restclient |travis| |melpa|

=====================================

`Company-mode`_ completion back-end for `restclient-mode`_.

It provides auto-completion for HTTP methods and headers in `restclient-mode`_.

Completion source is given by `know-your-http-well`_.

Installation

============

Depends

-------

* cl-lib

* `company-mode`_

* `know-your-http-well`_

* `restclient-mode`_

Setup from MELPA_

-----------------

1. Install from `MELPA`_::

     M-x package-install RET company-restclient RET

2. Add ``company-restclient`` to ``company-backends`` after loading `company-mode`_.

   .. code:: emacs-lisp

     (add-to-list 'company-backends 'company-restclient)

Setup from Git

--------------

1. Install from Git::

     git clone https://github.com/iquiw/company-restclient.git

2. Add ``company-restclient`` to ``company-backends`` after loading `company-mode`_.

   .. code:: emacs-lisp

     (add-to-list 'load-path "/path/to/company-restclient")

     (add-to-list 'company-backends 'company-restclient)

Feature

=======

* HTTP method name completion

* HTTP header name completion

  If header name starts with uppercase character, the completion result is capitalized (e.g. "Content-Type").

  Otherwise, the completion result contains lowercase characters only (e.g. "content-type").

* HTTP header value completion

  If header name matches with key of a cutomizable association list, ``company-restclient-header-values``,

  the corresponding value, list of strings, is used for completion candidates.

* Description about HTTP method and header is displayed in minibuffer

* Variable name completion

License

=======

Public domain

.. _company-mode: https://company-mode.github.io/

.. _restclient-mode: https://github.com/pashky/restclient.el

.. _know-your-http-well: https://github.com/for-GET/know-your-http-well

.. _MELPA: https://melpa.org/

.. |travis| image:: https://travis-ci.org/iquiw/company-restclient.svg?branch=master

            :target: https://travis-ci.org/iquiw/company-restclient

.. |melpa| image:: https://melpa.org/packages/company-restclient-badge.svg

           :target: https://melpa.org/#/company-restclient