@scandipwa/magento-scripts 2.0.3 → 2.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (347) hide show
  1. package/.eslintrc +6 -1
  2. package/exec.js +75 -39
  3. package/index.js +87 -46
  4. package/lib/commands/cleanup.js +18 -21
  5. package/lib/commands/cli.js +138 -73
  6. package/lib/commands/execute.js +5 -5
  7. package/lib/commands/import-db.js +21 -24
  8. package/lib/commands/link.js +17 -20
  9. package/lib/commands/logs.js +91 -91
  10. package/lib/commands/start.js +229 -191
  11. package/lib/commands/status.js +64 -50
  12. package/lib/commands/stop.js +14 -11
  13. package/lib/config/check-configuration-file.js +33 -28
  14. package/lib/config/cma-config.js +4 -4
  15. package/lib/config/config.js +40 -18
  16. package/lib/config/dependencies-for-platforms.js +33 -3
  17. package/lib/config/docker.js +259 -157
  18. package/lib/config/get-magento-version-config.js +45 -38
  19. package/lib/config/get-port-config.js +30 -44
  20. package/lib/config/get-project-configuration.js +8 -8
  21. package/lib/config/index.js +51 -42
  22. package/lib/config/magento/required-php-extensions/index.js +33 -19
  23. package/lib/config/magento/required-php-extensions/magento-2.3.js +2 -2
  24. package/lib/config/magento/required-php-extensions/magento-2.4.js +2 -2
  25. package/lib/config/magento-config.js +4 -4
  26. package/lib/config/php-config.js +8 -6
  27. package/lib/config/port-config.js +62 -43
  28. package/lib/config/save-config.js +6 -6
  29. package/lib/config/scandipwa-versions.js +2 -2
  30. package/lib/config/services/composer/versions/composer-1.js +2 -2
  31. package/lib/config/services/composer/versions/composer-2.js +2 -2
  32. package/lib/config/services/composer/versions/index.js +1 -1
  33. package/lib/config/services/elasticsearch/base-repo.js +1 -1
  34. package/lib/config/services/elasticsearch/default-es-env.js +4 -1
  35. package/lib/config/services/elasticsearch/versions/elasticsearch-6.8.js +17 -14
  36. package/lib/config/services/elasticsearch/versions/elasticsearch-7.10.js +4 -4
  37. package/lib/config/services/elasticsearch/versions/elasticsearch-7.12.js +4 -4
  38. package/lib/config/services/elasticsearch/versions/elasticsearch-7.16.js +4 -4
  39. package/lib/config/services/elasticsearch/versions/elasticsearch-7.17.js +4 -4
  40. package/lib/config/services/elasticsearch/versions/elasticsearch-7.6.js +4 -4
  41. package/lib/config/services/elasticsearch/versions/elasticsearch-7.7.js +4 -4
  42. package/lib/config/services/elasticsearch/versions/elasticsearch-7.9.js +4 -4
  43. package/lib/config/services/elasticsearch/versions/index.js +9 -9
  44. package/lib/config/services/maildev/index.js +5 -2
  45. package/lib/config/services/mariadb/versions/index.js +1 -1
  46. package/lib/config/services/mariadb/versions/mariadb-10.2.js +3 -3
  47. package/lib/config/services/mariadb/versions/mariadb-10.3.js +3 -3
  48. package/lib/config/services/mariadb/versions/mariadb-10.4.js +3 -3
  49. package/lib/config/services/nginx/versions/index.js +1 -1
  50. package/lib/config/services/nginx/versions/nginx-1.18.js +5 -4
  51. package/lib/config/services/php/base-repo.js +1 -1
  52. package/lib/config/services/php/extensions/apcu.js +3 -3
  53. package/lib/config/services/php/extensions/bcmath.js +2 -2
  54. package/lib/config/services/php/extensions/curl.js +3 -6
  55. package/lib/config/services/php/extensions/gd.js +4 -3
  56. package/lib/config/services/php/extensions/index.js +9 -8
  57. package/lib/config/services/php/extensions/intl.js +3 -5
  58. package/lib/config/services/php/extensions/opcache.js +3 -5
  59. package/lib/config/services/php/extensions/pdo_mysql.js +2 -2
  60. package/lib/config/services/php/extensions/soap.js +3 -5
  61. package/lib/config/services/php/extensions/sodium.js +3 -5
  62. package/lib/config/services/php/extensions/xdebug.js +5 -3
  63. package/lib/config/services/php/extensions/xsl.js +3 -5
  64. package/lib/config/services/php/extensions/zip.js +3 -5
  65. package/lib/config/services/php/versions/index.js +1 -1
  66. package/lib/config/services/php/versions/php-7.2.js +13 -9
  67. package/lib/config/services/php/versions/php-7.3.js +13 -9
  68. package/lib/config/services/php/versions/php-7.4.js +13 -9
  69. package/lib/config/services/php/versions/php-8.1.js +13 -9
  70. package/lib/config/services/redis/index.js +1 -1
  71. package/lib/config/services/redis/redis-5.0.js +2 -2
  72. package/lib/config/services/redis/redis-6.0.js +2 -2
  73. package/lib/config/services/redis/redis-6.2.js +2 -2
  74. package/lib/config/services/ssl-terminator/index.js +6 -5
  75. package/lib/config/services/varnish/index.js +1 -1
  76. package/lib/config/services/varnish/varnish-6-0.js +7 -5
  77. package/lib/config/services/varnish/varnish-6-6.js +7 -5
  78. package/lib/config/services/varnish/varnish-7-0.js +7 -5
  79. package/lib/config/system-config.js +55 -32
  80. package/lib/config/templates/mariadb.template.cnf +2 -0
  81. package/lib/config/versions/index.js +48 -27
  82. package/lib/config/versions/magento-2.2.10.js +22 -15
  83. package/lib/config/versions/magento-2.3.0.js +22 -15
  84. package/lib/config/versions/magento-2.3.1.js +22 -15
  85. package/lib/config/versions/magento-2.3.2-p1.js +22 -15
  86. package/lib/config/versions/magento-2.3.2-p2.js +22 -15
  87. package/lib/config/versions/magento-2.3.2.js +22 -15
  88. package/lib/config/versions/magento-2.3.3-p1.js +22 -15
  89. package/lib/config/versions/magento-2.3.3.js +22 -15
  90. package/lib/config/versions/magento-2.3.4-p1.js +22 -15
  91. package/lib/config/versions/magento-2.3.4-p2.js +22 -15
  92. package/lib/config/versions/magento-2.3.4.js +22 -15
  93. package/lib/config/versions/magento-2.3.5-p1.js +22 -15
  94. package/lib/config/versions/magento-2.3.5-p2.js +22 -15
  95. package/lib/config/versions/magento-2.3.5.js +27 -15
  96. package/lib/config/versions/magento-2.3.6-p1.js +22 -15
  97. package/lib/config/versions/magento-2.3.6.js +22 -15
  98. package/lib/config/versions/magento-2.3.7-p1.js +22 -15
  99. package/lib/config/versions/magento-2.3.7-p2.js +22 -15
  100. package/lib/config/versions/magento-2.3.7-p3.js +22 -15
  101. package/lib/config/versions/magento-2.3.7-p4.js +22 -15
  102. package/lib/config/versions/magento-2.3.7.js +22 -15
  103. package/lib/config/versions/magento-2.4.0-p1.js +22 -15
  104. package/lib/config/versions/magento-2.4.0.js +22 -15
  105. package/lib/config/versions/magento-2.4.1-p1.js +23 -16
  106. package/lib/config/versions/magento-2.4.1.js +23 -16
  107. package/lib/config/versions/magento-2.4.2-p1.js +23 -16
  108. package/lib/config/versions/magento-2.4.2-p2.js +23 -16
  109. package/lib/config/versions/magento-2.4.2.js +23 -16
  110. package/lib/config/versions/magento-2.4.3-p1.js +23 -16
  111. package/lib/config/versions/magento-2.4.3-p2.js +23 -16
  112. package/lib/config/versions/magento-2.4.3-p3.js +23 -16
  113. package/lib/config/versions/magento-2.4.3.js +23 -16
  114. package/lib/config/versions/magento-2.4.4-p1.js +23 -16
  115. package/lib/config/versions/magento-2.4.4-p2.js +23 -16
  116. package/lib/config/versions/magento-2.4.4.js +23 -16
  117. package/lib/config/versions/magento-2.4.5-p1.js +23 -16
  118. package/lib/config/versions/magento-2.4.5.js +23 -17
  119. package/lib/config/xml-parser.js +21 -20
  120. package/lib/errors/known-error.js +8 -6
  121. package/lib/errors/unknown-error.js +8 -6
  122. package/lib/tasks/cache/create-cache-folder.js +10 -10
  123. package/lib/tasks/cache/index.js +1 -1
  124. package/lib/tasks/cache/remove-cache-folder.js +9 -9
  125. package/lib/tasks/cleanup.js +22 -24
  126. package/lib/tasks/cli/create-bashrc-config.js +19 -11
  127. package/lib/tasks/cli/index.js +10 -13
  128. package/lib/tasks/composer/index.js +20 -15
  129. package/lib/tasks/composer/local-auth-json.js +32 -18
  130. package/lib/tasks/database/connect-to-database.js +71 -51
  131. package/lib/tasks/database/create-magento-database.js +7 -7
  132. package/lib/tasks/database/create-magento-user.js +33 -20
  133. package/lib/tasks/database/default-magento-database.js +1 -1
  134. package/lib/tasks/database/default-magento-user.js +2 -2
  135. package/lib/tasks/database/dump-theme-config.js +16 -12
  136. package/lib/tasks/database/fix-db.js +62 -52
  137. package/lib/tasks/database/import-dump-to-database.js +122 -85
  138. package/lib/tasks/database/import-remote-db/index.js +16 -18
  139. package/lib/tasks/database/import-remote-db/ssh/database-dump-command.js +2 -2
  140. package/lib/tasks/database/import-remote-db/ssh/index.js +34 -35
  141. package/lib/tasks/database/import-remote-db/ssh/readymage.js +41 -38
  142. package/lib/tasks/database/import-remote-db/ssh/regular-server.js +44 -46
  143. package/lib/tasks/database/index.js +1 -1
  144. package/lib/tasks/database/magento-tables.js +3 -3
  145. package/lib/tasks/database/restore-theme-config.js +26 -19
  146. package/lib/tasks/docker/api.d.ts +1 -1
  147. package/lib/tasks/docker/api.js +31 -33
  148. package/lib/tasks/docker/containers/container-api.d.ts +49 -14
  149. package/lib/tasks/docker/containers/container-api.js +112 -83
  150. package/lib/tasks/docker/containers/index.js +3 -3
  151. package/lib/tasks/docker/containers/tasks.js +171 -99
  152. package/lib/tasks/docker/convert-composer-home-to-composer-cache-volume.js +34 -25
  153. package/lib/tasks/docker/convert-legacy-volumes.js +91 -55
  154. package/lib/tasks/docker/convert-mysql-to-mariadb.js +178 -147
  155. package/lib/tasks/docker/image/image-api.d.ts +2 -3
  156. package/lib/tasks/docker/image/image-api.js +41 -34
  157. package/lib/tasks/docker/image/index.js +2 -2
  158. package/lib/tasks/docker/index.js +26 -21
  159. package/lib/tasks/docker/network/index.js +3 -3
  160. package/lib/tasks/docker/network/network-api.d.ts +11 -8
  161. package/lib/tasks/docker/network/network-api.js +53 -61
  162. package/lib/tasks/docker/network/tasks.js +41 -31
  163. package/lib/tasks/docker/project-image-builder.js +175 -92
  164. package/lib/tasks/docker/system/index.js +2 -2
  165. package/lib/tasks/docker/system/system-api.d.ts +2 -2
  166. package/lib/tasks/docker/system/system-api.js +16 -19
  167. package/lib/tasks/docker/volume/index.js +3 -3
  168. package/lib/tasks/docker/volume/tasks.js +63 -46
  169. package/lib/tasks/docker/volume/volume-api.d.ts +8 -5
  170. package/lib/tasks/docker/volume/volume-api.js +59 -76
  171. package/lib/tasks/execute.js +91 -55
  172. package/lib/tasks/file-system/create-mariadb-config.js +18 -10
  173. package/lib/tasks/file-system/create-nginx-config.js +18 -19
  174. package/lib/tasks/file-system/create-php-config.js +12 -8
  175. package/lib/tasks/file-system/create-php-debug-config.js +23 -18
  176. package/lib/tasks/file-system/create-php-fpm-config.js +14 -9
  177. package/lib/tasks/file-system/create-phpstorm-config/database-config.js +144 -112
  178. package/lib/tasks/file-system/create-phpstorm-config/eslint-config.js +69 -45
  179. package/lib/tasks/file-system/create-phpstorm-config/exclude-folder-config.js +69 -70
  180. package/lib/tasks/file-system/create-phpstorm-config/index.js +28 -24
  181. package/lib/tasks/file-system/create-phpstorm-config/inspection-tools-config/coding-standard-config.js +9 -9
  182. package/lib/tasks/file-system/create-phpstorm-config/inspection-tools-config/config.js +23 -23
  183. package/lib/tasks/file-system/create-phpstorm-config/inspection-tools-config/custom-ruleset-path-config.js +22 -19
  184. package/lib/tasks/file-system/create-phpstorm-config/inspection-tools-config/default-properties-config.js +26 -16
  185. package/lib/tasks/file-system/create-phpstorm-config/inspection-tools-config/eslint-inspection-config.js +14 -15
  186. package/lib/tasks/file-system/create-phpstorm-config/inspection-tools-config/index.js +43 -34
  187. package/lib/tasks/file-system/create-phpstorm-config/inspection-tools-config/inspection-tools-config.js +14 -6
  188. package/lib/tasks/file-system/create-phpstorm-config/inspection-tools-config/magento-coding-standard-config.js +9 -9
  189. package/lib/tasks/file-system/create-phpstorm-config/inspection-tools-config/mess-detector-validation-inspection-config.js +53 -47
  190. package/lib/tasks/file-system/create-phpstorm-config/inspection-tools-config/paths.js +41 -12
  191. package/lib/tasks/file-system/create-phpstorm-config/inspection-tools-config/php-cs-fixer-validation-inspection-config.js +33 -30
  192. package/lib/tasks/file-system/create-phpstorm-config/inspection-tools-config/php-cs-validation-inspection-config.js +35 -38
  193. package/lib/tasks/file-system/create-phpstorm-config/inspection-tools-config/stylelint-inspection-config.js +14 -15
  194. package/lib/tasks/file-system/create-phpstorm-config/keys.js +10 -10
  195. package/lib/tasks/file-system/create-phpstorm-config/php-config/index.js +33 -25
  196. package/lib/tasks/file-system/create-phpstorm-config/php-config/mess-detector-config.js +28 -25
  197. package/lib/tasks/file-system/create-phpstorm-config/php-config/php-code-sniffer-config.js +53 -32
  198. package/lib/tasks/file-system/create-phpstorm-config/php-config/php-config.js +7 -7
  199. package/lib/tasks/file-system/create-phpstorm-config/php-config/php-cs-fixer-config.js +37 -27
  200. package/lib/tasks/file-system/create-phpstorm-config/php-config/php-interpreters-config.js +53 -31
  201. package/lib/tasks/file-system/create-phpstorm-config/php-config/php-project-shared-configuration-config.js +42 -30
  202. package/lib/tasks/file-system/create-phpstorm-config/php-docker-settings-config/index.js +33 -20
  203. package/lib/tasks/file-system/create-phpstorm-config/php-docker-settings-config/php-docker-settings-config.js +3 -3
  204. package/lib/tasks/file-system/create-phpstorm-config/php-docker-settings-config/setup-php-docker-container-settings-config.js +27 -16
  205. package/lib/tasks/file-system/create-phpstorm-config/setup-xml-structure.js +14 -13
  206. package/lib/tasks/file-system/create-phpstorm-config/stylelint-config.js +52 -34
  207. package/lib/tasks/file-system/create-phpstorm-config/workspace-config/composer-settings-config.js +41 -33
  208. package/lib/tasks/file-system/create-phpstorm-config/workspace-config/format-setting-config.js +39 -27
  209. package/lib/tasks/file-system/create-phpstorm-config/workspace-config/index.js +34 -30
  210. package/lib/tasks/file-system/create-phpstorm-config/workspace-config/mess-detector-project-configuration-config.js +32 -22
  211. package/lib/tasks/file-system/create-phpstorm-config/workspace-config/php-code-sniffer-project-configuration-config.js +32 -22
  212. package/lib/tasks/file-system/create-phpstorm-config/workspace-config/php-cs-fixer-project-configuration-config.js +32 -22
  213. package/lib/tasks/file-system/create-phpstorm-config/workspace-config/php-debug-general-config.js +42 -31
  214. package/lib/tasks/file-system/create-phpstorm-config/workspace-config/php-server-config.js +45 -33
  215. package/lib/tasks/file-system/create-phpstorm-config/workspace-config/php-stan-project-configuration-config.js.js +32 -22
  216. package/lib/tasks/file-system/create-phpstorm-config/workspace-config/php-workspace-project-configuration-config.js +22 -19
  217. package/lib/tasks/file-system/create-phpstorm-config/workspace-config/properties-component-config.js +35 -21
  218. package/lib/tasks/file-system/create-phpstorm-config/workspace-config/psalm-project-configuration-config.js.js +31 -22
  219. package/lib/tasks/file-system/create-phpstorm-config/workspace-config/run-manager-config.js +38 -28
  220. package/lib/tasks/file-system/create-phpstorm-config/workspace-config/workspace-config.js +5 -5
  221. package/lib/tasks/file-system/create-phpstorm-config/xml-utils.js +3 -2
  222. package/lib/tasks/file-system/create-ssl-terminator-config.js +46 -34
  223. package/lib/tasks/file-system/create-varnish-config.js +20 -23
  224. package/lib/tasks/file-system/create-vscode-config.js +66 -49
  225. package/lib/tasks/file-system/index.js +29 -25
  226. package/lib/tasks/import-dump.js +54 -45
  227. package/lib/tasks/link.js +24 -23
  228. package/lib/tasks/magento/enable-magento-composer-plugins.js +213 -149
  229. package/lib/tasks/magento/index.js +1 -1
  230. package/lib/tasks/magento/install-magento-project.js +158 -97
  231. package/lib/tasks/magento/remove-magento.js +30 -24
  232. package/lib/tasks/magento/setup-magento/adjust-full-page-cache.js +27 -15
  233. package/lib/tasks/magento/setup-magento/configure-elasticsearch.js +23 -10
  234. package/lib/tasks/magento/setup-magento/create-admin.js +21 -13
  235. package/lib/tasks/magento/setup-magento/delete-admin-users.js +5 -5
  236. package/lib/tasks/magento/setup-magento/delete-customers.js +16 -10
  237. package/lib/tasks/magento/setup-magento/delete-orders.js +16 -10
  238. package/lib/tasks/magento/setup-magento/disable-2fa.js +11 -8
  239. package/lib/tasks/magento/setup-magento/disable-maintenance-mode.js +7 -7
  240. package/lib/tasks/magento/setup-magento/disable-page-builder.js +5 -4
  241. package/lib/tasks/magento/setup-magento/flush-redis-config.js +14 -8
  242. package/lib/tasks/magento/setup-magento/increase-admin-session-lifetime.js +21 -17
  243. package/lib/tasks/magento/setup-magento/index-products.js +4 -6
  244. package/lib/tasks/magento/setup-magento/index.js +54 -47
  245. package/lib/tasks/magento/setup-magento/install-magento.js +112 -79
  246. package/lib/tasks/magento/setup-magento/migrate-database.js +115 -96
  247. package/lib/tasks/magento/setup-magento/set-base-url.js +35 -21
  248. package/lib/tasks/magento/setup-magento/set-deployment-mode.js +15 -13
  249. package/lib/tasks/magento/setup-magento/set-mail-config.js +20 -14
  250. package/lib/tasks/magento/setup-magento/set-url-rewrite.js +13 -9
  251. package/lib/tasks/magento/setup-magento/upgrade-magento.js +30 -22
  252. package/lib/tasks/magento/setup-magento/urn-highlighter.js +11 -11
  253. package/lib/tasks/magento/setup-magento/varnish-config.js +42 -32
  254. package/lib/tasks/magento/setup-magento/waiting-for-redis.js +6 -8
  255. package/lib/tasks/magento/setup-magento/waiting-for-varnish.js +108 -65
  256. package/lib/tasks/magento/uninstall-magento.js +19 -16
  257. package/lib/tasks/php/php-container.d.ts +19 -0
  258. package/lib/tasks/php/php-container.js +50 -46
  259. package/lib/tasks/php/update-env-php.js +50 -30
  260. package/lib/tasks/project-config/index.js +12 -8
  261. package/lib/tasks/requirements/composer-credentials.js +215 -112
  262. package/lib/tasks/requirements/docker/context.js +49 -37
  263. package/lib/tasks/requirements/docker/index.js +123 -89
  264. package/lib/tasks/requirements/docker/install-on-mac.js +21 -14
  265. package/lib/tasks/requirements/docker/install.js +63 -52
  266. package/lib/tasks/requirements/docker/performance.js +40 -24
  267. package/lib/tasks/requirements/docker/permissions.js +27 -17
  268. package/lib/tasks/requirements/docker/running-status.js +79 -66
  269. package/lib/tasks/requirements/docker/version.js +14 -11
  270. package/lib/tasks/requirements/index.js +33 -29
  271. package/lib/tasks/requirements/node-version.js +8 -8
  272. package/lib/tasks/requirements/php-version.js +14 -11
  273. package/lib/tasks/requirements/platform.js +42 -26
  274. package/lib/tasks/requirements/rosetta.js +15 -12
  275. package/lib/tasks/start.js +172 -148
  276. package/lib/tasks/status/index.js +155 -88
  277. package/lib/tasks/stop.js +22 -18
  278. package/lib/tasks/theme/build-theme.js +50 -33
  279. package/lib/tasks/theme/install-theme.js +31 -18
  280. package/lib/tasks/theme/link-theme.js +27 -21
  281. package/lib/tasks/theme/retrieve-theme-data.js +24 -18
  282. package/lib/tasks/theme/setup-themes.js +87 -59
  283. package/lib/tasks/theme/symlink-theme.js +44 -22
  284. package/lib/util/CSA-theme.js +23 -21
  285. package/lib/util/analytics.js +130 -75
  286. package/lib/util/arch.js +22 -18
  287. package/lib/util/clean-object.js +15 -10
  288. package/lib/util/config-file-validator.js +63 -54
  289. package/lib/util/config-php-json.js +34 -16
  290. package/lib/util/connection-string.js +41 -27
  291. package/lib/util/console-block.js +112 -65
  292. package/lib/util/database.js +56 -33
  293. package/lib/util/deepmerge.d.ts +1 -1
  294. package/lib/util/deepmerge.js +19 -28
  295. package/lib/util/dockerfile-builder/build-instructions.js +159 -143
  296. package/lib/util/dockerfile-builder/index.js +47 -73
  297. package/lib/util/dockerfile-builder/types.d.ts +2 -1
  298. package/lib/util/download-file.js +28 -16
  299. package/lib/util/env-php-json.js +42 -16
  300. package/lib/util/exec-async-command.d.ts +9 -9
  301. package/lib/util/exec-async-command.js +82 -59
  302. package/lib/util/exec-async.d.ts +2 -0
  303. package/lib/util/exec-async.js +12 -5
  304. package/lib/util/execute-in-container.js +22 -27
  305. package/lib/util/execute-sudo-command.js +11 -15
  306. package/lib/util/get-brew-bin-path.js +27 -23
  307. package/lib/util/get-installed-magento-version.js +22 -16
  308. package/lib/util/get-jsonfile-data.js +14 -9
  309. package/lib/util/install-dependencies-task.js +53 -41
  310. package/lib/util/instance-metadata.js +44 -29
  311. package/lib/util/ip.js +16 -12
  312. package/lib/util/is-running-root.js +6 -3
  313. package/lib/util/is-wsl.js +10 -10
  314. package/lib/util/macos-version.js +12 -11
  315. package/lib/util/magento-task.js +14 -9
  316. package/lib/util/match-filesystem.js +22 -16
  317. package/lib/util/move-file.js +40 -25
  318. package/lib/util/nginx-logs-parser.js +50 -39
  319. package/lib/util/open-browser.js +8 -5
  320. package/lib/util/os-platform.js +40 -32
  321. package/lib/util/path-exists-sync.js +10 -6
  322. package/lib/util/path-exists.js +6 -6
  323. package/lib/util/php-task.js +11 -10
  324. package/lib/util/portscanner.js +97 -85
  325. package/lib/util/prefix.js +31 -22
  326. package/lib/util/resolve-configuration-with-overrides.js +30 -15
  327. package/lib/util/rmdir-safe.js +15 -11
  328. package/lib/util/run-composer.js +16 -16
  329. package/lib/util/run-container-image.js +9 -4
  330. package/lib/util/run-magento.js +16 -17
  331. package/lib/util/run-php.js +16 -21
  332. package/lib/util/safe-regex-extract.js +8 -12
  333. package/lib/util/set-config.js +24 -15
  334. package/lib/util/sleep.js +7 -2
  335. package/lib/util/systemctl.js +62 -44
  336. package/lib/util/wait-for-it.js +42 -33
  337. package/lib/util/wait-for-logs.js +42 -35
  338. package/lib/util/xdg-open-exists.js +19 -19
  339. package/package.json +7 -3
  340. package/tsconfig.json +24 -0
  341. package/typings/context.d.ts +76 -34
  342. package/typings/index.d.ts +44 -19
  343. package/typings/override.d.ts +14 -0
  344. package/typings/phpstorm.d.ts +19 -19
  345. package/.prettierrc +0 -3
  346. package/lib/util/get-php-for-phpbrew.js +0 -30
  347. package/lib/util/request.js +0 -0
