Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/earthly/earthly-emacs
Major mode for editing Earthly Earthfile
https://github.com/earthly/earthly-emacs
earthfile earthly emacs emacs-mode
Last synced: about 12 hours ago
JSON representation
Major mode for editing Earthly Earthfile
- Host: GitHub
- URL: https://github.com/earthly/earthly-emacs
- Owner: earthly
- License: mpl-2.0
- Created: 2021-08-27T22:36:55.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-03T14:51:33.000Z (4 months ago)
- Last Synced: 2024-11-05T01:34:45.420Z (10 days ago)
- Topics: earthfile, earthly, emacs, emacs-mode
- Language: Emacs Lisp
- Homepage:
- Size: 393 KB
- Stars: 18
- Watchers: 5
- Forks: 8
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# earthly-mode
[](https://melpa.org/#/earthfile-mode)
Major mode for editing Earthly Earthfile (https://docs.earthly.dev/docs/earthfile) developed
by [@wingyplus](https://github.com/wingyplus), [@TheCoreMan](https://github.com/TheCoreMan) and [@duck1123](https://github.com/duck1123)
## Current features
* Syntax highlighting support.
* Toggle comment.
### Requirements
For using:
- emacs
For testing changes:
- [eldev](https://github.com/emacs-eldev/eldev) - used for linting
## Installation Notes
### use-package
If you're using `use-package`, you can do:
```elisp
(use-package earthfile-mode
:ensure t)
```
### Doom emacs
If you're using Doom emacs, you can add the following to `~/.doom.d/packages.el`:
``` elisp
(package! earthfile-mode)
```
Followed by the following shell command:
``` shell
~/.emacs.d/bin/doom sync
```
### Manually via MELPA
Just run this command in Emacs:
```
M-x package-install RET earthfile-mode RET
```
### Manual via local installation
Add `earthfile-mode` to `load-path` using `add-to-list`:
```elisp
(add-to-list 'load-path "path/to/earthfile-mode")
(require 'earthfile-mode)
```
## Screenshot
