Vale & neovim으로 전문가처럼 글쓰기

Vale은 모든 작가를 위해 만들어진 구문 인식 산문 린터입니다. 지금까지 100개 이상의 릴리스가 있는 vale은 5년 된 프로젝트이며 Google, Microsoft, IBM, RedHat과 같은 회사에서 글을 쓰는 사람들이 사용하고 있습니다. 저는 최근에 일상적인 글쓰기 워크플로에서 Vale을 사용하기 시작했으며 아이디어를 전달하기 위해 선택한 단어에 상당한 영향을 미칩니다. 나는 주로 네오빔을 쓰기 때문에 설정vale하는 방법과 네오빔과 함께 사용하는 방법에 대해 다룰 것이다.

소프트웨어를 작성할 때 일반적인 문제를 찾기 위해 정적 분석 도구를 사용하는 것처럼 vale은 작성자가 기술 문서를 작성하는 동안 선택할 단어/산문을 구성하는 데 도움을 주는 것을 목표로 합니다.

베일 설치

그들의 github releases page에서 최신 버전의 vale을 다운로드하십시오.

작문 스타일 및 값 구성

Vale은 .vale.ini 디렉토리나 상대 프로젝트 디렉토리에 $HOME 구성 파일이 있어야 합니다. 아래는 개인적으로 사용하는 샘플 구성입니다.

# This goes in a file named either `.vale.ini` or `_vale.ini`.
StylesPath = styles
MinAlertLevel = suggestion

# External packages
Packages = Google, Readability, alex, proselint, IBM
# Only Markdown and .txt files; change to whatever you're using.
[*.{md,txt}]
# List of styles to load.
BasedOnStyles = alex, proselint

이 파일을 만든 후 vale sync를 실행하여 구성에서 언급한 모든 외부 패키지를 다운로드/업데이트합니다.

Vale 스타일은 Vale에서 보고해야 하는 단어를 정의하는 "규칙"의 저장소입니다. 규칙은 yml 파일에 정의되어 있습니다.

If you prefer to customize the config yourself, I recommend using the config generator

Vale 프로젝트는 7 style packages . 인기 있는 스타일 중 일부는 Google 및 Microsoft와 같은 조직의 작성 규칙을 기반으로 하며 그 중 일부는 아래에 나열되어 있습니다.

Microsoft Writing Style Guide

Google Developer Documentation Style Guide

IBM’s Developer Editorial Style Guide

vale-style topic 의 github에서 더 많은 베일 스타일을 찾을 수 있습니다.

귀하의 작문 요구에 가장 적합한 스타일을 선택하는 것은 귀하의 작문 스타일에 따라 다릅니다. 조직의 작가 팀과 함께 작업하는 경우 더 엄격하지만 팀에 적합한 Google 및 Microsoft의 스타일을 사용하는 것이 좋습니다. 개인 블로그가 있거나 단독으로 글을 작성하는 경우 규칙이 더 관대한 alex 또는 proselint와 같은 스타일을 사용하십시오. vale config에서 BasedOnStyles 속성을 전환하여 모든 규칙을 시도해 보는 것이 좋습니다.

네오빔 설정

null-ls.nvim neovim 플러그인을 사용하면 vale을 산문 린터로 사용할 수 있습니다.
Plug를 사용하여 null-ls.nvim을 설치합니다.

Plug 'jose-elias-alvarez/null-ls.nvim'

루아 플러그인이 필요합니다.

require("null-ls").setup({
    sources = {
        require("null-ls").builtins.diagnostics.vale,
    },
})

네이티브vim 구성을 사용하는 경우 lua HERE 문서를 사용하세요.

lua << EOF
require("null-ls").setup({
    sources = {
        require("null-ls").builtins.diagnostics.vale,
    },
})
EOF

Make sure you have a .vale.ini or _vale.ini somewhere in $HOME or at the current working directory.

에디터 내 제안은 다음과 같습니다.



보시다시피 일부 제안은 NeoVim에서 올바르게 렌더링되지 않습니다. 이 문제를 해결하려면 trouble.nvim 플러그인을 사용하여 진단용 인터페이스와 같은 멋진 VSCode를 얻을 수 있습니다.



그게 다야, 글쓰기를 즐겨라!