Добавить версию в PDF #182

bkoshelev · 2022-05-08T17:56:16Z

#140

Описание

PR добавляет логику создания PDF на основе уже имеющихся данных из *.mdx файлов.

Данные конвертируются следующим образом: mdx -> md -> pdf

Основная идея была в том, чтобы не менять mdx файлы.

Фичи

Добавлено оглавление
Внутренние ссылки 1-го уровня глубины заменены на якоря
Тесты с вопросами удалены из текста
Аннотации перенесены в конец книги в раздел "Словарь"
В футер сайта добавлена кнопка для скачивания книги в PDF

Что не получилось сделать:

Приложения для просмотра pdf не видят содержание (во многих приложениях есть боковая панель в которой можно выводить Table Of Contents
Внутренние ссылки второго уровня глубины сломаны (например, /lsp/in-real-life)
Нужно описать объект вида [ссылка]: [якорь, ведущий к нужному подразделу книги] и добавить якоря в нужные места
Не работает разрыв страницы

Особенности

Из-за того что remark-плагины отдают только esm-модули, а в next.js падает сборка при установке type: module в -package.json, решено пока что собирать скрипт отдельно с помощью esbuild. (В дальнейшем можно перейти на ts-node, так как он уже поддерживает esm-модули)

Пример получившегося файла:

solid_book.pdf

Скриншоты

Верстка

Структура классов

vercel · 2022-05-08T17:56:21Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated
ota-solid	✅ Ready (Inspect)	Visit Preview	Jun 5, 2022 at 4:21PM (UTC)

…ort type

…js 12

bespoyasov

Офигенно, работает 🥳
Спасибо!

Я попробовал предложить идеи, как можно упростить код генератора. Посмотри, пожалуйста, что думаешь об этом?

Возможно, эти идеи уже приходили в голову, и были причины, чтобы их отмести? Тогда расскажи, пожалуйста, что именно вызвало проблемы — чтобы это сохранилось в истории репозитория. Возможно, это понадобится в будущем.

bespoyasov · 2022-05-09T08:42:15Z

services/BookBuilder/glossary.ts

+    let markdown = ''
+    const keys = Object.keys(glossary.terms).sort()
+
+    keys.forEach((definite) => {


А мы можем сделать ненумерованный список? Будет и семантичнее, шаблон «склейки» будет выглядеть лучше, и результат рендера будет больше похож на список.

Если у PDF какие-то проблемы с отображением списков, то пофиг.

Теперь глоссарий - это unordered list. Также добавил проверку на наличие аббревиатур. Если ни одна не будет найдена, то глоссарий не будет добавлен в книгу.

solid_book.pdf

bespoyasov · 2022-05-13T07:06:43Z

.eslintignore

@@ -1,2 +1,3 @@
 node_modules
 *.d.ts
+services/BookBuilder/*.ts


Мне кажется, лучше подправить линтер, если там есть какие-то ошибки. Потому что этот код мы пишем сами, и с одной стороны у нас полный контроль над ним, а с другой лучше все ограничения автоматизировать.

Ага, пришлось так сделать из-за того что многие зависимости начали использовать конструкцию "import type {}", которая появилась только в TS 3.8.

Тогда лучше дождусь момента, когда будет вмержен PR и тогда эти игноры больше не понадобятся.

bespoyasov · 2022-05-13T07:20:14Z

services/BookBuilder/mdx.ts

@@ -0,0 +1,54 @@
+import { readFileSync } from 'fs'
+
+import { Markdown } from './md'


Кажется, тут есть циклические зависимости? Можно попробовать распилить интерфейс и реализацию, как вариант.

Возможно, стоит подумать в сторону концептуального разделения «работы с файловой системой» и «работой с текстовым содержимым». Тогда можно будет упростить API «сервиса файловой системы», сделав его более универсальным.

Сейчас легко запутаться между “mdx” и “md”, потому что структура и иерархия похожи и реализация во многом повторяется. Разделение, вероятно, может помочь урезать количество кода.

Это же, кстати, может помочь избавиться от чрезмерной детализации в index.ts, где мы руками создаём классы для разделов и подразделов.

Вероятно, может помочь тип данных, в котором будет описываться раздел с соответствующими для него подразделами. (Ну, или если отдаться в пуризм, то два типа, один для работы с FS, другой для работы с данными.)

Отрефакторил код.

Теперь mdx и md наследуются от общего класса.

Теперь мы заранее описываем отдельную структуру-объект, и на ее основе наполняем книгу контентом из .mdx-файлов в отдельной функции.

bespoyasov · 2022-05-13T07:29:03Z

services/BookBuilder/mdxToMd.ts

+// удаляем лишние элементы из markdown
+const changeNode: Test = (el, index, parent) => {
+  if (invalidTypes.includes(el.type)) {
+    // исключаем все не-markdown элементы


Я бы, наверное, комментарии заменил на функции, в названиях которых бы выразил намерение:

function isForbiddenElement(el) { return invalidTypes.includes(el.type) } // ... if (isForibddenElement(el)) { /* ... */ }

ок, заменил на функции

bespoyasov · 2022-05-13T07:30:22Z

services/BookBuilder/mdTree.ts

+  }
+
+  addTableOfContents = (markdown: Markdown) => {
+    const treeRoot4 = unified().use(remarkToc, { heading: 'Содержание' }).runSync(this.parse(markdown))


treeRoot4: почему 4? :–)

убрал, спасибо

services/BookBuilder/mdToPdf.ts

bespoyasov · 2022-05-13T11:10:16Z

Я там, кстати, ещё зависимости обновляю, и это может затронуть глоссарий :–(

bkoshelev · 2022-05-13T11:46:31Z

Я там, кстати, ещё зависимости обновляю, и это может затронуть глоссарий :–(

Судя по коммитам, глоссарий теперь больше не нужен. И контент, на основе которого он собирался будет удален. Хорошо, тогда уберу логику сборки глоссария из PR.

Co-authored-by: Alex <bespoyasov@me.com>

bespoyasov

Офигенно! Спасибо большое, от меня жирный лайк :—)

P.S. Я вмёржил PR с обновлением зависимостей, который блокировал линтер, останется только конфликты порезолвить.

bespoyasov · 2022-06-02T15:52:32Z

services/BookBuilder/markdown.ts

+  }
+}
+
+export abstract class MarkdownTreeMarkdownAdapter {


Единственное только, вероятно, лучше вынести адаптер в отдельный модуль, из-за него сейчас markdown и markdownTree в циклической зависимости друг от друга.

Готово! Оказалось что в eslint не было настроено правило для поиска циклических зависимостей в *.ts-файлах, поэтому я их не видел.

Если нужно, могу добавить это правило в этом или в отдельном PR.

Каеф, спасибо!
Можно в отдельном PR, да.

Я на неделе ещё раз пробегусь по коду, если что-то найду, поправлю и где-то ближе к выходным вмёржу :—)