@@ -1,5 +1,5 @@
1
1
  /* eslint-disable max-len */
2
- const { execAsyncSpawn } = require('../../../util/exec-async-command');
2
+ const { execAsyncSpawn } = require('../../../util/exec-async-command')
3
3
 
4
4
  /**
5
5
  * @param {import('./container-api').ContainerRunOptions} options
@@ -26,25 +26,39 @@ const runCommand = (options) => {
26
26
  rm = false,
27
27
  tty = false,
28
28
  user
29
- } = options;
30
-
31
- const detachArg = detach && '-d';
32
- const rmArg = rm && '--rm';
33
- const ttyArg = tty && '-it';
34
- const exposeArg = expose && expose.map((e) => `--expose=${ e }`);
35
- const restartArg = !rm && restart && `--restart=${ restart }`;
36
- const networkArg = network && `--network=${ network }`;
37
- const portsArgs = ports && ports.length > 0 && ports.map((port) => `-p=${ port }`);
38
- const mountsArgs = mounts && mounts.map((mount) => `--mount="${ mount }"`);
39
- const mountVolumesArgs = mountVolumes && mountVolumes.map((mount) => `-v="${mount}"`);
40
- const envArgs = !env ? '' : Object.entries(env).map(([key, value]) => `--env=${ key }='${ value }'`);
41
- const nameArg = name && `--name=${name}`;
42
- const entrypointArg = entrypoint && `--entrypoint="${entrypoint}"`;
43
- const healthCheckArg = healthCheck && Object.entries(healthCheck).map(([key, value]) => `--health-${key}='${value}'`);
44
- const securityArg = securityOptions.length > 0 && securityOptions.map((opt) => `--security-opt=${opt}`);
45
- const tmpfsArg = tmpfs.length > 0 && tmpfs.map((t) => `--tmpfs=${t}`);
46
- const userArg = user && `--user=${user}`;
47
- const addHostArg = addHost && `--add-host=${addHost}`;
29
+ } = options
30
+
31
+ const detachArg = (detach && '-d') || ''
32
+ const rmArg = (rm && '--rm') || ''
33
+ const ttyArg = (tty && '-it') || ''
34
+ const exposeArg = (expose && expose.map((e) => `--expose=${e}`)) || ''
35
+ const restartArg = (!rm && restart && `--restart=${restart}`) || ''
36
+ const networkArg = (network && `--network=${network}`) || ''
37
+ const portsArgs =
38
+ (ports && ports.length > 0 && ports.map((port) => `-p=${port}`)) || ''
39
+ const mountsArgs =
40
+ (mounts && mounts.map((mount) => `--mount="${mount}"`)) || ''
41
+ const mountVolumesArgs =
42
+ (mountVolumes && mountVolumes.map((mount) => `-v="${mount}"`)) || ''
43
+ const envArgs = !env
44
+ ? ''
45
+ : Object.entries(env).map(([key, value]) => `--env=${key}='${value}'`)
46
+ const nameArg = (name && `--name=${name}`) || ''
47
+ const entrypointArg = (entrypoint && `--entrypoint="${entrypoint}"`) || ''
48
+ const healthCheckArg =
49
+ (healthCheck &&
50
+ Object.entries(healthCheck).map(
51
+ ([key, value]) => `--health-${key}='${value}'`
52
+ )) ||
53
+ ''
54
+ const securityArg =
55
+ (securityOptions.length > 0 &&
56
+ securityOptions.map((opt) => `--security-opt=${opt}`)) ||
57
+ ''
58
+ const tmpfsArg =
59
+ (tmpfs.length > 0 && tmpfs.map((t) => `--tmpfs=${t}`)) || ''
60
+ const userArg = (user && `--user=${user}`) || ''
61
+ const addHostArg = (addHost && `--add-host=${addHost}`) || ''
48
62
 
49
63
  const dockerCommand = [
50
64
  'docker',
@@ -68,16 +82,19 @@ const runCommand = (options) => {
68
82
  addHostArg,
69
83
  image,
70
84
  command
71
- ].flat().filter(Boolean).filter((arg) => typeof arg === 'string');
85
+ ]
86
+ .flat()
87
+ .filter((arg) => !!arg && typeof arg === 'string')
72
88
 
73
- return dockerCommand;
74
- };
89
+ return dockerCommand
90
+ }
75
91
 
76
92
  /**
77
93
  * @param {import('./container-api').ContainerRunOptions} options
78
94
  * @param {import('../../../util/exec-async-command').ExecAsyncSpawnOptions<false>} execOptions
79
95
  */
80
- const run = (options, execOptions = {}) => execAsyncSpawn(runCommand(options).join(' '), execOptions);
96
+ const run = (options, execOptions = {}) =>
97
+ execAsyncSpawn(runCommand(options).join(' '), execOptions)
81
98
 
82
99
  /**
83
100
  * @param {string} command
@@ -86,16 +103,15 @@ const run = (options, execOptions = {}) => execAsyncSpawn(runCommand(options).jo
86
103
  * @param {import('../../../util/exec-async-command').ExecAsyncSpawnOptions<false>} execOptions
87
104
  */
88
105
  const exec = (command, container, options = {}, execOptions = {}) => {
89
- const {
90
- env,
91
- tty,
92
- user,
93
- workdir
94
- } = options;
95
- const envArgs = !env ? '' : Object.entries(env).map(([key, value]) => `--env ${ key }='${ value }'`).join(' ');
96
- const ttyArg = tty ? '--tty' : '';
97
- const userArg = user ? `--user=${user}` : '';
98
- const workdirArg = workdir ? `--workdir=${workdir}` : '';
106
+ const { env, tty, user, workdir } = options
107
+ const envArgs = !env
108
+ ? ''
109
+ : Object.entries(env)
110
+ .map(([key, value]) => `--env ${key}='${value}'`)
111
+ .join(' ')
112
+ const ttyArg = tty ? '--tty' : ''
113
+ const userArg = user ? `--user=${user}` : ''
114
+ const workdirArg = workdir ? `--workdir=${workdir}` : ''
99
115
 
100
116
  const execCommand = [
101
117
  'docker',
@@ -107,14 +123,15 @@ const exec = (command, container, options = {}, execOptions = {}) => {
107
123
  workdirArg,
108
124
  container,
109
125
  command
110
- ].filter(Boolean).join(' ');
126
+ ]
127
+ .filter(Boolean)
128
+ .join(' ')
111
129
 
112
- return execAsyncSpawn(execCommand, execOptions);
113
- };
130
+ return execAsyncSpawn(execCommand, execOptions)
131
+ }
114
132
 
