Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
53db3c33
Commit
53db3c33
authored
Aug 25, 2021
by
Mike Russo
Committed by
Vitaly Slobodin
Aug 25, 2021
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
A first draft for emacs configuration instructions
parent
3e840e6e
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
34 additions
and
0 deletions
+34
-0
.gitignore
.gitignore
+1
-0
doc/.vale/gitlab/spelling-exceptions.txt
doc/.vale/gitlab/spelling-exceptions.txt
+1
-0
doc/development/documentation/testing.md
doc/development/documentation/testing.md
+32
-0
No files found.
.gitignore
View file @
53db3c33
...
...
@@ -3,6 +3,7 @@
*.mo
*.edit.po
*.rej
.dir-locals.el
.DS_Store
.bundle
.chef
...
...
doc/.vale/gitlab/spelling-exceptions.txt
View file @
53db3c33
...
...
@@ -209,6 +209,7 @@ fixup
Flawfinder
Flowdock
Fluentd
Flycheck
Forgerock
formatters
Fugit
...
...
doc/development/documentation/testing.md
View file @
53db3c33
...
...
@@ -319,6 +319,38 @@ To configure Vale in your editor, install one of the following as appropriate:
cases,
`vale`
should work. To find the location, run
`which vale`
in a terminal.
-
Vim
[
ALE plugin
](
https://github.com/dense-analysis/ale
)
.
-
Emacs
[
Flycheck extension
](
https://github.com/flycheck/flycheck
)
.
This requires some configuration:
-
`Flycheck`
supports
`markdownlint-cli`
out of the box, but you must point it
to the
`.markdownlint.yml`
at the base of the project directory. A
`.dir-locals.el`
file can accomplish this:
```
lisp
;; Place this code in a file called `.dir-locals.el` at the root of the gitlab project.
((
markdown-mode
.
((
flycheck-markdown-markdownlint-cli-config
.
".markdownlint.yml"
))))
```
-
A minimal configuration for Flycheck to work with Vale could look like this:
```
lisp
(
flycheck-define-checker
vale
"A checker for prose"
:command
(
"vale"
"--output"
"line"
"--no-wrap"
source
)
:standard-input
nil
:error-patterns
((
error
line-start
(
file-name
)
":"
line
":"
column
":"
(
id
(
one-or-more
(
not
(
any
":"
))))
":"
(
message
)
line-end
))
:modes
(
markdown-mode
org-mode
text-mode
)
:next-checkers
((
t
.
markdown-markdownlint-cli
))
)
(
add-to-list
'flycheck-checkers
'vale
)
```
In this setup the
`markdownlint`
checker is set as a "next" checker from the defined
`vale`
checker.
Enabling this custom Vale checker provides error linting from both Vale and markdownlint.
We don't use
[
Vale Server
](
https://errata-ai.github.io/vale/#using-vale-with-a-text-editor-or-another-third-party-application
)
.
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment