@toptal/davinci-engine 10.5.5 → 10.5.6

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Change Log
 
+## 10.5.6
+
+### Patch Changes
+
+- [#2021](https://github.com/toptal/davinci/pull/2021) [`97abce92`](https://github.com/toptal/davinci/commit/97abce922d3a0720e0806ae9cd2f2866f355a1bc) Thanks [@dmaklygin](https://github.com/dmaklygin)!
+
+---
+
+- standardize command syntax for consistency
+- Updated dependencies [[`97abce92`](https://github.com/toptal/davinci/commit/97abce922d3a0720e0806ae9cd2f2866f355a1bc), [`97abce92`](https://github.com/toptal/davinci/commit/97abce922d3a0720e0806ae9cd2f2866f355a1bc)]:
+  - @toptal/davinci-cli-shared@2.3.1
+  - @toptal/davinci-monorepo@8.2.1
+
 ## 10.5.5
 
 ### Patch Changes

package/bin/davinci-engine.js

@@ -1,26 +1,7 @@
 #!/usr/bin/env node
 import cliEngine from '@toptal/davinci-cli-shared'
 
-import { createStartCommand } from '../src/commands/start.js'
-import buildCommandCreator from '../src/commands/build.js'
-import compilePackageCommandCreator from '../src/commands/compile-package.js'
-import publishPackageCommandCreator from '../src/commands/publish-package.js'
-import releasePackageCommandCreator from '../src/commands/release-package.js'
-import analyzeCommandCreator from '../src/commands/analyze.js'
-import sizeCommandCreator from '../src/commands/size.js'
-import sentryUploadSourceMaps from '../src/commands/sentry-upload-sourcemaps.js'
+import { commands } from '../src/index.js'
 
-cliEngine.loadCommands(
-  [
-    createStartCommand,
-    buildCommandCreator,
-    compilePackageCommandCreator,
-    publishPackageCommandCreator,
-    releasePackageCommandCreator,
-    analyzeCommandCreator,
-    sizeCommandCreator,
-    sentryUploadSourceMaps,
-  ],
-  'davinci-engine'
-)
+cliEngine.loadCommands(commands, 'davinci-engine')
 cliEngine.bootstrap()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toptal/davinci-engine",
-  "version": "10.5.5",
+  "version": "10.5.6",
   "description": "Build tool for frontend projects",
   "publishConfig": {
     "access": "public"
@@ -47,9 +47,9 @@
     "@sentry/cli": "^2.1.0",
     "@size-limit/file": "^8.1.0",
     "@svgr/webpack": "^6.1.2",
-    "@toptal/davinci-cli-shared": "2.3.0",
+    "@toptal/davinci-cli-shared": "2.3.1",
     "@toptal/davinci-cloudflare-requests-handler": "0.1.1",
-    "@toptal/davinci-monorepo": "8.2.0",
+    "@toptal/davinci-monorepo": "8.2.1",
     "babel-loader": "^8.2.2",
     "babel-plugin-graphql-tag": "^3.3.0",
     "babel-plugin-module-resolver": "^4.1.0",

package/src/commands/__snapshots__/analyze.test.js.snap

@@ -1,9 +1,47 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`analyzeCommandCreator has the correct command structure 1`] = `
-{
-  "action": [Function],
-  "command": "analyze",
-  "description": "analyze webpack bundle and show the installed dependencies",
-}
+exports[`createAnalyzeCommand creates a command with the correct parameters 1`] = `
+"{
+  "_events": {},
+  "_eventsCount": 0,
+  "commands": [],
+  "options": [],
+  "parent": null,
+  "_allowUnknownOption": false,
+  "_allowExcessArguments": true,
+  "_args": [],
+  "args": [],
+  "rawArgs": [],
+  "processedArgs": [],
+  "_scriptPath": null,
+  "_name": "analyze",
+  "_optionValues": {},
+  "_optionValueSources": {},
+  "_storeOptionsAsProperties": false,
+  "_executableHandler": false,
+  "_executableFile": null,
+  "_executableDir": null,
+  "_defaultCommandName": null,
+  "_exitCallback": null,
+  "_aliases": [],
+  "_combineFlagAndOptionalValue": true,
+  "_description": "analyze webpack bundle and show the installed dependencies",
+  "_summary": "",
+  "_enablePositionalOptions": false,
+  "_passThroughOptions": false,
+  "_lifeCycleHooks": {},
+  "_showHelpAfterError": false,
+  "_showSuggestionAfterError": true,
+  "_outputConfiguration": {},
+  "_hidden": false,
+  "_hasHelpOption": true,
+  "_helpFlags": "-h, --help",
+  "_helpDescription": "display help for command",
+  "_helpShortFlag": "-h",
+  "_helpLongFlag": "--help",
+  "_helpCommandName": "help",
+  "_helpCommandnameAndArgs": "help [command]",
+  "_helpCommandDescription": "display help for command",
+  "_helpConfiguration": {}
+}"
 `;

package/src/commands/__snapshots__/build.test.js.snap

@@ -1,41 +1,140 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`buildCommandCreator has the correct command structure 1`] = `
-{
-  "action": [Function],
-  "command": "build",
-  "description": "Build project for release",
+exports[`createBuildCommand has the correct command structure 1`] = `
+"{
+  "_events": {},
+  "_eventsCount": 7,
+  "commands": [],
   "options": [
     {
-      "default": "none",
-      "label": ".env file to use as source of env variables; values: 'none', 'auto' or path to dotenv file",
-      "name": "--dotenv <dotenv>",
+      "flags": "--dotenv <dotenv>",
+      "description": ".env file to use as source of env variables; values: 'none', 'auto' or path to dotenv file",
+      "required": true,
+      "optional": false,
+      "variadic": false,
+      "mandatory": false,
+      "long": "--dotenv",
+      "negate": false,
+      "defaultValue": "none",
+      "hidden": false,
+      "conflictsWith": []
     },
     {
-      "label": "disable source maps generation",
-      "name": "--disable-source-maps",
+      "flags": "--disable-source-maps",
+      "description": "disable source maps generation",
+      "required": false,
+      "optional": false,
+      "variadic": false,
+      "mandatory": false,
+      "long": "--disable-source-maps",
+      "negate": false,
+      "hidden": false,
+      "conflictsWith": []
     },
     {
-      "label": "replace progressive web app service worker with safety-worker.js content (https://toptal-core.atlassian.net/wiki/spaces/FE/pages/2059796590/Davinci+-+How+to+deal+with+progressive+web+app+PWA#Service-Worker-Safety)",
-      "name": "--emergency-safety-worker",
+      "flags": "--emergency-safety-worker",
+      "description": "replace progressive web app service worker with safety-worker.js content (https://toptal-core.atlassian.net/wiki/spaces/FE/pages/2059796590/Davinci+-+How+to+deal+with+progressive+web+app+PWA#Service-Worker-Safety)",
+      "required": false,
+      "optional": false,
+      "variadic": false,
+      "mandatory": false,
+      "long": "--emergency-safety-worker",
+      "negate": false,
+      "hidden": false,
+      "conflictsWith": []
     },
     {
-      "label": "disable Cloudflare fetch handler override",
-      "name": "--disable-cloudflare-handler",
+      "flags": "--disable-cloudflare-handler",
+      "description": "disable Cloudflare fetch handler override",
+      "required": false,
+      "optional": false,
+      "variadic": false,
+      "mandatory": false,
+      "long": "--disable-cloudflare-handler",
+      "negate": false,
+      "hidden": false,
+      "conflictsWith": []
     },
     {
-      "label": "skip type checking in webpack",
-      "name": "--skip-type-checking",
+      "flags": "--skip-type-checking",
+      "description": "skip type checking in webpack",
+      "required": false,
+      "optional": false,
+      "variadic": false,
+      "mandatory": false,
+      "long": "--skip-type-checking",
+      "negate": false,
+      "hidden": false,
+      "conflictsWith": []
     },
     {
-      "default": "basic",
-      "label": "progress bar type for webpack build process",
-      "name": "--progress-bar [basic | fancy]",
+      "flags": "--progress-bar [basic | fancy]",
+      "description": "progress bar type for webpack build process",
+      "required": false,
+      "optional": true,
+      "variadic": false,
+      "mandatory": false,
+      "long": "--progress-bar",
+      "negate": false,
+      "defaultValue": "basic",
+      "hidden": false,
+      "conflictsWith": []
     },
     {
-      "label": "Compiler to use: babel, swc (default: babel)",
-      "name": "--compiler <compiler>",
-    },
+      "flags": "--compiler <compiler>",
+      "description": "Compiler to use: babel, swc (default: babel)",
+      "required": true,
+      "optional": false,
+      "variadic": false,
+      "mandatory": false,
+      "long": "--compiler",
+      "negate": false,
+      "hidden": false,
+      "conflictsWith": []
+    }
   ],
-}
+  "parent": null,
+  "_allowUnknownOption": false,
+  "_allowExcessArguments": true,
+  "_args": [],
+  "args": [],
+  "rawArgs": [],
+  "processedArgs": [],
+  "_scriptPath": null,
+  "_name": "build",
+  "_optionValues": {
+    "dotenv": "none",
+    "progressBar": "basic"
+  },
+  "_optionValueSources": {
+    "dotenv": "default",
+    "progressBar": "default"
+  },
+  "_storeOptionsAsProperties": false,
+  "_executableHandler": false,
+  "_executableFile": null,
+  "_executableDir": null,
+  "_defaultCommandName": null,
+  "_exitCallback": null,
+  "_aliases": [],
+  "_combineFlagAndOptionalValue": true,
+  "_description": "Build project for release",
+  "_summary": "",
+  "_enablePositionalOptions": false,
+  "_passThroughOptions": false,
+  "_lifeCycleHooks": {},
+  "_showHelpAfterError": false,
+  "_showSuggestionAfterError": true,
+  "_outputConfiguration": {},
+  "_hidden": false,
+  "_hasHelpOption": true,
+  "_helpFlags": "-h, --help",
+  "_helpDescription": "display help for command",
+  "_helpShortFlag": "-h",
+  "_helpLongFlag": "--help",
+  "_helpCommandName": "help",
+  "_helpCommandnameAndArgs": "help [command]",
+  "_helpCommandDescription": "display help for command",
+  "_helpConfiguration": {}
+}"
 `;

package/src/commands/__snapshots__/compile-package.test.js.snap

@@ -1,28 +1,101 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`compilePackageCommandCreator has the correct command structure 1`] = `
-{
-  "action": [Function],
-  "command": "compile-package",
-  "description": "Compile package to publish to npm",
+exports[`createCompilePackageCommand creates a command with the correct parameters 1`] = `
+"{
+  "_events": {},
+  "_eventsCount": 4,
+  "commands": [],
   "options": [
     {
-      "default": "none",
-      "label": ".env file to use as source of env variables; values: 'none', 'auto' or path to dotenv file",
-      "name": "--dotenv <dotenv>",
+      "flags": "--dotenv <dotenv>",
+      "description": ".env file to use as source of env variables; values: 'none', 'auto' or path to dotenv file",
+      "required": true,
+      "optional": false,
+      "variadic": false,
+      "mandatory": false,
+      "long": "--dotenv",
+      "negate": false,
+      "defaultValue": "none",
+      "hidden": false,
+      "conflictsWith": []
     },
     {
-      "label": "path to a custom Babel config file; values: path to a Babel config file",
-      "name": "--babelConfig <babelConfig>",
+      "flags": "--babelConfig <babelConfig>",
+      "description": "path to a custom Babel config file; values: path to a Babel config file",
+      "required": true,
+      "optional": false,
+      "variadic": false,
+      "mandatory": false,
+      "long": "--babelConfig",
+      "negate": false,
+      "hidden": false,
+      "conflictsWith": []
     },
     {
-      "label": "path to a custom tsconfig file; values: path to a custom tsconfig file",
-      "name": "--tsConfig <tsConfig>",
+      "flags": "--tsConfig <tsConfig>",
+      "description": "path to a custom tsconfig file; values: path to a custom tsconfig file",
+      "required": true,
+      "optional": false,
+      "variadic": false,
+      "mandatory": false,
+      "long": "--tsConfig",
+      "negate": false,
+      "hidden": false,
+      "conflictsWith": []
     },
     {
-      "label": "path to a custom entry index file; values: path to a custom entry index file",
-      "name": "--entry <entry>",
-    },
+      "flags": "--entry <entry>",
+      "description": "path to a custom entry index file; values: path to a custom entry index file",
+      "required": true,
+      "optional": false,
+      "variadic": false,
+      "mandatory": false,
+      "long": "--entry",
+      "negate": false,
+      "hidden": false,
+      "conflictsWith": []
+    }
   ],
-}
+  "parent": null,
+  "_allowUnknownOption": false,
+  "_allowExcessArguments": true,
+  "_args": [],
+  "args": [],
+  "rawArgs": [],
+  "processedArgs": [],
+  "_scriptPath": null,
+  "_name": "compile-package",
+  "_optionValues": {
+    "dotenv": "none"
+  },
+  "_optionValueSources": {
+    "dotenv": "default"
+  },
+  "_storeOptionsAsProperties": false,
+  "_executableHandler": false,
+  "_executableFile": null,
+  "_executableDir": null,
+  "_defaultCommandName": null,
+  "_exitCallback": null,
+  "_aliases": [],
+  "_combineFlagAndOptionalValue": true,
+  "_description": "Compile package to publish to npm",
+  "_summary": "",
+  "_enablePositionalOptions": false,
+  "_passThroughOptions": false,
+  "_lifeCycleHooks": {},
+  "_showHelpAfterError": false,
+  "_showSuggestionAfterError": true,
+  "_outputConfiguration": {},
+  "_hidden": false,
+  "_hasHelpOption": true,
+  "_helpFlags": "-h, --help",
+  "_helpDescription": "display help for command",
+  "_helpShortFlag": "-h",
+  "_helpLongFlag": "--help",
+  "_helpCommandName": "help",
+  "_helpCommandnameAndArgs": "help [command]",
+  "_helpCommandDescription": "display help for command",
+  "_helpConfiguration": {}
+}"
 `;

package/src/commands/__snapshots__/publish-package.test.js.snap

@@ -1,31 +1,108 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`publishPackageCommand has the correct command structure 1`] = `
-{
-  "action": [Function],
-  "command": "publish-package",
-  "description": "Publish package to npm",
+exports[`createPublishPackageCommand has the correct command structure 1`] = `
+"{
+  "_events": {},
+  "_eventsCount": 5,
+  "commands": [],
   "options": [
     {
-      "label": "publish alpha version of the package",
-      "name": "--alpha",
+      "flags": "--alpha",
+      "description": "publish alpha version of the package",
+      "required": false,
+      "optional": false,
+      "variadic": false,
+      "mandatory": false,
+      "long": "--alpha",
+      "negate": false,
+      "hidden": false,
+      "conflictsWith": []
     },
     {
-      "label": "the file to output the new published version",
-      "name": "--outputVersion <outputVersion>",
+      "flags": "--outputVersion <outputVersion>",
+      "description": "the file to output the new published version",
+      "required": true,
+      "optional": false,
+      "variadic": false,
+      "mandatory": false,
+      "long": "--outputVersion",
+      "negate": false,
+      "hidden": false,
+      "conflictsWith": []
     },
     {
-      "label": "the branch name to be added to the release version metadata, only for alpha version",
-      "name": "--branch <branch>",
+      "flags": "--branch <branch>",
+      "description": "the branch name to be added to the release version metadata, only for alpha version",
+      "required": true,
+      "optional": false,
+      "variadic": false,
+      "mandatory": false,
+      "long": "--branch",
+      "negate": false,
+      "hidden": false,
+      "conflictsWith": []
     },
     {
-      "label": "explicitly process as non-monorepo (a single package)",
-      "name": "--nonMonorepo",
+      "flags": "--nonMonorepo",
+      "description": "explicitly process as non-monorepo (a single package)",
+      "required": false,
+      "optional": false,
+      "variadic": false,
+      "mandatory": false,
+      "long": "--nonMonorepo",
+      "negate": false,
+      "hidden": false,
+      "conflictsWith": []
     },
     {
-      "label": "custom publish root folder, (by default is /dist-package)",
-      "name": "--publishRootFolder <publishRootFolder>",
-    },
+      "flags": "--publishRootFolder <publishRootFolder>",
+      "description": "custom publish root folder, (by default is /dist-package)",
+      "required": true,
+      "optional": false,
+      "variadic": false,
+      "mandatory": false,
+      "long": "--publishRootFolder",
+      "negate": false,
+      "hidden": false,
+      "conflictsWith": []
+    }
   ],
-}
+  "parent": null,
+  "_allowUnknownOption": false,
+  "_allowExcessArguments": true,
+  "_args": [],
+  "args": [],
+  "rawArgs": [],
+  "processedArgs": [],
+  "_scriptPath": null,
+  "_name": "publish-package",
+  "_optionValues": {},
+  "_optionValueSources": {},
+  "_storeOptionsAsProperties": false,
+  "_executableHandler": false,
+  "_executableFile": null,
+  "_executableDir": null,
+  "_defaultCommandName": null,
+  "_exitCallback": null,
+  "_aliases": [],
+  "_combineFlagAndOptionalValue": true,
+  "_description": "Publish package to npm",
+  "_summary": "",
+  "_enablePositionalOptions": false,
+  "_passThroughOptions": false,
+  "_lifeCycleHooks": {},
+  "_showHelpAfterError": false,
+  "_showSuggestionAfterError": true,
+  "_outputConfiguration": {},
+  "_hidden": false,
+  "_hasHelpOption": true,
+  "_helpFlags": "-h, --help",
+  "_helpDescription": "display help for command",
+  "_helpShortFlag": "-h",
+  "_helpLongFlag": "--help",
+  "_helpCommandName": "help",
+  "_helpCommandnameAndArgs": "help [command]",
+  "_helpCommandDescription": "display help for command",
+  "_helpConfiguration": {}
+}"
 `;

package/src/commands/__snapshots__/release-package.test.js.snap

@@ -1,31 +1,108 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`releasePackageCommand has the correct command structure 1`] = `
-{
-  "action": [Function],
-  "command": "release-package",
-  "description": "Build and release the package",
+exports[`createReleasePackageCommand has the correct command structure 1`] = `
+"{
+  "_events": {},
+  "_eventsCount": 5,
+  "commands": [],
   "options": [
     {
-      "label": "path to a custom Babel config file; values: path to a Babel config file",
-      "name": "--babelConfig <babelConfig>",
+      "flags": "--babelConfig <babelConfig>",
+      "description": "path to a custom Babel config file; values: path to a Babel config file",
+      "required": true,
+      "optional": false,
+      "variadic": false,
+      "mandatory": false,
+      "long": "--babelConfig",
+      "negate": false,
+      "hidden": false,
+      "conflictsWith": []
     },
     {
-      "label": "path to a custom tsconfig file; values: path to a custom tsconfig file",
-      "name": "--tsConfig <tsConfig>",
+      "flags": "--tsConfig <tsConfig>",
+      "description": "path to a custom tsconfig file; values: path to a custom tsconfig file",
+      "required": true,
+      "optional": false,
+      "variadic": false,
+      "mandatory": false,
+      "long": "--tsConfig",
+      "negate": false,
+      "hidden": false,
+      "conflictsWith": []
     },
     {
-      "label": "path to a custom entry index file; values: path to a custom entry index file",
-      "name": "--entry <entry>",
+      "flags": "--entry <entry>",
+      "description": "path to a custom entry index file; values: path to a custom entry index file",
+      "required": true,
+      "optional": false,
+      "variadic": false,
+      "mandatory": false,
+      "long": "--entry",
+      "negate": false,
+      "hidden": false,
+      "conflictsWith": []
     },
     {
-      "label": "the file to output the new published version to",
-      "name": "--outputVersion <outputVersion>",
+      "flags": "--outputVersion <outputVersion>",
+      "description": "the file to output the new published version to",
+      "required": true,
+      "optional": false,
+      "variadic": false,
+      "mandatory": false,
+      "long": "--outputVersion",
+      "negate": false,
+      "hidden": false,
+      "conflictsWith": []
     },
     {
-      "label": "explicitly process as non-monorepo (a single package)",
-      "name": "--nonMonorepo",
-    },
+      "flags": "--nonMonorepo",
+      "description": "explicitly process as non-monorepo (a single package)",
+      "required": false,
+      "optional": false,
+      "variadic": false,
+      "mandatory": false,
+      "long": "--nonMonorepo",
+      "negate": false,
+      "hidden": false,
+      "conflictsWith": []
+    }
   ],
-}
+  "parent": null,
+  "_allowUnknownOption": false,
+  "_allowExcessArguments": true,
+  "_args": [],
+  "args": [],
+  "rawArgs": [],
+  "processedArgs": [],
+  "_scriptPath": null,
+  "_name": "release-package",
+  "_optionValues": {},
+  "_optionValueSources": {},
+  "_storeOptionsAsProperties": false,
+  "_executableHandler": false,
+  "_executableFile": null,
+  "_executableDir": null,
+  "_defaultCommandName": null,
+  "_exitCallback": null,
+  "_aliases": [],
+  "_combineFlagAndOptionalValue": true,
+  "_description": "Build and release the package",
+  "_summary": "",
+  "_enablePositionalOptions": false,
+  "_passThroughOptions": false,
+  "_lifeCycleHooks": {},
+  "_showHelpAfterError": false,
+  "_showSuggestionAfterError": true,
+  "_outputConfiguration": {},
+  "_hidden": false,
+  "_hasHelpOption": true,
+  "_helpFlags": "-h, --help",
+  "_helpDescription": "display help for command",
+  "_helpShortFlag": "-h",
+  "_helpLongFlag": "--help",
+  "_helpCommandName": "help",
+  "_helpCommandnameAndArgs": "help [command]",
+  "_helpCommandDescription": "display help for command",
+  "_helpConfiguration": {}
+}"
 `;