Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dylanjm/emacs-moose-mode
An Emacs major-mode for MOOSE input files.
https://github.com/dylanjm/emacs-moose-mode
Last synced: about 6 hours ago
JSON representation
An Emacs major-mode for MOOSE input files.
- Host: GitHub
- URL: https://github.com/dylanjm/emacs-moose-mode
- Owner: dylanjm
- License: mit
- Created: 2020-03-04T22:00:20.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-03-01T22:04:01.000Z (over 3 years ago)
- Last Synced: 2023-07-16T20:10:27.107Z (over 1 year ago)
- Language: Emacs Lisp
- Homepage:
- Size: 230 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.org
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
#+title: MOOSE-Mode
#+ATTR_HTML: :style margin-left: auto; margin-right: auto;
[[https://img.shields.io/github/v/tag/dylanjm/emacs-moose-mode][https://img.shields.io/github/v/tag/dylanjm/emacs-moose-mode.svg?label=release]]
[[https://github.com/dylanjm/emacs-moose-mode/actions][file:https://github.com/dylanjm/emacs-moose-mode/workflows/CI/badge.svg]]
This is an Emacs major-mode for [[https://github.com/idaholab/moose][MOOSE]] input and testing files. It provides syntax-highlighting and other functionality.
[[file:assets/example.png]]
** Installation
Currently, this package is not yet available on [[https://melpa.org/#/][MELPA]]. In the meantime, you can install =emacs-moose-mode= by cloning this repo and telling your =init.el= file where to find it:
#+begin_src emacs-lisp
(add-to-list 'load-path "")
(require 'moose-mode)
#+end_src
Or, if you use [[https://github.com/raxod502/straight.el][straight package manager]] you can:
#+begin_src emacs-lisp
(use-package
:straight (:host github :repo "dylanjm/emacs-moose-mode"))
#+end_src
** Usage
By default, =moose-mode= is set to 'auto-activate' when emacs opens =*.i=, =assessment=, or =test= files.
Also, =moose-mode= defaults to using an indentation-offset of 2. You can change this variable by
putting the following in your =init.el=:
#+begin_src emacs-lisp
(with-eval-after-load moose-mode
(setq moose-indent-offset 4))
#+end_src
** Roadmap
Listed in order from /most-practical/ to /strech-goals/.
+ [X] Syntax Highlighting
+ [X] Mode-Specific Indentation
+ [ ] Navigation Functions
+ [ ] Snippets
+ [ ] Autocomplete (Company-Mode integration)
+ [ ] Action-Expansion
+ [ ] Linting
*Note*: Some of these goals may be broken off into separate libraries.
** Contribution
If you find a bug or would like to contribute, please submit an [[https://github.com/dylanjm/emacs-moose-mode/issues][issue]] and/or a [[https://github.com/dylanjm/emacs-moose-mode/pulls][pull-request]].
** Related Projects
+ [[https://github.com/idaholab/moose][MOOSE]]
+ [[https://github.com/dylanjm/moose-hit-format.el][Moose-HIT-Format (Emacs)]]
+ [[https://github.com/dschwen/moose-hit-format][Moose-HIT-Format (Atom)]]
+ [[https://github.com/dschwen/language-moose][Language-Moose (Atom)]]
+ [[https://github.com/dschwen/autocomplete-moose][Moose-Autocomplete (Atom)]]
** MIT License
#+begin_example
Copyright 2020-2021 Dylan McDowell
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
#+end_example