115
133
  /**
116
- * @param {import('./container-api').ContainerLsOptions} options
117
- * @param {import('../../../util/exec-async-command').ExecAsyncSpawnOptions<false>} execOptions
134
+ * @type {typeof import('./container-api')['ls']}
118
135
  */
119
136
  const ls = async (options = {}, execOptions = {}) => {
120
137
  const {
@@ -125,45 +142,47 @@ const ls = async (options = {}, execOptions = {}) => {
125
142
  latest,
126
143
  noTrunc,
127
144
  quiet
128
- } = options;
129
-
130
- const allArg = all && '--all';
131
- const filterArg = filter && typeof filter === 'string'
132
- ? `--filter=${filter}`
133
- : filter && Array.isArray(filter) && filter.every((f) => typeof f === 'string') && filter.map((f) => `--filter=${f}`).join(' ');
134
- const formatArg = !formatToJSON && format
135
- ? `--format=${format}`
136
- : formatToJSON && '--format=\'{{json .}}\'';
137
- const latestArg = latest && '--latest';
138
- const noTruncArg = noTrunc && '--no-trunc';
139
- const quietArg = quiet && '--quiet';
140
-
141
- const args = [
142
- allArg,
143
- filterArg,
144
- formatArg,
145
- latestArg,
146
- noTruncArg,
147
- quietArg
148
- ].filter(Boolean).join(' ');
145
+ } = options
146
+
147
+ const allArg = all && '--all'
148
+ const filterArg =
149
+ filter && typeof filter === 'string'
150
+ ? `--filter=${filter}`
151
+ : filter &&
152
+ Array.isArray(filter) &&
153
+ filter.every((f) => typeof f === 'string') &&
154
+ filter.map((f) => `--filter=${f}`).join(' ')
155
+ const formatArg =
156
+ !formatToJSON && format
157
+ ? `--format=${format}`
158
+ : formatToJSON && "--format='{{json .}}'"
159
+ const latestArg = latest && '--latest'
160
+ const noTruncArg = noTrunc && '--no-trunc'
161
+ const quietArg = quiet && '--quiet'
162
+
163
+ const args = [allArg, filterArg, formatArg, latestArg, noTruncArg, quietArg]
164
+ .filter(Boolean)
165
+ .join(' ')
149
166
 
150
167
  if (formatToJSON) {
151
- const result = await execAsyncSpawn(`docker container ls ${args}`, execOptions);
168
+ const result = await execAsyncSpawn(
169
+ `docker container ls ${args}`,
170
+ execOptions
171
+ )
152
172
  if (result.startsWith('[')) {
153
- return JSON.parse(result);
173
+ return JSON.parse(result)
154
174
  }
155
175
 
156
- return JSON.parse(`[${result.split('\n').join(', ')}]`);
176
+ return JSON.parse(`[${result.split('\n').join(', ')}]`)
157
177
  }
158
178
 
159
- return execAsyncSpawn(`docker container ls ${args}`, execOptions);
160
- };
179
+ return execAsyncSpawn(`docker container ls ${args}`, execOptions)
180
+ }
161
181
 
