vale-llm-slop 스타일셋

이 요약은 AI가 원문을 분석해 생성했습니다. 정확한 내용은 원문 기준으로 확인하세요.

TL;DR

이 레포는 Vale용 스타일셋 vale-llm-slop을 제공해 LLM 에이전트가 생성한 문서에서 은유적 표현·코드 반복 서술·자기칭찬 같은 기계적 어투를 검출하고, ASD-STE100 기반의 STE 규칙을 통해 절차 문서에 엄격한 문장 규율을 추가할 수 있게 설계되었다. 설치는 .vale.ini에 Packages와 BasedOnStyles를 등록하는 방식으로 간단하며, Before→After 예제와 테스트 결과(28개 규칙, 더러운 예제 82개 알림, 깨끗한 예제 0알림)를 통해 규칙 동작을 확인할 수 있다. MIT 라이선스로 공개되어 팀 단위 도입과 경로별 튜닝이 용이하다.

섹션별 상세

레포지토리는 LLM 에이전트가 생성한 문서 품질을 자동으로 개선하려는 목적에서 Vale 스타일셋을 제공한다는 문제 의식에서 출발한다. 설치는 .vale.ini에 StylesPath와 Packages 항목을 추가하는 단순한 입력─설정 과정으로 동작하며, Markdown과 코드 주석을 파일 확장자별로 분리해 서로 다른 규칙집을 적용하도록 구현되어 있다. 예시와 규칙 분류를 포함해 실제 린트 결과를 CI에서 확인하는 흐름을 단순화해 팀 문서의 일관성과 가독성을 높이는 실무적 효과를 노린다.

Slop 규칙은 은유·과장·코드 반복 서술·자기칭찬 같은 기계적·공허한 문장 유형을 탐지하는 데 초점을 둔다. 각 규칙은 패턴 매칭과 문장 구성 검사로 작동하며 README에 Before→After 예제들이 포함되어 있어 규칙이 어느 부분을 어떻게 변환하는지 입력·처리·출력 관점에서 확인할 수 있다. 규칙은 실제 예제에서 총 28개로 집계되어 더러운(규칙을 위반한) 예제에서 82개의 알림을 만들고, 깨끗한 예제에서는 경고가 발생하지 않는 것으로 테스트되어 규칙 커버리지와 오탐 방지를 동시에 고려한 설계를 보여준다.

근거

Slop 규칙은 에이전트가 생성한 문장 특유의 은유적 표현, 코드 반복 서술, 자기칭찬, 과도한 수식어를 탐지한다고 명시되어 있다. — README의 'Slop catches writing that sounds like AI wrote it' 섹션과 Slop.Rule 목록 및 Before→After 예제 참조; 규칙 이름(Slop.Metaphor, Slop.RestatesCode 등)과 예제 비교가 근거임. 출처

STE 규칙은 ASD-STE100 표준을 기반으로 절차 문서의 문장 길이, 수동태 사용, 항목 길이 제한 등 엄격한 형식 규칙을 강제한다. 구현은 Slop을 기반으로 선택 적용하는 방식이며, 마크다운 등 절차 문서에만 추가로 적용하도록 경로 단위로 범위를 좁혀 실무팀이 필요할 때만 엄격 규칙을 켤 수 있게 설계되어 있다. 이 접근은 절차와 런북 같이 오류 허용도가 낮은 문서에서 표준화된 서술을 유지하는 데 기여한다.

근거

STE 규칙은 ASD-STE100 표준을 실무 문서에 적용하기 위해 설계되었고, 절차 문서에만 선택 적용하도록 경로 단위를 권장한다. — README의 'STE is stricter' 설명과 '[docs/procedures/**.md] BasedOnStyles = Slop, STE' 예시를 근거로 함. 출처

레포에는 규칙 위반 예제와 정정 예제가 풍부하게 포함되어 있어 규칙의 동작 메커니즘을 직접 확인할 수 있다. Slop.SelfPraise, Slop.RestatesCode 같은 규칙별 예시는 어떤 서술 패턴이 왜 문제인지, 대체 문장이 어떻게 달라지는지를 원문 전후 비교로 보여준다. 이런 비교는 규칙을 적용했을 때 실제 문서가 어떻게 달라지는지 증거로 제시되므로 스타일 적용 결정 과정에서 판단 비용을 낮춘다.

