export

type File struct {
	// Rel은 번들 안에서의 상대 슬래시 경로다. 파일명에 치환이 적용된 뒤의
	// 이름이며 디렉토리 구조는 위키 그대로다.
	Rel string
	// Source는 위키 안에서의 원본 상대 경로다. 안내와 충돌 보고에 쓴다.
	Source string
	// Content는 치환을 마친 파일 전체다. 프론트매터를 포함한다.
	Content string
}

type Hit struct {
	Rule  Rule
	Count int
}

type Options struct {
	// IncludeArchive는 archive 문서도 반출할지 정한다.
	IncludeArchive bool
	// IncludeInternal은 sensitivity 가 internal 인 문서도 반출할지
	// 정한다. 기본은 거짓이다. 파일이 기계 밖으로 나가므로 기본이 전체
	// 노출이면 사고가 난다(ADR 0063).
	IncludeInternal bool
	// Slugs는 반출할 문서를 좁힌다. 비면 노출 규칙을 지난 전부다.
	// 링크를 따라가지 않는다. 지목한 것만 나간다.
	Slugs []string
	// Rules는 익명화 치환 규칙이다. 비면 치환하지 않는다.
	Rules []Rule
}

type Result struct {
	// Files는 번들에 들어갈 파일이다. 위키 순회 순서를 따르므로 경로순이다.
	Files []File
	// Exposure는 노출 규칙이 무엇을 걸렀는지의 집계다.
	Exposure expose.Exposure
	// ExcludedByFilter는 노출 규칙은 지났으나 명시 슬러그에 들지 않아
	// 빠진 문서 수다. 슬러그를 주지 않았으면 0이다.
	ExcludedByFilter int
	// Hits는 규칙별 치환 건수다. Options.Rules 의 적용 순서와 같다.
	Hits []Hit
	// DanglingLinks는 번들 밖을 가리키는 위키링크 수다. 본문을 고치지
	// 않으므로 링크는 그대로 나간다. 수만 알린다(ADR 0046).
	DanglingLinks int
	// DanglingSlugs는 그 링크들이 가리키는 슬러그다. 중복 없이 사전순이다.
	DanglingSlugs []string
}

type Rule struct {
	From string
	To   string
}