bespoyasov · 2022-06-09T06:29:33Z

Мёржу! 🎉

bkoshelev · 2022-06-09T07:29:47Z

Ура!

bespoyasov · 2022-06-09T07:45:39Z

Спасибо за помощь и участие ^_^

bkoshelev added 2 commits May 7, 2022 23:23

beta version of book builder

1b84fea

заменил зависимости, разбил скипт на классы и файлы

826f542

vercel bot had a problem deploying to Preview May 8, 2022 17:57 Failure

fix linter errors

fc54286

vercel bot had a problem deploying to Preview May 8, 2022 18:08 Failure

bkoshelev added 2 commits May 8, 2022 21:13

fix build error

60592c0

add no-sandbox flag for puppeteer

941a1f3

vercel bot deployed to Preview May 8, 2022 19:01 View deployment

bespoyasov requested review from bespoyasov and dex157 May 9, 2022 08:35

bespoyasov linked an issue May 9, 2022 that may be closed by this pull request

Создать читабельную версию в PDF #140

Closed

fix ts linter errors

b4de612

vercel bot had a problem deploying to Preview May 12, 2022 12:42 Failure

remove needless files

ecfd77d

vercel bot had a problem deploying to Preview May 12, 2022 12:44 Failure

update yarn.lock

8549e9b

