string is

String-is

String.is-это инструментарий для разработчиков с открытым исходным кодом для разработчиков. Вы можете увидеть это в действии здесь.

string.is - это фактический инструмент преобразования со следующими целями:

• Это должен быть открытый исходный конец.
• Он не должен устанавливать файлы cookie.
• Он должен иметь строгую политику безопасности контента.
• Это должно быть чрезвычайно самоуверенным в отношении зависимости и использовать только хорошо известные, хорошо поддерживаемые библиотеки.
• Он должен попытаться обнаружить формат ввода и разумно выбрать параметры вывода.

Поддержка браузера

Строка. Internet Explorer не поддерживается.

Бег на местном уровне

Установить зависимости:

yarn install

Установите Git Hooks:

yarn husky install

Запустите сервер разработки:

yarn dev

... а затем откройте http: // localhost: 3000 в вашем браузере.

Чтобы запустить все проверки на линии, тип проверки, тесты и сборка для производства:

yarn all

Бег с докером

Создайте изображение Docker:

yarn docker-build

или

docker build -t string-is .

... а потом запустите:

yarn docker-run

или

docker run -p 3000:3000 string-is

В качестве альтернативы вы можете построить и запустить его с помощью docker-compose :

docker-compose up

... или даже запустить его прямо из Docker Hub:

docker run -p 3000:3000 daveperrett/string-is:latest

В настоящее время поддерживаются платформы linux/arm64 и linux/amd64 .

Добавление нового преобразователя

Папка src/lib содержит большую часть логики преобразования и является чистой типовой, без реагирования.

• src/lib/identities содержит идентификаторы , которые принимают входную строку и возвращают уровень доверия, который вход находится в определенном формате. Например, JwtIdentifier возвращает число, указывающее уровень доверия (от 0 до 100), что данная входная строка является токеном JWT.
• src/lib/inputs содержат анализаторы, которые загружают строки из разных форматов. Например, JsonInput анализирует строку JSON и возвращает объект.
• src/lib/outputs принимают анализируемые данные и форматируют их в конкретный выходной формат. Например, JavaScriptOutput принимает строку JavaScript, форматирует ее в соответствии с предоставленными параметрами форматирования и возвращает результат.
• src/lib/converters являются входными → выходными парами - клей, который выполняет преобразование между форматами. Например, CsvToJsonConverter принимает строку CSV в качестве ввода, подает ее в CsvInput для анализа и придает результат в JsonOutput для форматирования.

Чтобы добавить новый конвертер:

1. Решите, из каких форматов вы конвертируете и к . Например, давайте притворимся, что вы пишете конвертер из простого текста в обратный текст.
2. Убедитесь, что существует identity (при SRC/Lib/Identities) для формата . В этом случае мы конвертируем из простого текста, и у нас уже есть простые идентичность, поэтому нам не нужно добавлять новую личность. identity должна экспортировать (a) confidence функцию, которая, учитывая входную строку, возвращает число из 100, описывающая уверенность, что заданный вход соответствует идентичности, и (b) массив converters , с которыми может использоваться идентичность.
3. Если вы добавили новую identity на шаге (2), обязательно экспортируйте ее в SRC/Lib/Identities/Index.ts.
4. Убедитесь, что есть output (под SRC/LIB/выходы) для формата . Выход должен экспортировать output функцию, которая, учитывая входную строку (или, возможно, объект, в зависимости от возникающей преобразования) и объекта options , будет преобразовать вход в нужную выходную строку.
5. Если вы добавили новый output на шаге (4), обязательно экспортируйте его в SRC/Lib/upputs/index.ts.
6. Добавьте новый converter (под SRC/Lib/Converters) для пары input + output . Преобразователь должен экспортировать (a) функцию operation , которая передает входную строку и объект options в соответствующий output , и (b) outputId , которая определяет, какой вывод используется.
7. Если вы добавили новый converter на шаге (6), обязательно экспортируйте его в SRC/Lib/Converters/index.ts. Также обязательно добавьте записи в Locales/en/pages-converter.json], чтобы на целевой странице с генегенерированной автоматической точкой будет правильный заголовок, вступительный текст и пример.
8. Если вы определили новый outputId на шаге (6), добавьте выходной компонент React (в рамках SRC/Components/Domain/Convert/Выходы), чтобы отобразить новый вид вывода. Если вы повторно используете существующий вид вывода (например, преобразование в JSON или YAML), вы можете повторно использовать существующий выходной компонент здесь.
9. Если вы добавили новый компонент React на шаге (8), обязательно экспортируйте его в SRC/Components/Domain/Confert/

Если соответствующие inputs , outputs , converters и компоненты реагирования находятся правильно и экспортируются, вы должны иметь возможность использовать свой новый преобразователь, учитывая соответствующую входную строку, которая запускает ненулевую confidence .

Развертывание

Если вы хотите быть на 100% уверенным в том, что ваша конфиденциальность защищена, вы можете легко настроить экземпляр строки. IS для вашего личного или организационного использования.

Самый быстрый способ развертывания строки. Ознакомьтесь с их документацией по развертыванию следующей.js для получения более подробной информации. Нажмите кнопку Deploy ниже», чтобы развернуть это приложение с Vercel:

NetLify и Heroku также являются хорошими вариантами бесплатного хостинга. Нажмите кнопку Deploy ниже, чтобы развернуть это приложение с Heroku:

К сожалению, string.is в настоящее время не поддерживает статические сборки через next export (который позволит хостинг на EG. S3), потому что функция i18n , которую он использует, в настоящее время не поддерживается для статических сборков.

Развернуть String.is под подключением домена

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

Например, если вы развертываете на https://tools.example.com/string-is , вам нужно установить NEXT_PUBLIC_BASE_PATH на /string-is . Вам не нужно устанавливать эту переменную, если вы развернете в корне домена.

Стройте и бегите с Docker:

docker build -t string-is --build-arg NEXT_PUBLIC_BASE_PATH= " /string-is " .
docker run -p 3000:3000 string-is

Или построить и бежать с помощью docker-compose :

 export NEXT_PUBLIC_BASE_PATH= " /string-is "
docker-compose up --build

Локализация

String.is поддерживает полную локализацию. Новые языки должны быть добавлены в locales/ папки в формате JSON (см. locales/en/ для примера). Английский в настоящее время является единственным предоставленным местом, но приветствуется поддержка новых языков.

Аналитика

String.is включает в себя поддержку правдоподобной аналитики, услуги по конфиденциальности, без конфиденциальности, без печенья. Чтобы включить это, установите переменную среды, указывающую домен:

 NEXT_PUBLIC_ANALYTICS_DOMAIN=string.is

Аналитика отключена по умолчанию, если только process.env.NODE_ENV === 'production' и установлен домен NEXT_PUBLIC_ANALYTICS_DOMAIN .

Внося

Как только вы внесете свои изменения:

1. Вилка String-IS
2. Создать тему филиала- git checkout -b feature/add-my-new-converter
3. Нажмите к вашей ветви- git push origin feature/add-my-new-converter
4. Создайте запрос на вытягивание из вашего филиала
5. Вот и все!

Автор

@davemetrics

Лицензирование

Смотрите лицензию для деталей.