https://github.com/meqif/docker-compose-mode

Major mode for editing docker-compose files
https://github.com/meqif/docker-compose-mode

docker docker-compose emacs

Last synced: about 1 month ago
JSON representation

Major mode for editing docker-compose files

• Host: GitHub
• URL: https://github.com/meqif/docker-compose-mode
• Owner: meqif
• License: apache-2.0
• Created: 2017-07-20T22:26:40.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-01-11T18:45:27.000Z (12 months ago)
• Last Synced: 2024-08-05T06:06:12.086Z (5 months ago)
• Topics: docker, docker-compose, emacs
• Language: Emacs Lisp
• Homepage:
• Size: 55.7 KB
• Stars: 59
• Watchers: 3
• Forks: 12
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# docker-compose-mode

[![MELPA](https://melpa.org/packages/docker-compose-mode-badge.svg)](https://melpa.org/#/docker-compose-mode)

[![MELPA Stable](http://stable.melpa.org/packages/docker-compose-mode-badge.svg)](http://stable.melpa.org/#/docker-compose-mode)

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

Major mode for editing docker-compose files, providing context-aware completion

of docker-compose keys through `completion-at-point-functions`.

The completions can be used with the completion system shipped with vanilla

Emacs, and 3rd-party frontends like company-mode, autocomplete, and

ido-at-point.

## Installation

It's available on [MELPA](https://melpa.org/#/docker-compose-mode):

```

M-x package-install docker-compose-mode

```

Or you can just save the `.el` files in your Emacs' load path.

## Usage

Add the following to your `init.el`:

``` emacs-lisp

(require 'docker-compose-mode)

```

Alternatively, if you prefer using `use-package`:

``` emacs-lisp

(use-package docker-compose-mode)

```

## Customization

By default, the keyword completion function detects the docker-compose version

of the current buffer and suggests the appropriate keywords.

You can change the candidates offered by the backend by customizing `docker-compose-keywords`.