@fxri/toolkit 1.13.1 → 1.14.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.cts CHANGED
@@ -165,6 +165,37 @@ declare function localDate(): string;
165
165
  declare function formatChangelog(file: string, today: string, lang: ChangelogLanguage, redact?: boolean, history?: boolean): boolean;
166
166
  declare function formatChangelogs(dir: string, today: string, lang: ChangelogLanguage, redact?: boolean, history?: boolean): string[];
167
167
 
168
+ interface DocOptions {
169
+ source: string;
170
+ target: string;
171
+ title: string;
172
+ outline: string;
173
+ frontmatter: boolean;
174
+ note: string;
175
+ }
176
+ interface DocCliOptions {
177
+ from?: string;
178
+ to?: string;
179
+ title?: string;
180
+ outline?: string;
181
+ frontmatter?: boolean;
182
+ lang?: string;
183
+ }
184
+ interface DocCheckResult {
185
+ ok: boolean;
186
+ line?: number;
187
+ expected?: string;
188
+ actual?: string;
189
+ }
190
+ declare function buildDocPage(changelog: string, options?: Partial<DocOptions>): string;
191
+ declare function syncDoc(options: DocOptions): {
192
+ changed: boolean;
193
+ content: string;
194
+ };
195
+ declare function checkDoc(options: DocOptions): DocCheckResult;
196
+ declare function syncDocAfterVersion(lang?: string): void;
197
+ declare function resolveDocOptions(cli?: DocCliOptions): DocOptions;
198
+
168
199
  declare function redactText(text: string, enabled: boolean): string;
169
200
 
170
201
  declare function parseBool(value: string, fallback: boolean): boolean;
@@ -174,4 +205,4 @@ declare function getConfigSection(name: string): Record<string, unknown> | undef
174
205
  declare function loadToolkitConfig(startDir?: string): Record<string, unknown> | null;
175
206
  declare function resetToolkitConfigCache(): void;
176
207
 
177
- export { ALL_STATUSES, type ArchiveBlock, type ArchiveOptions, type ArchiveResult, type ChangelogLanguage, type CheckIssue, type CheckResult, DEFAULT_LANG, DONE_STATUSES, FRONTMATTER_KEYS, type ImportOptions, type ImportResult, type ImportTarget, type IssueLevel, LEGACY_TITLE_SLOTS, type LangResolution, type LanguageGroup, type LanguageMap, type NormalizeIssue, type NormalizeResult, SLOT_PREFIXES, type SemanticSlot, type Task, type TaskFilter, type TaskFrontmatter, type TaskRow, type TaskStatus, type TaskSummary, type TaskView, archiveTasks, buildSummary, checkArchive, collectChangelogs, dateFromFileName, exportTasks, fixArchive, formatChangelog, formatChangelogs, getConfigSection, importTasks, languages, listActiveTasks, listArchivedTasks, listTaskFiles, listTasks, loadToolkitConfig, localDate, normalizeCompleted, orderRows, parseArchiveTasks, parseBool, parseFrontmatter, printTaskBoard, printTasks, queryTasks, redactText, resetToolkitConfigCache, resolveEnabled, resolveLang, stripFrontmatter, toCSV, toJSON, validateTaskFile, validateTasks };
208
+ export { ALL_STATUSES, type ArchiveBlock, type ArchiveOptions, type ArchiveResult, type ChangelogLanguage, type CheckIssue, type CheckResult, DEFAULT_LANG, DONE_STATUSES, type DocCheckResult, type DocCliOptions, type DocOptions, FRONTMATTER_KEYS, type ImportOptions, type ImportResult, type ImportTarget, type IssueLevel, LEGACY_TITLE_SLOTS, type LangResolution, type LanguageGroup, type LanguageMap, type NormalizeIssue, type NormalizeResult, SLOT_PREFIXES, type SemanticSlot, type Task, type TaskFilter, type TaskFrontmatter, type TaskRow, type TaskStatus, type TaskSummary, type TaskView, archiveTasks, buildDocPage, buildSummary, checkArchive, checkDoc, collectChangelogs, dateFromFileName, exportTasks, fixArchive, formatChangelog, formatChangelogs, getConfigSection, importTasks, languages, listActiveTasks, listArchivedTasks, listTaskFiles, listTasks, loadToolkitConfig, localDate, normalizeCompleted, orderRows, parseArchiveTasks, parseBool, parseFrontmatter, printTaskBoard, printTasks, queryTasks, redactText, resetToolkitConfigCache, resolveDocOptions, resolveEnabled, resolveLang, stripFrontmatter, syncDoc, syncDocAfterVersion, toCSV, toJSON, validateTaskFile, validateTasks };
package/dist/index.d.ts CHANGED
@@ -165,6 +165,37 @@ declare function localDate(): string;
165
165
  declare function formatChangelog(file: string, today: string, lang: ChangelogLanguage, redact?: boolean, history?: boolean): boolean;
