Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Рефакторит toc-text-crop.js #1041

Closed
wants to merge 17 commits into from

Conversation

Inventoris
Copy link
Member

Привет!

Предлагаю чуть-чуть протюнить прекрасную функцию clipContent. Два главных апгрейда:

  1. Функция изначально работает с длиной строк. Причём основную длину занимают пробелы. На мой взгляд, это не очень надежно, потому что если количество пробелов изменится, то и длина предложения тоже изменится, а значит оно будет обрезаться в другом месте.

Решение:

Считать сразу слова, а не символы. Выбрал максимум в 10 слов.

  1. На мой взгляд, второй итератор в лице for лишний. С массивом stringArray уже сразу можно работать, а сейчас создаётся дополнительная конструкция-строка tmpString, с которой и происходят главные манипуляции.

Решение:

Убрать лишний цикл. Сократил файл на 7 строк.

@solarrust
Copy link
Member

solarrust commented Nov 18, 2022

Круто! Спасибо за оптимизацию! А что будет, если фраза будет что-то вроде «Фильдеперсовый Константинопольский шпалоукладчик звукоизвлекает сложносочинённые турбопропизоляционные ноктюрны»? Кажется, в этом случае в боковом меню будет слишком много текста и он даже может вывалиться за пределы контейнера. Смысл работы с символами был именно в том, чтобы контролировать длину подзаголовка без оглядки на длину слов.

@Inventoris
Copy link
Member Author

Получится как-то так:

image

Но если серьезно, интернет говорит, что средняя длина слова в русском языке до 8-9 букв (деловая и научная литература). Я ради интереса вбил все вопросы из этого пиара и посчитал среднюю длину слова:

image

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

  1. Оставить всё как есть;
  2. Добавить какую-то проверку к моему варианту, что если человек вбил слова со средней длинной в 14 букв, то немедленно прикрепить ему значок «словесный ловелас», а заодно укоротить предложение на несколько слов. Но не уверен, что тогда имеет смысл текущее сокращение кода;
  3. Закрыть этот пиар.

@Inventoris
Copy link
Member Author

Inventoris commented Nov 19, 2022

Если важно считать именно символы, может, такой вариант имеет место быть?

image

То есть мы делаем массив и в цикле удаляем слова, пока длина не придёт в норму.

Плюс по сравнению с текущим вариантом в том, что мы используем очищенные от лишних пробелов данные, ну и если вдруг появятся турбопропизоляционные ноктюрны, то они не займут всё место. И на одну проверку с if меньше.

Минус в том, что второго цикла избежать не удаётся.

@solarrust
Copy link
Member

Привет!
Интересная задачка, конечно =)

Мне нравится вариант с подсчётом символов, предлагаю на нём и остановиться.
Не стоит переживать по поводу второго цикла. Вся работа происходит на этапе сборки, а не на клиенте. Поэтому можно особо не экономить ресурсы.

А давай ещё напишем тест на всё это? У нас новый тренд на 100% покрытие платформы тестами. Надо с чего-то начинать.
Тут может помочь советом @HellSquirrel .

@Inventoris
Copy link
Member Author

Тест сделаю с удовольствием)

@Inventoris
Copy link
Member Author

Inventoris commented Nov 28, 2022

Добавил тест, но возникла небольшая проблема.

Чтобы проверить, как функция работает с DOM, добавил jsdom.
Чтобы jsdom работал, пришлось добавить полифилы и окружение
Чтобы окружение на TS заработало, пришлось добавить ts-jest , настроить конфиг jest и добавить jest.setup.ts

После этого всё работает, но смущает, норм ли такая история в рамках Доки вообще?) Не намудрил ли я лишнего?

Обсуждение, почему для jsdom нужно столько манипуляций: inrupt/solid-client-authn-js#1676

@Inventoris
Copy link
Member Author

Кажется, так должно быть лучше.

Copy link
Member

@HellSquirrel HellSquirrel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Что касается правильного алгоритма... Может мы просто обрежем регуляркой максимум сколько-нибудь символов и потом то что получилось обрежем еще до первого пробела?

* @jest-environment jsdom
*/

const { JSDOM } = require('jsdom')
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Я думаю добавить jsdom хорошая идея. Но раз уж мы его добавляем, давай делать это везде.
Давай перенесем это в jest.setup.js ?

@Inventoris
Copy link
Member Author

Да, печальная картина.

Моя ветка безнадежно отстала от темпов современного мира, но скромная попытка ее обновить привела к неожиданному приклеиванию свежих комитов и дублированию моих.

Похоже, единственный путь для странника — начать всё по новой. Пересоздам заново?

@Inventoris Inventoris closed this Nov 30, 2022
@Inventoris Inventoris deleted the toc-text-crop/refactor branch November 30, 2022 18:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants