VSCode에서 textlint를 사용하여 문서 확인
텍스트 링크에 대해서는 다음을 참조하십시오.
(vscode-textlint에서 전역 설정을 사용하는 방법을 잘 모르기 때문에 이번에는 프로젝트에 로컬로 설치된textlint를 사용하기 전의 절차를 살펴봅니다)
vscode-textlint - Visual Studio Marketplace created by @ taichi
설치
VSCode를 열고 Cmd+P(Ctrl+P)에서 명령 팔레트를 열고 확장을 설치하면 됩니다.
ext install vscode-textlint
이번에는 textlint를 설정한 프로젝트를 만드는 곳에서 해보자.
항목 만들기
적절한 디렉토리를 만듭니다.
이번에는
vscode-textlint-example/라는 목록을 만들어 보았다.실제 제작된 자료 라이브러리가 있기 때문에 클론은 아래 명령으로 시도할 수 있습니다.
git clone https://github.com/azu/vscode-textlint-example.git
cd vscode-textlint-example
npm install
vscode .
npm init
textlint는 Node입니다.js로 움직이는 도구니까.
로컬 (프로젝트 디렉터리에 있는 뜻) 을 설치할 때
package.json 의 Node 라고 합니다.js 모듈을 관리하는 파일을 만듭니다.Note:textlint는 Node입니다.js v4 이상이 필요하므로
node -v 버전을 확인하십시오.실행
npm init하면 질문이 많이 들어오기 때문에 Enter를 누르면package.json 만들어집니다.$ npm init
name: (vscode-textlint-example)
version: (1.0.0)
description: VS Codeを使ったtextlint projectのサンプル
entry point: (index.js)
test command:
git repository:
keywords:
license: (MIT)
About to write to /Users/azu/.ghq/github.com/azu/vscode-textlint-example/package.json:
{
"name": "vscode-textlint-example",
"version": "1.0.0",
"description": "VS Codeを使ったtextlint projectのサンプル",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "azu",
"license": "MIT"
}
Is this ok? (yes)
텍스트 링크 설치
로컬 설치 텍스트 링크입니다.
이 일대는 일반적인 textlint 설치와 같다.
이미 각양각색의 환경에서의 설치 방법이 있으니 참고하세요.
따라서 규칙을 설치하는 것도 시도해 본다.
textlint 호스트와 textlint-rule-preset-ja-technical-writing 기술 서적을 위한 규칙 집합을 설치해 보십시오.
설치는 npm의
npm install 명령만 사용하면 됩니다.npm install --save-dev textlint textlint-rule-preset-ja-technical-writing
# devDependenciesとしてインストールする
node_modules/ 라는 디렉토리에 모듈이 설치됩니다.또한
pacakage.json가 업데이트되었고 설치된 모듈추가 일람표이 업데이트되었습니다.텍스트 링크 설정
다음은 textlint가 사용하는 규칙을 설정해 보세요.
textlint의 설정
.textlintrc 이 설정 파일은 사용 규칙을 기술합니다.로컬 설치 시
./node_modules/.bin/textlint 의 textlint 명령도 설치됩니다.textlint --init 명령을 클릭하면 자동으로 설정 파일이 만들어집니다.$ ./node_modules/.bin/textlint --init
# またはnpm binコマンドを使って
$ $(npm bin)/textlint --init
.textlintrc 은 이 프로젝트에 설치된 package.json tetlint 규칙을 자동으로 설명합니다.따라서 여기서 끝내도록 설정합니다.
{
"filters": {},
"rules": {
"preset-ja-technical-writing": true
}
}
VS 코드에서 열기
그런 다음 생성된 항목은 VS 코드에서 열기만 하면 됩니다.
vscode ./
textlint 명령을 사용해도 명령줄에서 같은 오류를 볼 수 있다.$ $(npm bin)/textlint README.md
/Users/azu/.ghq/github.com/azu/vscode-textlint-example/README.md
105:15 error 一文に二回以上利用されている助詞 "に" がみつかりました。 preset-ja-technical-writing/no-doubled-joshi
134:34 error 一文に二回以上利用されている助詞 "が" がみつかりました。 preset-ja-technical-writing/no-doubled-joshi
✖ 2 problems (2 errors, 0 warnings)
오류 자동 수정
나는 Visual Studio Code 쓴 것이
VSCode 라는 것을 알아차렸다.공식 홈페이지를 보면
VS Code 쓰는 것이 맞는 것 같다.글을 쓸 때 이런 맞춤법 오류가 자주 발생하기 때문에 의식해도 피하기 어렵다.
textlint-rule-prh 이 규칙과 사전을 확인해 보세요.
$ npm install --save-dev textlint-rule-prh
사전이라고 하지만 정규 표현식으로 규칙을 쓰는 yml 파일을 만들 뿐입니다.
자세한 내용은 아래 파일을 참조하십시오.
prh.yml라는 파일을 만듭니다. 다음과 같습니다. VSCode 는 VS Code 맞춤법 설정입니다.version: 1
rules:
- expected: VS Code
patterns: VSCode
prh: 公式サイトによるとVS Codeらしい
.textlintrc 로 설정합니다.prh 의 rulePaths 사전 파일의 경로를 지정합니다.{
"filters": {},
"rules": {
"preset-ja-technical-writing": true,
"prh": {
"rulePaths": ["./prh.yml"]
}
}
}
VSCode => VS Code.
자동 수정
vscode-textlint는textlint의
--fix도 지원합니다.오류가 발생한 행에서 Alt + Enter 를 누르면 오류가 자동으로 수정됩니다.
(수정 가능 여부는 규칙에 달려 있지만 prh 사전이면 자동으로 수정할 수 있습니다)
textlint --fix도 자동으로 수정할 수 있다.$ $(npm bin)/textlint --fix README.md
끝내다
vscode-textlint를 사용하면 실시간으로 검사하면서 글을 쓸 수 있습니다.
소개는 안 했지만 설정에서 타자를 설정할 때나 저장할 때 검사할 수 있습니다.
자세한 내용은 README 를 참조하십시오.
Reference
이 문제에 관하여(VSCode에서 textlint를 사용하여 문서 확인), 우리는 이곳에서 더 많은 자료를 발견하고 링크를 클릭하여 보았다 https://qiita.com/azu/items/2c565a38df5ed4c9f4e1텍스트를 자유롭게 공유하거나 복사할 수 있습니다.하지만 이 문서의 URL은 참조 URL로 남겨 두십시오.
우수한 개발자 콘텐츠 발견에 전념
(Collection and Share based on the CC Protocol.)
좋은 웹페이지 즐겨찾기
