Введение в package.json

package.json в проекте Apache Superset представляет собой файл конфигурации для управления зависимостями и сценариями сборки и разработки.

1. name: Указывает имя пакета (проекта) – «superset».
2. version: Определяет версию пакета – «0.0.0-dev».
3. description: Содержит краткое описание проекта – «Superset is a data exploration platform designed to be visual, intuitive, and interactive.»
4. keywords: Перечисляет ключевые слова, связанные с проектом.
5. homepage: Ссылка на домашнюю страницу проекта.
6. bugs: Содержит информацию о местоположении баг-трекера проекта.
7. repository: Содержит информацию о репозитории проекта, включая тип и URL.
8. license: Указывает лицензию, согласно которой распространяется проект – «Apache-2.0».
9. scripts: Определяет пользовательские команды для сборки, тестирования и других задач разработки.
10. dependencies: Содержит зависимости, необходимые для запуска проекта.
11. devDependencies: Здесь перечислены зависимости, необходимые только для разработки и тестирования.
12. engines: Указывает требуемые версии Node.js и npm для корректной работы проекта.
13. overrides: В этом разделе можно указать, какие зависимости имеют отличные версии для разных частей проекта.
14. scarfSettings: Содержит настройки инструмента Scarf, используемого для анализа использования пакетов в проекте.
15. _id: Внутренний идентификатор пакета.

package.json в Apache Superset важен для управления зависимостями, сборкой, тестированием и другими аспектами разработки UI.

Описание раздела scripts в файле package.json

Этот раздел scripts в файле package.json определяет пользовательские команды, которые можно запустить с помощью npm run в вашем проекте. Вот описание каждой строки:

1. _lint: Этот скрипт использует ESLint для проверки синтаксиса и стиля кода в файлах JavaScript и TypeScript, исключая файлы, указанные в .eslintignore.
2. _prettier: Этот скрипт использует Prettier для форматирования файлов в соответствии с правилами стиля. Он форматирует файлы с расширениями .js, .jsx, .ts, .tsx, .css, .less, .scss, .sass, и также файл package.json.
3. build: Этот скрипт используется для сборки проекта в режиме production с использованием Webpack. Он устанавливает некоторые переменные окружения, чтобы оптимизировать производительность сборки.
4. build-dev: Этот скрипт используется для сборки проекта в режиме development с использованием Webpack.
5. build-instrumented: Этот скрипт также используется для сборки проекта в режиме production, но с активированным инструментированием для сборки.
6. build-storybook: Этот скрипт запускает сборку проекта Storybook.
7. check-translation: Этот скрипт использует Prettier для проверки форматирования файлов перевода в проекте.
8. chromatic: Этот скрипт запускает инструмент Chromatic для тестирования компонентов и их визуализации. Он пропускает изменения в зависимостях, начинающихся с ‘dependabot/’.
9. clean-translation: Этот скрипт использует Prettier для форматирования файлов перевода в проекте.
10. core:cover: Этот скрипт запускает Jest в режиме покрытия кода тестами, с применением заданных порогов покрытия.
11. cover: Этот скрипт также запускает Jest для измерения покрытия кода тестами, но без указания порогов.
12. dev: Этот скрипт запускает Webpack в режиме development с возможностью наблюдения за изменениями файлов.
13. dev-server: Этот скрипт используется для запуска Webpack Dev Server в режиме development.
14. format: Этот скрипт использует Prettier для форматирования файлов и автоматического исправления стилей кода.
15. lint: Этот скрипт объединяет _lint и type, выполняя проверку синтаксиса кода и проверку типов TypeScript.
16. lint-fix: Этот скрипт также объединяет _lint и type, но также исправляет обнаруженные проблемы.
17. plugins:build: Этот скрипт выполняет сборку плагинов с помощью собственного скрипта build.js.
18. plugins:build-assets: Этот скрипт копирует активы для плагинов с использованием скрипта copyAssets.js.
19. plugins:build-storybook: Этот скрипт используется для сборки Storybook внутри плагина superset-ui-demo.
20. plugins:chromatic: Этот скрипт используется для запуска Chromatic внутри плагина superset-ui-demo.
21. plugins:create-conventional-version: Этот скрипт используется для создания новой версии плагинов на основе конвенций и выпуска на GitHub.
22. plugins:create-minor-version: Этот скрипт используется для создания новой минорной версии плагинов.
23. plugins:create-patch-version: Этот скрипт используется для создания новой версии плагинов с исправлениями.
24. plugins:release-conventional: Этот скрипт используется для выпуска плагинов на основе конвенций с публикацией на GitHub.
25. plugins:release-from-tag: Этот скрипт используется для выпуска плагинов из уже существующего тега.
26. plugins:storybook: Этот скрипт запускает Storybook внутри плагина superset-ui-demo.
27. prettier: Этот скрипт используется для форматирования файлов и автоматического исправления стилей кода.
28. prettier-check: Этот скрипт использует Prettier для проверки форматирования файлов, но не вносит изменений.
29. prod: Этот скрипт выполняет сборку проекта в режиме production.
30. prune: Этот скрипт удаляет некоторые файлы и директории, связанные с плагинами.
31. storybook: Этот скрипт запускает Storybook в режиме development.
32. tdd: Этот скрипт запускает Jest в режиме наблюдения за изменениями и автоматического запуска тестов.
33. test: Этот скрипт запускает Jest для выполнения тестов.
34. type: Этот скрипт используется для проверки типов с использованием TypeScript.