1.x (#17)

* make dependencies explicit

* fix: update dependency versions

* Release v1.0.0

* fix: ban-ts-ignore was replaced by ban-ts-comment

* fix: import as a type

* Release v1.0.1

* Release v1.0.2

* Release v1.0.3-beta

* fix: modify plugin dependencies according to toolbelt 3.x

* chore: bump toolbelt to new test version

* Release v1.0.4-beta

* update CHANGELOG

* Release v1.0.4

* Automatic update on Toolbelt plugin documentation

Author: williamads

.eslintrc

@@ -7,7 +7,7 @@
     "jest": true
   },
   "rules": {
-    "@typescript-eslint/ban-ts-ignore": "warn",
+    "@typescript-eslint/ban-ts-comment": "warn",
     "@typescript-eslint/explicit-member-accessibility": "off",
     "@typescript-eslint/interface-name-prefix": "off",
     "@typescript-eslint/no-explicit-any": "off",

CHANGELOG.md

@@ -5,6 +5,18 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+
+## [1.0.4] - 2021-10-07
+
+### Changed
+- Update CommandError to createFlowIssueError to conform to toolbelt 3.x.
+- Update runYarnIfPathExists import path.
+
+### Fixed
+- Make dependencies explicit.
+- [lint] Use ban-ts-comment instead of ban-ts-ignore.
+- [lint] Remove disable for @typescript-eslint/camelcase.
+
 ### Changed
 - [ci] Automatic plugin documentation
 

README.md

@@ -18,7 +18,7 @@ $ npm install -g @vtex/cli-plugin-test
 $ oclif-example COMMAND
 running command...
 $ oclif-example (-v|--version|version)
-@vtex/cli-plugin-test/0.0.5 linux-x64 node-v12.18.3
+@vtex/cli-plugin-test/1.0.4 linux-x64 node-v12.22.6
 $ oclif-example --help [COMMAND]
 USAGE
   $ oclif-example COMMAND
@@ -36,39 +36,39 @@ Run your VTEX app's integration tests
 
 ```
 USAGE
-  $ oclif-example test:e2e
+  $ oclif-example test e2e
 
 OPTIONS
-  -h, --help           show CLI help
+  -h, --help           Shows this help message.
   -r, --report=report  Check the results and state of a previously started test given its ID
 
   -t, --token          [Not recommended] Send your personal authorization token to your test session so it's available
                        while running the tests. It can be dangerous because exposes the token via 'authToken'
                        environment variable
 
-  -v, --verbose        Show debug level logs
+  -v, --verbose        Shows debug level logs.
 
   -w, --workspace      Test workspace's apps
 
-  --trace              Ensure all requests to VTEX IO are traced
+  --trace              Ensures all requests to VTEX IO are traced.
 ```
 
-_See code: [build/commands/test/e2e.ts](https://github.com/vtex/cli-plugin-test/blob/v0.0.5/build/commands/test/e2e.ts)_
+_See code: [build/commands/test/e2e.ts](https://github.com/vtex/cli-plugin-test/blob/v1.0.4/build/commands/test/e2e.ts)_
 
 ## `oclif-example test:unit`
 
 Run your VTEX app unit tests
 
 ```
 USAGE
-  $ oclif-example test:unit
+  $ oclif-example test unit
 
 OPTIONS
-  -h, --help     show CLI help
+  -h, --help     Shows this help message.
   -u, --unsafe   Allow tests with Typescript errors
-  -v, --verbose  Show debug level logs
-  --trace        Ensure all requests to VTEX IO are traced
+  -v, --verbose  Shows debug level logs.
+  --trace        Ensures all requests to VTEX IO are traced.
 ```
 
-_See code: [build/commands/test/unit.ts](https://github.com/vtex/cli-plugin-test/blob/v0.0.5/build/commands/test/unit.ts)_
+_See code: [build/commands/test/unit.ts](https://github.com/vtex/cli-plugin-test/blob/v1.0.4/build/commands/test/unit.ts)_
 <!-- commandsstop -->

package.json

@@ -1,21 +1,24 @@
 {
   "name": "@vtex/cli-plugin-test",
   "description": "vtex plugin test",
-  "version": "0.0.5",
+  "version": "1.0.4",
   "bugs": "https://github.com/vtex/cli-plugin-test/issues",
   "dependencies": {
     "@oclif/command": "^1",
     "@oclif/config": "^1",
     "@tiagonapoli/oclif-plugin-spaced-commands": "^0.0.6",
+    "@vtex/api": "3.77.0",
     "async-retry": "^1.3.1",
     "chalk": "^4.1.0",
+    "ramda": "0.25.0",
     "tslib": "^1"
   },
   "devDependencies": {
     "@oclif/dev-cli": "^1",
     "@oclif/plugin-help": "^3",
     "@types/jest": "^26.0.3",
     "@types/node": "^14.0.14",
+    "@types/ramda": "0.25.24",
     "eslint": "^6.8.0",
     "eslint-config-oclif": "^3.1",
     "eslint-config-oclif-typescript": "^0.1",
@@ -27,8 +30,8 @@
     "prettier": "^2.0.1",
     "ts-jest": "^25.2.1",
     "ts-node": "^8.10.2",
-    "typescript": "^3.8.2",
-    "vtex": "2.105.1-beta.8"
+    "typescript": "^3.9.7",
+    "vtex": "3.8.0-beta.1"
   },
   "engines": {
     "node": ">=8.0.0"

src/clients/Tester.ts

@@ -1,4 +1,5 @@
-import { AppClient, CacheType, InstanceOptions, IOContext } from '@vtex/api'
+import type { InstanceOptions, IOContext } from '@vtex/api'
+import { AppClient, CacheType } from '@vtex/api'
 import { IOClientFactory } from 'vtex'
 
 export interface SpecTestReport {

src/modules/apps/e2e/index.ts

@@ -10,9 +10,11 @@ import {
   publicEndpoint,
 } from 'vtex'
 
-import { parseReport, AppTest, passedApp } from './specsState'
+import type { AppTest } from './specsState'
+import { parseReport, passedApp } from './specsState'
 
-import { Tester, AppReport, TestRequest } from '../../../clients/Tester'
+import type { AppReport, TestRequest } from '../../../clients/Tester'
+import { Tester } from '../../../clients/Tester'
 
 const POLL_INTERVAL = 2000
 

src/modules/apps/e2e/specsState.ts

@@ -1,4 +1,4 @@
-import { SpecReport, AppReport, TestReport } from '../../../clients/Tester'
+import type { SpecReport, AppReport, TestReport } from '../../../clients/Tester'
 
 const COMPLETED_STATES = ['passed', 'failed', 'skipped', 'error']
 

src/modules/apps/testCommand.ts

@@ -1,24 +1,23 @@
 import retry from 'async-retry'
 import chalk from 'chalk'
 import { concat, map, prop } from 'ramda'
+import type { PinnedDeps, BatchStream } from 'vtex'
 import {
-  CommandError,
   Builder,
+  createFlowIssueError,
   createPathToFileObject,
   YarnFilesManager,
   fixPinnedDependencies,
-  PinnedDeps,
   toAppLocator,
   logger,
   ManifestEditor,
   getAppRoot,
   listenBuild,
-  BatchStream,
-  runYarnIfPathExists,
   listLocalFiles,
   ProjectUploader,
   validateAppAction,
 } from 'vtex'
+import { runYarnIfPathExists } from 'vtex/lib/modules/utils'
 
 const root = getAppRoot()
 const buildersToRunLocalYarn = ['react', 'node']
@@ -116,7 +115,7 @@ export default async (options) => {
   map(runYarnIfPathExists, buildersToRunLocalYarn)
 
   const onError = {
-    // eslint-disable-next-line @typescript-eslint/camelcase
+    // eslint-disable-next-line
     build_failed: () => {
       logger.error(`App build failed. Waiting for changes...`)
     },
@@ -147,7 +146,7 @@ export default async (options) => {
       }
 
       if (data.code === 'link_on_production') {
-        throw new CommandError(
+        throw createFlowIssueError(
           `Please use a dev workspace to test apps. Create one with (${chalk.blue(
             'vtex use <workspace> -rp'
           )}) to be able to test apps`