텍스트 인덱스를 가져와 글 교정하기

최근 문장과 절차서를 쓸 기회가 늘었지만 문장에 문제가 있는지 확인하기는 어렵다.
독자가 있는 이상 읽기 쉬운 문장으로 쓰는 것은 필수적이지만 자기 검사라면 어렵다.
그래서 이번에는 노드다.js의 포장textlint를 사용하여 글을 교정해 보았습니다.
자세히 조사한 결과 textlint를 이용하는 기업이 많고 개인적인 사용도 적극적이었다.
textlint를 사용하는 기업 예

이른바 textlint

원래부터 textlint가 뭔지 설명할 필요가 있었어.
Litt라고 불리는 정적 해석 도구는 자바스크립트 개발을 사용하는 사람들에게 익숙하다.
이번 textlint는 교정규칙을 제공하여 자신의 작품을 포함하여 자유롭게 맞춤형 교정규칙을 제정하여 독자적인 교정규칙을 제정할 수 있다.
Github에도 이렇게 적혀 있다.
The pluggable linting tool for text and markdown.
textlint is similar to ESLint, but it's for use with natural language.
다른 자연 언어도 많은 규칙을 제공했다.

설정 및 사용 방법

textlint를 사용하면 Node입니다.js를 준비해야 하기 때문에 미리 설치하세요.

npm의 초기화 처리

npm init --yes

textlint 설치

npm install textlint

설치에 사용할 규칙

여기에textlint가 사용하고 싶은 규칙에 대한 설치도 함께 진행됩니다.
예를 들어 한 편의 글에서 사용할 수 있는 수량을 검사하는 규칙을 사용하려면 textlint-rule-max-ten 을 설치하십시오.

npm install textlint-rule-max-ten

textlint의 실행

textlint를 실행하려면 npx 명령을 사용하십시오.

npx textlint --rule textlint-rule-max-ten articles/**

실제 오류가 발생했을 때 이런 느낌이 든다.

그러나 규칙이 증가함에 따라 실행 지령에 규칙 이름을 기재해야 하기 때문에 지령이 길어진다.

npx textlint --rule textlint-rule-max-ten textlint-rule-no-dropping-the-ra articles/**

따라서 여러 규칙 검사를 통과하고자 할 때.textlintrc와 같은 설정 파일을 제작하여 명령에서 분리하여 관리할 수 있다.

{
  "rules": {
    "textlint-rule-no-dropping-the-ra": true
  }
}

솔직히 규칙이 많기 때문에 지금도 어느 것이 가장 적절한지 모색하고 있다.

필터 규칙

교정 규칙 외에도 상황에 따라 적용 규칙을 무시하려는 경우도 있다.
그때는 필터 규칙을 이용하는 것이 좋다.

필터 규칙의 설치

npm install textlint-filter-rule-comments

.textlintrc에 Filters 필드 추가

{
  "rules": {
    "textlint-rule-no-dropping-the-ra": true
  },
  "filters": {
    "comments": true
  }
}

다음 설명을 통해 규칙을 변경할 수 있습니다.

<!-- textlint-disable -->
食べれる
<!-- textlint-enable -->
来れる

기타 기능

} 파일의 textlint 유효성

표준 textlint는 > 파일을 지원하지 않기 때문에 다음과 같은 큰 가방를 추가할 수 있습니다.

npm install textlint-plugin-html

{
  "rules": {
    "textlint-rule-no-dropping-the-ra": true
  },
  "filters": {
    "comments": true
  },
  "plugins": [
    "html"
  ]
}

자동 수정

오류가 발생했을 때 발생하는 내용을 수정할 수 있는 규칙도 있다.이 경우 명령에 --fix 옵션을 추가하여 자동으로 수정할 수 있습니다.

VScode의 textlint 활용

VScode를 사용하여 textlint를 실행하는 확장 기능이 있습니다.
VS코드의 시장 광장·확장 기능으로'textlint'를 검색하면 대박이다.

사이트 축소판 그림

공식 사이트
textlint의 규칙 일람
아주 많이...
textlint의 적용 규칙 참조