166
166
  declare function formatChangelogs(dir: string, today: string, lang: ChangelogLanguage, redact?: boolean, history?: boolean): string[];
167
167
 
168
+ interface DocOptions {
169
+ source: string;
170
+ target: string;
171
+ title: string;
172
+ outline: string;
173
+ frontmatter: boolean;
174
+ note: string;
175
+ }
176
+ interface DocCliOptions {
177
+ from?: string;
178
+ to?: string;
179
+ title?: string;
180
+ outline?: string;
181
+ frontmatter?: boolean;
182
+ lang?: string;
183
+ }
184
+ interface DocCheckResult {
185
+ ok: boolean;
186
+ line?: number;
187
+ expected?: string;
188
+ actual?: string;
189
+ }
190
+ declare function buildDocPage(changelog: string, options?: Partial<DocOptions>): string;
191
+ declare function syncDoc(options: DocOptions): {
192
+ changed: boolean;
193
+ content: string;
194
+ };
195
+ declare function checkDoc(options: DocOptions): DocCheckResult;
196
+ declare function syncDocAfterVersion(lang?: string): void;
197
+ declare function resolveDocOptions(cli?: DocCliOptions): DocOptions;
198
+
168
199
  declare function redactText(text: string, enabled: boolean): string;
169
200
 
170
201
  declare function parseBool(value: string, fallback: boolean): boolean;
@@ -174,4 +205,4 @@ declare function getConfigSection(name: string): Record<string, unknown> | undef
174
205
  declare function loadToolkitConfig(startDir?: string): Record<string, unknown> | null;
175
206
  declare function resetToolkitConfigCache(): void;
176
207
 
177
- export { ALL_STATUSES, type ArchiveBlock, type ArchiveOptions, type ArchiveResult, type ChangelogLanguage, type CheckIssue, type CheckResult, DEFAULT_LANG, DONE_STATUSES, FRONTMATTER_KEYS, type ImportOptions, type ImportResult, type ImportTarget, type IssueLevel, LEGACY_TITLE_SLOTS, type LangResolution, type LanguageGroup, type LanguageMap, type NormalizeIssue, type NormalizeResult, SLOT_PREFIXES, type SemanticSlot, type Task, type TaskFilter, type TaskFrontmatter, type TaskRow, type TaskStatus, type TaskSummary, type TaskView, archiveTasks, buildSummary, checkArchive, collectChangelogs, dateFromFileName, exportTasks, fixArchive, formatChangelog, formatChangelogs, getConfigSection, importTasks, languages, listActiveTasks, listArchivedTasks, listTaskFiles, listTasks, loadToolkitConfig, localDate, normalizeCompleted, orderRows, parseArchiveTasks, parseBool, parseFrontmatter, printTaskBoard, printTasks, queryTasks, redactText, resetToolkitConfigCache, resolveEnabled, resolveLang, stripFrontmatter, toCSV, toJSON, validateTaskFile, validateTasks };
208
+ export { ALL_STATUSES, type ArchiveBlock, type ArchiveOptions, type ArchiveResult, type ChangelogLanguage, type CheckIssue, type CheckResult, DEFAULT_LANG, DONE_STATUSES, type DocCheckResult, type DocCliOptions, type DocOptions, FRONTMATTER_KEYS, type ImportOptions, type ImportResult, type ImportTarget, type IssueLevel, LEGACY_TITLE_SLOTS, type LangResolution, type LanguageGroup, type LanguageMap, type NormalizeIssue, type NormalizeResult, SLOT_PREFIXES, type SemanticSlot, type Task, type TaskFilter, type TaskFrontmatter, type TaskRow, type TaskStatus, type TaskSummary, type TaskView, archiveTasks, buildDocPage, buildSummary, checkArchive, checkDoc, collectChangelogs, dateFromFileName, exportTasks, fixArchive, formatChangelog, formatChangelogs, getConfigSection, importTasks, languages, listActiveTasks, listArchivedTasks, listTaskFiles, listTasks, loadToolkitConfig, localDate, normalizeCompleted, orderRows, parseArchiveTasks, parseBool, parseFrontmatter, printTaskBoard, printTasks, queryTasks, redactText, resetToolkitConfigCache, resolveDocOptions, resolveEnabled, resolveLang, stripFrontmatter, syncDoc, syncDocAfterVersion, toCSV, toJSON, validateTaskFile, validateTasks };