162
182
  /**
163
- * @param {import('./container-api').ContainerLogsOptions} options
164
- * @param {import('../../../util/exec-async-command').ExecAsyncSpawnOptions<false>} execOptions
183
+ * @type {typeof import('./container-api')['logs']}
165
184
  */
166
- const logs = async (options = {}, execOptions = {}) => {
185
+ const logs = async (options, execOptions = {}) => {
167
186
  const {
168
187
  name,
169
188
  details = false,
@@ -173,13 +192,13 @@ const logs = async (options = {}, execOptions = {}) => {
173
192
  timestamps = false,
174
193
  until = '',
175
194
  parser
176
- } = options;
177
- const detailsArg = details && '--details';
178
- const followArg = follow && '--follow';
179
- const sinceArg = since && `--since=${since}`;
180
- const tailArg = tail && `--tail=${tail}`;
181
- const timestampsArg = timestamps && '--timestamps';
182
- const untilArg = until && `--until=${until}`;
195
+ } = options
196
+ const detailsArg = details && '--details'
197
+ const followArg = follow && '--follow'
198
+ const sinceArg = since && `--since=${since}`
199
+ const tailArg = tail && `--tail=${tail}`
200
+ const timestampsArg = timestamps && '--timestamps'
201
+ const untilArg = until && `--until=${until}`
183
202
 
184
203
  const logsCommand = [
185
204
  'docker',
@@ -192,20 +211,30 @@ const logs = async (options = {}, execOptions = {}) => {
192
211
  timestampsArg,
193
212
  untilArg,
194
213
  name
195
- ].filter(Boolean).join(' ');
214
+ ]
215
+ .filter(Boolean)
216
+ .join(' ')
196
217
 
197
218
  if (parser) {
198
- const result = await execAsyncSpawn(logsCommand, execOptions);
219
+ const result = await execAsyncSpawn(logsCommand, execOptions)
199
220
 
200
- return result.split('\n').map((line) => parser(line));
221
+ return result.split('\n').map((line) => parser(line))
201
222
  }
202
223
 
203
- return execAsyncSpawn(logsCommand, execOptions);
204
- };
224
+ return execAsyncSpawn(logsCommand, execOptions)
225
+ }
205
226
 
