Участие в разработке

Эта статья предназначена для тех, кто хочет участвовать в данном проекте. Можно участвовать в нескольких аспектах проекта: отправлять демо, поддерживать плагины, поддерживать документацию, отвечать на вопросы группы и т. д. После PR (pull request) в соответствии с правилами группы будет выдан статус администратора группы.

Необходимые знания

Основы Git, HTML и JS, а также как отправить Pull Request на Github.

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

Для участия в разработке плагинов могут потребоваться дополнительные знания:

• npm — менеджер пакетов;
• Webpack — инструмент для сборки;
• использование XLSX.JS.

Как отправить демо?

Содержимое демо может включать конкретные сценарии использования, проблемы, с которыми вы столкнулись во время использования, и способы их решения. Например, оптимизация передачи данных при большом объёме данных или реализация экспорта с индикатором выполнения при большом объёме данных.

В отправляемых файлах не должно быть серверного кода, но можно показывать ключевые фрагменты серверного кода на демонстрационной странице. При возврате данных через AJAX можно использовать формат data.json и другие подобные методы.

После отправки PR можно связаться со мной через группу или по электронной почте. После проверки код будет добавлен в кодовую базу, а информация о нём будет добавлена в документацию.

Как модифицировать плагин?

Ознакомьтесь со структурой каталогов

Файлы в каталоге src являются исходными файлами, основная логика находится в excel.js. Однако только изменения в этом файле не позволят реализовать все функции, поэтому необходимо использовать инструменты сборки для объединения зависимых файлов xlsx.js, jszip.js и FileSaver.js в один файл, который будет размещён в layui_exts/excel.js. Также необходимо создать вспомогательный файл карты (map file) layui_exts/excel.js.map для отладки.

Установите инструменты разработки

Инструмент сборки, используемый для создания плагина, называется webpack. Этот инструмент устанавливается с помощью менеджера пакетов npm. Поэтому сначала необходимо установить npm.

Npm можно установить вместе с Node.js или отдельно.

Более подробную информацию можно найти здесь: https://www.runoob.com/nodejs/nodejs-install-setup.html, https://www.runoob.com/nodejs/nodejs-npm.html.

После установки выполните команду npm install в каталоге проекта для установки зависимостей. Затем выполните команду npm run build для сборки плагина.

$ npm run build

> lay-excel@1.7.1 build D:\phpStudy\WWW\github\lay-excel
> webpack-cli -c webpack.config.js

[webpack-cli] Compilation finished
Hash: d83833bc05117b13358f
Version: webpack 4.0.0
Time: 23089ms
Built at: 2020-11-17 22:11:13
       Asset      Size  Chunks             Chunk Names
    excel.js   585 KiB       0  [emitted]  main
excel.js.map  2.38 MiB       0  [emitted]  main
..........

После завершения разработки выполните команду npm run build, чтобы создать файлы сборки.

Затем отправьте PR на GitHub.

Как изменить документацию?

Текущая документация написана с использованием gitbook. Если изменения незначительны и не требуют предварительного просмотра, можно напрямую редактировать файлы markdown. Если требуется предварительный просмотр документа, необходимо установить инструмент gitbook.

Установка gitbook

Используйте -g для глобальной установки. После установки появится исполняемый скрипт gitbook в глобальном каталоге. Используйте gitbook -V для просмотра информации о версии.

$ npm install gitbook-cli -g
$ gitbook -V
CLI version: 2.3.2
GitBook version: 3.2.3

Примечание: при первом выполнении gitbook -V GitBook будет установлен автоматически. Если нет доступа к сети, время ожидания может быть долгим.

Дополнительные сведения о начале работы с GitBook см. в блоге: https://blog.csdn.net/lu_embedded/article/details/81100704.

Создание документации

Выполните команду npm run build-doc, которая создаст каталог _book. Этот каталог не будет отправлен на git. Откройте index.html в браузере, чтобы просмотреть эффект документа.

$ gitbook.cmd build
info: 7 plugins are installed
info: 6 explicitly listed
info: loading plugin "highlight"... OK
info: loading plugin "search"... OK
info: loading plugin "lunr"... OK
info: loading plugin "sharing"... OK
info: loading plugin "fontsettings"... OK
info: loading plugin "theme-default"... OK
info: found 13 pages
info: found 154 asset files
info: >> generation finished with success in 2.4s !