119 lines
4.1 KiB
Org Mode
119 lines
4.1 KiB
Org Mode
#+TITLE: CFEngine layer
|
|
#+HTML_HEAD_EXTRA: <link rel="stylesheet" type="text/css" href="../css/readtheorg.css" />
|
|
|
|
#+CAPTION: logo
|
|
# The maximum height of the logo should be 200 pixels.
|
|
[[file:./img/agent.png]]
|
|
|
|
* Table of Contents :TOC_4_org:noexport:
|
|
- [[Description][Description]]
|
|
- [[Install & Configuration][Install & Configuration]]
|
|
- [[Key bindings][Key bindings]]
|
|
|
|
* Description
|
|
This layer makes working with CFEngine policy easier:
|
|
- Syntax highlighting
|
|
- On the fly syntax checks
|
|
- Auto completion
|
|
|
|
* Install & Configuration
|
|
|
|
Add =cfengine= to the =dotspacemacs-configuration-layers= in your =~/.spacemacs=
|
|
to use this layer.
|
|
|
|
For working with CFEngine policy I highly recommend the =syntax-checking=, and
|
|
=auto-completion= layers.
|
|
|
|
Here is an example:
|
|
|
|
#+begin_src emacs-lisp
|
|
(defun dotspacemacs/layers ()
|
|
"Configuration Layers declaration.
|
|
You should not put any user code in this function besides modifying the variable
|
|
values."
|
|
(setq-default
|
|
dotspacemacs-configuration-layers
|
|
'(
|
|
;; ----------------------------------------------------------------
|
|
;; Example of useful layers you may want to use right away.
|
|
;; Uncomment some layer names and press <SPC f e R> (Vim style) or
|
|
;; <M-m f e R> (Emacs style) to install them.
|
|
;; ----------------------------------------------------------------
|
|
|
|
;; ----------------------------------------------------------------
|
|
;; CFEngine Related Layers
|
|
;; ----------------------------------------------------------------
|
|
cfengine
|
|
syntax-checking
|
|
auto-completion
|
|
|
|
;; ----------------------------------------------------------------
|
|
;; Other Userful Layers
|
|
;; ----------------------------------------------------------------
|
|
git
|
|
github
|
|
markdown
|
|
org
|
|
spell-checking
|
|
)
|
|
|
|
;; Delete whitespace while saving buffer. Possible values are `all'
|
|
;; to aggressively delete empty line and long sequences of whitespace,
|
|
;; `trailing' to delete only the whitespace at end of lines, `changed'to
|
|
;; delete only whitespace for changed lines or `nil' to disable cleanup.
|
|
;; (default nil)
|
|
;;
|
|
;; ----------------------------------------------------------------
|
|
;; This is conservative, if you want to cleanup traling whitespace
|
|
;; left by the efforts from others consider setting it to `trailing'.
|
|
;; ----------------------------------------------------------------
|
|
dotspacemacs-whitespace-cleanup 'changed
|
|
|
|
;; ----------------------------------------------------------------)
|
|
|
|
(defun dotspacemacs/user-config ()
|
|
"Configuration function for user code.
|
|
This function is called at the very end of Spacemacs initialization after
|
|
layers configuration. You are free to put any user code."
|
|
|
|
;; ----------------------------------------------------------------
|
|
;; Enable line numbering for CFEngine policy files
|
|
;; ----------------------------------------------------------------
|
|
(add-hook 'cfengine3-mode-hook
|
|
(lambda ()
|
|
(linum-mode 1)))
|
|
|
|
;; ----------------------------------------------------------------
|
|
;; "Easy template" for quickly inserting cfengine3 code blocks in
|
|
;; org-mode. Simply type =<cfe= and then press TAB
|
|
;; ----------------------------------------------------------------
|
|
(eval-after-load 'org
|
|
'(progn
|
|
(add-to-list 'org-structure-template-alist
|
|
'("cfe" "#+begin_src cfengine3\n?\n#+end_src"))))
|
|
|
|
;; ----------------------------------------------------------------)
|
|
#+end_src
|
|
|
|
Use =M-x customize-group RET cfengine= to customize CFEngine Mode.
|
|
|
|
If you like attributes to be intended from the promiser set =Indentation amount
|
|
from anchor= to =2=. For example:
|
|
|
|
#+begin_src cfengine3
|
|
bundle agent main
|
|
{
|
|
vars:
|
|
|
|
"promiser"
|
|
string => "value",
|
|
comment => "Indented 2 spaces from promiser";
|
|
}
|
|
#+end_src
|
|
|
|
* Key bindings
|
|
|
|
| Key Binding | Description |
|
|
|-------------+-----------------------|
|
|
| ~<SPC> m j~ | Reformats JSON string |
|