206
- const stop = (containers, execOptions = {}) => execAsyncSpawn(`docker container stop ${containers.join(' ')}`, execOptions);
227
+ /**
228
+ * @type {typeof import('./container-api')['stop']}
229
+ */
230
+ const stop = (containers, execOptions = {}) =>
231
+ execAsyncSpawn(`docker container stop ${containers.join(' ')}`, execOptions)
207
232
 
208
- const rm = (containers, execOptions = {}) => execAsyncSpawn(`docker container rm ${containers.join(' ')}`, execOptions);
233
+ /**
234
+ * @type {typeof import('./container-api')['rm']}
235
+ */
236
+ const rm = (containers, execOptions = {}) =>
237
+ execAsyncSpawn(`docker container rm ${containers.join(' ')}`, execOptions)
209
238
 
210
239
  module.exports = {
211
240
  run,
@@ -215,4 +244,4 @@ module.exports = {
215
244
  logs,
216
245
  stop,
217
246
  rm
218
- };
247
+ }
@@ -5,8 +5,8 @@ const {
5
5
  statusContainers,
6
6
  checkContainersAreRunning,
7
7
  getContainerStatus
8
- } = require('./tasks');
9
- const containerApi = require('./container-api');
8
+ } = require('./tasks')
9
+ const containerApi = require('./container-api')
10
10
 
11
11
  module.exports = {
12
12
  startContainers,
@@ -16,4 +16,4 @@ module.exports = {
16
16
  checkContainersAreRunning,
17
17
  getContainerStatus,
18
18
  containerApi
19
- };
19
+ }