Структура пакета
В этой статье
В результате создания проекта будет сгенерирована следующая файловая структура:
my_widget
node_modules/ — директория, содержащая исходный код зависимостей проекта, которые указаны в файле package.json в секциях dependencies и devDependencies
package/ — директория с файлами, которые будут добавлены в пакет
en/
changelog.md
doc.md
resources/
Widget.png
ru/
changelog.md
doc.md
manifest.json
src/ — директория с исходным кодом виджета
definition/ — директория с конфигурациями виджета
definition.ts — определение конфигураций виджета
panel.ts — конфигурирование панели настроек виджета
settings.ts — конфигурирование объекта настроек значениями по умолчанию
App.tsx
app.d.ts — декларации модулей, таких как .png, .svg, .module.css
index.css — стили виджета, в файле можно указать глобальные стили
index.tsx — исходный код виджета
.eslintignore — список игнорируемых файлов и папок при проверках eslint
.eslintrc — конфигурация eslint
.gitignore
babel.config.js — конфигурация babel
jest.config.js — конфигурация jest
manifest.json — манифест виджета
package.json — специальный файл, используемый в проектах на платформе Node.js, содержит информацию о проекте и его зависимостях
tsconfig.json — конфигурация для настройки параметров компиляции Typescript в проект
tsconfig.tsbuildinfo
widgetrc.json — конфигурация, которая определяет, как будет собираться и запускаться виджет. Подробнее можно прочитать в документации к @infomaximum/package-cli
yarn.lock
Описанная выше структура — пример структуры, которая генерируется библиотекой @infomaximum/package-cli. Также при необходимости можно структурировать и добавлять дополнительные библиотеки в проект.
Заметка
Чтобы создавать пользовательский интерфейс, необязательно использовать в качестве библиотеки React JS. Интерфейс можно также разрабатывать, используя vanilla JavaScript.
Справочные ресурсы
- Декларации модулей
- Конфигурация eslint
- Конфигурация babel
- Конфигурация jest
- Документация к @infomaximum/package-cli
Была ли статья полезна?
Да
Нет