근거

레포의 테스트는 깨끗한 예제에서 경고가 0이며 더러운 예제에서 82개의 경고가 발생한다고 보고한다. — README의 Tests 섹션에 'Currently 28 rules, 82 alerts on the dirty fixtures, 0 on the clean ones'라는 문구가 명시됨. 출처

작성자는 이 스타일셋을 LLM 에이전트가 생성한 초안과 사람이 읽는 문서 사이의 간극을 줄이기 위한 첫 시도로 정의하며 기여를 환영한다고 밝힌다. 라이선스는 MIT로 공개되어 있어 팀 내 도입이나 포크가 자유로운 구조이며, 스타일 조정은 경로별로 규칙을 끄고 켜는 방식으로 유연하게 가능하다. 결과적으로 이 레포는 LLM 산출물의 문서화를 자동화하는 파이프라인에 통합하기 쉬운 실무용 툴킷 역할을 한다.

용어 해설

Vale 린터(Vale): — Vale는 코드와 문서를 대상으로 스타일 규칙을 적용하는 정적 린터로, 설정 파일(.vale.ini)에 스타일 패키지를 등록해 경고·오류를 출력하며 CI에 통합해 일관된 문서 품질을 유지하는 데 사용된다.
Slop 스타일셋(Slop): — Slop은 에이전트가 생성한 문장에서 기계적인 어투와 공허한 수식어, 코드 반복 설명, 은유적 표현 등을 규칙으로 검출해 보다 인간이 읽기 쉬운 간결한 문장으로 유도하는 Vale 스타일 모음이다.
STE (ASD-STE100 기반)(STE): — STE는 ASD-STE100 표준을 실무 문서에 적용하기 위한 규칙셋으로, 문장 길이·수동태 사용·절차 항목 길이 등을 제한해 절차 문서와 런북에서 오류 여지를 줄이는 데 목적이 있다.
문서 린팅(linting): — 문서 린팅은 코드 린트처럼 문서 용어·문장 구조·스타일 일관성을 자동 검사하는 과정으로, 규칙 파일과 예외 설정을 통해 팀 기준을 CI에서 자동으로 검증할 수 있다.

코드 예제

ini

StylesPath = .vale
MinAlertLevel = warning
Packages = https://github.com/Syntaf/vale-llm-slop/releases/latest/download/vale-llm-slop.zip

[*.{py,cs,ts,tsx,js,go,rs,rb,java,kt,swift,php,c,cpp,h}]
BasedOnStyles = Slop

[*.md]
BasedOnStyles = Slop, STE

예시 .vale.ini 파일은 로컬 경로와 외부 패키지 등록, 파일 확장자별 적용 스타일을 보여준다. 이 설정은 코드 주석과 문서에 Slop 규칙을 기본으로 적용하고 Markdown 파일에는 추가로 STE 규칙을 적용해 절차문서에 엄격한 규율을 더한다. CI에서 Vale를 실행하면 이 설정이 경고 레벨 기준으로 린트 결과를 출력한다.

text

Packages = https://github.com/Syntaf/vale-llm-slop/releases/latest/download/vale-llm-slop.zip

릴리스 ZIP을 Packages로 등록하면 Vale가 해당 스타일셋을 다운로드해 로컬 규칙으로 사용한다. 이 방식은 팀 공유형 스타일을 중앙에서 업데이트하고 모든 개발자가 동일한 규칙을 적용받도록 할 때 유용하다. 릴리스 URL을 고정하면 스타일 변경 이력이 릴리스 단위로 관리된다.

text

[styles/**]
BasedOnStyles = ""

설정 예시는 스타일 자체를 검사 대상에서 제외하는 패턴을 보여주며 스타일 규칙이 다른 스타일 파일에 의해 인용될 때 순환 참조를 방지하는 용도로 사용한다. 린트 전 범위검사에서 false positive를 줄이려는 실무적 적용이다. 프로젝트별 예외를 경로 단위로 관리하면 규칙 조정 범위를 좁힐 수 있다.