vercel bot had a problem deploying to Preview May 12, 2022 12:48 Failure

bkoshelev added 2 commits May 12, 2022 18:54

добавил в игнор файлы, которые импортируют либы, которые содержат imp…

32e5e40

…ort type

зафиксировал версию puppeteer, так как последняя не поддерживает node…

d1cdf1b

…js 12

vercel bot deployed to Preview May 12, 2022 15:57 View deployment

bespoyasov reviewed May 13, 2022

View reviewed changes

Update services/BookBuilder/mdToPdf.ts

d4f3af3

Co-authored-by: Alex <bespoyasov@me.com>

vercel bot deployed to Preview May 13, 2022 11:55 View deployment

bkoshelev added 3 commits May 30, 2022 21:19

convert glossary to unordered list

a0f3b71

convert conditions into functions

4c808cd

update abstraction layers

204232f

vercel bot deployed to Preview May 31, 2022 12:50 View deployment

bespoyasov approved these changes Jun 2, 2022

View reviewed changes

bkoshelev added 2 commits June 5, 2022 15:29

Merge branch 'master' into pdf_book

f297303

fix PR after dependencies refresh

0d6d471

vercel bot had a problem deploying to Preview June 5, 2022 12:37 Failure

bkoshelev added 2 commits June 5, 2022 16:15

remove dependency cycle

81e9948

fix ts linter errors

a7ee749

vercel bot deployed to Preview June 5, 2022 15:23 View deployment

add new line at the end of file

410d1cd

vercel bot deployed to Preview June 5, 2022 15:59 View deployment

remove unused packages

93cc901

vercel bot deployed to Preview June 5, 2022 16:21 View deployment

bespoyasov merged commit 3746c69 into bespoyasov:master Jun 9, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Добавить версию в PDF #182

Добавить версию в PDF #182

bkoshelev commented May 8, 2022

vercel bot commented May 8, 2022 •

edited

Loading

bespoyasov left a comment

bespoyasov May 9, 2022

bespoyasov May 13, 2022

bkoshelev May 31, 2022

bespoyasov May 13, 2022

bkoshelev May 13, 2022

bespoyasov May 13, 2022

bespoyasov May 13, 2022

bkoshelev May 31, 2022

bespoyasov May 13, 2022

bkoshelev May 31, 2022

bespoyasov May 13, 2022

bkoshelev May 31, 2022

bespoyasov commented May 13, 2022

bkoshelev commented May 13, 2022

bespoyasov left a comment •

edited

Loading

bespoyasov Jun 2, 2022

bkoshelev Jun 6, 2022

bespoyasov Jun 6, 2022

bespoyasov commented Jun 9, 2022

bkoshelev commented Jun 9, 2022

bespoyasov commented Jun 9, 2022

		@@ -0,0 +1,54 @@
		import { readFileSync } from 'fs'

		import { Markdown } from './md'

Добавить версию в PDF #182

Добавить версию в PDF #182

Conversation

bkoshelev commented May 8, 2022

Описание

Фичи

Что не получилось сделать:

Особенности

Пример получившегося файла:

Скриншоты

Верстка

Структура классов

vercel bot commented May 8, 2022 • edited Loading

bespoyasov left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bespoyasov commented May 13, 2022

bkoshelev commented May 13, 2022

bespoyasov left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bespoyasov commented Jun 9, 2022

bkoshelev commented Jun 9, 2022

bespoyasov commented Jun 9, 2022

vercel bot commented May 8, 2022 •

edited

Loading

bespoyasov left a comment •

edited

Loading