@comtext/ocr-fix 1.0.2 → 1.1.0

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.
Files changed (3) hide show
  1. package/README.md +40 -4
  2. package/package.json +1 -1
  3. package/src/correct.js +25 -1
package/README.md CHANGED
@@ -4,9 +4,13 @@
4
4
 
5
5
  Post-OCR коррекция текста — набор утилит для исправления артефактов, которые возникают при OCR-распознавании и мешают дальнейшей обработке текста.
6
6
 
7
- ## Что делает функция `correct`
7
+ ## API
8
8
 
9
- Применяет набор исправлений, которые полезны после любого OCR:
9
+ Пакет экспортирует две функции.
10
+
11
+ ### `correct(str)`
12
+
13
+ Корректирует произвольный текст после OCR. Применяет набор исправлений:
10
14
 
11
15
  | # | Исправление | Пример |
12
16
  |---|---|---|
@@ -32,6 +36,32 @@ Post-OCR коррекция текста — набор утилит для ис
32
36
  Воспитание творческой активности учащихся в процессе изучения ими математики является одной из актуальных целей нашего школьного преподавания.
33
37
  ```
34
38
 
39
+ ### `correctComtext(str)`
40
+
41
+ Корректирует файл в формате comtext — Markdown с YAML frontmatter.
42
+
43
+ Если файл начинается с блока `---`, frontmatter сохраняется без изменений.
44
+ К остальной части текста применяется `correct`.
45
+
46
+ ```
47
+ ---
48
+ format: article
49
+ title: Название
50
+ ---
51
+ Текст первой строки
52
+ продолжение текста.
53
+ ```
54
+
55
+ ↓
56
+
57
+ ```
58
+ ---
59
+ format: article
60
+ title: Название
61
+ ---
62
+ Текст первой строки продолжение текста.
63
+ ```
64
+
35
65
  ## Установка
36
66
 
37
67
  ```bash
@@ -41,11 +71,17 @@ yarn add @comtext/ocr-fix
41
71
  ## Использование
42
72
 
43
73
  ```js
44
- import { correct } from '@comtext/ocr-fix'
74
+ import { correct, correctComtext } from '@comtext/ocr-fix'
45
75
 
76
+ // Для произвольного текста
46
77
  const rawOcrText = `Первый абзац\nиз двух строк\n\nВторой абзац`
47
78
  console.log(correct(rawOcrText))
48
79
  // "Первый абзац из двух строк\n\nВторой абзац"
80
+
81
+ // Для comtext-файла с frontmatter
82
+ const comtextFile = `---\nformat: article\n---\nТекст\nпродолжение`
83
+ console.log(correctComtext(comtextFile))
84
+ // "---\nformat: article\n---\nТекст продолжение"
49
85
  ```
50
86
 
51
87
  ## Тесты
@@ -71,7 +107,7 @@ yarn test:coverage
71
107
  ```
72
108
  ocr-fix/
73
109
  ├── src/
74
- │ └── correct.js # основная функция
110
+ │ └── correct.js # correct и correctComtext
75
111
  ├── tests/
76
112
  │ └── correct.test.js # Jest-тесты
77
113
  ├── package.json
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@comtext/ocr-fix",
3
- "version": "1.0.2",
3
+ "version": "1.1.0",
4
4
  "description": "Post-OCR text correction utilities",
5
5
  "type": "module",
6
6
  "main": "src/correct.js",
package/src/correct.js CHANGED
@@ -65,4 +65,28 @@ function correct(str) {
65
65
  return str
66
66
  }
67
67
 
68
- export { correct }
68
+ /**
69
+ * Регулярное выражение для определения frontmatter в начале файла.
70
+ * Совпадает с блоком «---\n...\n---» строго в начале строки.
71
+ */
72
+ const FRONTMATTER_RE = /^---\n[\s\S]*?\n---(\n|$)/
73
+
74
+ /**
75
+ * Корректирует файл в формате comtext (Markdown с YAML frontmatter).
76
+ *
77
+ * Frontmatter — блок между «---» в самом начале файла — сохраняется без изменений.
78
+ * К остальной части текста применяется функция {@link correct}.
79
+ *
80
+ * @param {string} str - Содержимое comtext-файла
81
+ * @returns {string} Скорректированный текст с нетронутым frontmatter
82
+ */
83
+ function correctComtext(str) {
84
+ const fmMatch = str.match(FRONTMATTER_RE)
85
+ if (!fmMatch) return correct(str)
86
+
87
+ const frontmatter = fmMatch[0]
88
+ const body = str.slice(frontmatter.length)
89
+ return frontmatter + correct(body)
90
+ }
91
+
92
+ export { correct, correctComtext }