Trivia
Непринципові елементи (Trivia), названа так через свою незначимість
представляє частини початкового тексту, які в значній мірі не мають значення для звичайного розуміння коду. Наприклад, це можуть бути пробіли, коментарі або навіть мітки конфліктів. Trivia не зберігається в AST (щоб залишатися легкими в коді). Однак, її можна отримати при потребі за допомогою кількох ts.*
APIs.
Перш ніж ми покажемо їх, ви повинні зрозуміти наступне:
Власність непринципових елементів (trivia)
Загалом:
Токену належать будь-яка trivia після нього в тому самому рядку до наступного токена.
Будь-який коментар після цього рядка пов'язаний з наступним токеном.
Для початкових і кінцевих коментарів у файлі:
Перший токен у початковому файлі отримує всю початкову trivia.
Остання послідовність trivia у файлі прикріплюється до токена кінця файлу, який в іншому випадку має нульову ширину.
API непринципових елементів (trivia)
Для більшості основних випадків коментарі є "цікавою" trivia. Коментарі, що належать до вузла (Node), можна отримати за допомогою наступних функцій:
ts.getLeadingCommentRanges
Враховуючи вихідний текст і позицію в цьому тексті, повертає діапазони коментарів між першим символом нового рядка після заданої позиції та самим токеном (найімовірніше, найбільш корисно з ts.Node.getFullStart
).
ts.getTrailingCommentRanges
Враховуючи вихідний текст і позицію в цьому тексті, повертає діапазони коментарів до першого символу нового рядка після заданої позиції (найімовірніше, найбільш корисно з ts.Node.getEnd
).
Наприклад, уявіть таку частину вихідний файлу:
getLeadingCommentRanges
для функції
поверне лише останні 2 коментарі //bye
and /*hi*/
.
Відповідно, виклик функції getTrailingCommentRanges
на кінці оператора debugger вилучить коментар /*hello*/
.
Початкова позиція/повна початкова позиція
У вузлів є так звана "початкова позиція токена" (token start) та "повна початкова позиція" (full start).
Початкова позиція токена: це більш природна версія, яка відображає позицію в файлі, з якої починається текст токена.
Повна початкова позиція: це точка, з якої сканер почав сканування з моменту останнього значущого токена.
У вузлів AST є API для getStart
and getFullStart
. У наступному прикладі:
для function
початкова позиція токена знаходиться на слові function
тоді як повна початкова позиція знаходиться на /*hello*/
. Зверніть увагу, що повна початкова позиція навіть включає trivia, які зазвичай належать попередньому вузлу.
Last updated