На какие метрики опираться при проведении рефакторинга?

Question

[Владислав Андреев]

Пишу отчет по практике, которую прохожу в унике, делаем проект на React и нужно написать про пункт "Рефакторинг и внесение исправлений/улучшений".
Я могу в принципе написать, как я там отрефачил код, но по факту я не знаю, как показать результат рефакторинга адекватно, чтобы не быть голословным. Какие метрики я могу стащить с гита и в целом на что я могу обратить внимание, чтобы сделать так сказать срез того, что было и того, что стало после?

Comments

[WbICHA]

Скорость загрузки страницы, скорость работы интерфейса (можешь из профайлера что-то взять), улучшение UX (скажи, что на людях протестировал и по результатам..., можешь даже опросник с оценками сделать, с опросами до и после изменений), и т.д.

[Владислав Андреев]

WbICHA, понял, спасибо.

[Алексей Уколов]

WbICHA, рефакторинг не подразумевает изменение поведения программы, только улучшение качества кода.

[Владислав Андреев]

Алексей Уколов, вот да, по идее это, наверное, никак не отобразить какими то объективными метриками.

[Алексей Уколов]

Владислав Андреев, ну, есть некоторые, типа цикломатической сложности и размера функций.

[Владислав Андреев]

Алексей Уколов, про первое не слышал, почитаю, благодарю.

[WbICHA]

Алексей Уколов, да, но:

пункт "Рефакторинг и внесение исправлений/улучшений".

И скорость работы приложения тоже может улучшится при рефакторинге.

[Алексей Уколов]

WbICHA, действительно, я разучился читать дальше заголовка :)

[Сергей delphinpro]

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

[Егор Живагин]

Именно по качеству кода:
Для webstorm было расширение SonarLint , кажется, оно давало анализ по проекту. Не знаю, что у вас за ide/редактор, но может тоже есть.

Ещё можно погуглить "code smell detection tools"

[Михаил]

погуглите "запахи кода", solid. Для продвинутого уровня, попробуйте тесты для этого кода написать, сразу косяки полезут

Answer 1

[Dhwtj]

Из git (объективное, но только если проект долго живёт уже):
- частота изменений файлов (git log по путям) - находишь проблемные, показываешь что рефакторил именно их
- размер коммитов до/после, размер diff на фичу
- churn: сколько строк переписывалось в файле за период
- среднее число файлов, затронутых одной фичей (после хорошего рефакторинга должно падать)
- bus factor по файлам (кто трогал, если только один то никто больше не разберётся)

Технические метрики (срез до/после):
- LOC и размер компонентов (огромные компоненты разбиты)
- цикломатическая сложность (eslint-plugin-complexity / SonarQube / IDE)
- дублирование (jscpd показывает % copy-paste)
- кол-во props у компонентов, глубина вложенности JSX
- покрытие тестами (jest --coverage)
- bundle size (source-map-explorer, webpack-bundle-analyzer) - но это скорее уже оптимизация, а не рефакторинг
- кол-во ESLint/TS ошибок и any

React-специфика рефакторинга (тут не поручусь, спросил в LLM):
- вынос логики в кастомные хуки
- разделение умных/глупых компонентов
- убрал prop drilling -> context/состояние
- мемоизация где реально нужна
- типизация (JS -> TS, убраны any)