alpine

Альпийский.js

Для получения большей информации обратитесь к документации Alpine: Alpine Docs.

Вы можете отправлять обновления в документацию, отправив PR в этот репозиторий. Документы находятся в каталоге /packages/docs .

Оставайтесь здесь для получения информации о взносах.

Ищете документы V2? вот они

Руководство по вкладу:

Быстрый старт

• клонировать этот репозиторий локально
• запустите npm install и npm run build
• Включите файл /packages/alpinejs/dist/cdn.js из тега <script> на веб-странице, и все готово!

Краткий тур

Вы можете установить все с помощью: npm install в корневом каталоге этого репозитория после локального клонирования.

Это репозиторий представляет собой «монорепозиторий», использующий рабочие пространства npm для управления пакетами. Каждый пакет имеет свою собственную папку в каталоге /packages .

Вместо запуска отдельных сборок для каждого пакета все пакеты пакетов обрабатываются одной и той же командой: npm run build

Вот краткий обзор каждого пакета в этом репозитории:

Упаковка	Описание
Альпинейс	Основной репозиторий Alpine со всем ядром Alpine.
крах	Плагин для расширения и свертывания элементов с помощью плавной анимации.
csp	Репозиторий для обеспечения «безопасной CSP» сборки Alpine.
документы	Альпийская документация
сосредоточиться	Плагин, позволяющий управлять фокусом внутри элемента
история	Плагин для привязки данных к параметрам строки запроса с использованием API истории (вероятно, имя изменится)
пересекаться	Плагин для запуска JS-выражений на основе элементов, пересекающихся с областью просмотра.
маска	Плагин для автоматического форматирования поля ввода текста по мере ввода пользователем.
трансформироваться	Плагин для разумного морфинга HTML (например, морфдома) внутри страницы.
сопротивляться	Плагин для сохранения состояния Alpine при загрузке страницы.

Скомпилированные файлы JS (в результате запуска npm run [build/watch] ), которые должны быть включены, например, в тег <script> , хранятся в каталоге packages/[package]/dist каждого пакета.

Каждый пакет должен как минимум иметь: самоинициализируемую сборку «cdn», которую можно включить с помощью атрибута src в теге <script defer> , а также файл module.[esm/cjs].js , используемый для импорта. как модуль JS (cjs для узла, esm для всего остального).

Сборкой Alpine V3 занимается исключительно ESBuild. Вся конфигурация этих сборок хранится в файле scripts/build.js .

Тестирование

В этом репозитории используются два разных инструмента тестирования: Cypress (для интеграционных тестов) и Jest (для модульных тестов).

Все тесты хранятся в папке /tests в /tests/cypress и /tests/jest .

Вы можете запустить их оба из командной строки, используя: npm run test

Если вы хотите только запустить cypress и открыть его пользовательский интерфейс (рекомендуется во время разработки), вы можете запустить: npm run cypress

Если вы хотите запускать только тесты Jest, вы можете запустить npm run jest как обычно и настроить конкретные тесты. Вы можете указать параметры конфигурации командной строки для пересылки команде jest с помощью -- например: npm run jest -- --watch