hardcodes

hardcodes

Извлечение строк из исходного кода

hardcodes — это утилита для поиска строк, жестко закодированных разработчиками в программах. Она использует модульный токенизатор, который может обрабатывать комментарии, любое количество обратных слешей и практически любой синтаксис.

Да, она предназначена для обработки любого синтаксиса, и следующие языки официально поддерживаются:

ada, applescript, c, c#, c++, coldfusion, golang, haskell, html, java, javascript,
jsp, lua, pascal, perl, php, powershell, python, ruby, scala, sql, swift, xml

Установка

с помощью pip

pip3 install hardcodes

или сборка из исходного кода

git clone https://github.com/s0md3v/hardcodes && cd hardcodes && python3 setup.py install

Документация

hardcodes доступна как в виде библиотеки, так и в виде программы командной строки. Соответствующая документация приведена ниже:

• Для разработчиков
• Для пользователей

Для разработчиков

Пример программы ниже демонстрирует использование библиотеки hardcodes

from hardcodes import search

string = "console.log('hello there')"
result = search(string, lang="common", comments="parse")
print(result)

Output: ['hello there']

Аргументы lang и comments являются необязательными. Их использование описано ниже в разделе документации для пользователей.

Для пользователей

cli.py предоставляет grep-подобный интерфейс командной строки для библиотеки hardcodes. Для использования необходимо сначала установить библиотеку.

Поиск строк в файле

python cli.py /path/to/file.ext

Поиск строк в каталоге рекурсивно

python cli.py -r /path/to/dir

Скрыть пути из вывода

python cli.py -o /path/to/file.ext

Указать язык программирования

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

python cli.py -l 'golang' /path/to/file.go

Указать поведение с комментариями

С опцией -c вы можете указать

• ignore полностью игнорировать комментарии
• parse разбирать комментарии как код
• string добавлять комментарии в список жестко закодированных строк

python cli.py -o /path/to/file.ext