fix(listr-error): changes the types for the listrerror

- updates the jest configuration where snapshots does not include the prototype names anymore fix #653
listr2 · Sep 5, 2022 · 306a304 · 306a304
1 parent 66e306e
commit 306a304
Show file tree

Hide file tree

Showing 26 changed files with 1,533 additions and 1,497 deletions.
diff --git a/.github/workflows/nodejs.yml b/.github/workflows/nodejs.yml
@@ -15,7 +15,7 @@ jobs:
     strategy:
       matrix:
         node-version:
-          - 16.x
+          - 18.x
     steps:
       - uses: actions/checkout@v2
       - name: Use Node.js ${{ matrix.node-version }}
@@ -30,9 +30,9 @@ jobs:
     strategy:
       matrix:
         node-version:
-          - 12.x
           - 14.x
           - 16.x
+          - 18.x
         os:
           - ubuntu-latest
     steps:
@@ -49,7 +49,7 @@ jobs:
     strategy:
       matrix:
         node-version:
-          - 16.x
+          - 18.x
     steps:
       - uses: actions/checkout@v2
       - name: Use Node.js ${{ matrix.node-version }}

diff --git a/.github/workflows/semantic-release.yml b/.github/workflows/semantic-release.yml
@@ -24,8 +24,7 @@ jobs:
           dry_run: true
           branches: |
             [
-              "master",
-              "develop"
+              "*"
             ]
           extra_plugins: |
             @semantic-release/changelog

diff --git a/.github/workflows/sync.yml b/.github/workflows/sync.yml
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -2,13 +2,12 @@
   "version": "0.2.0",
   "configurations": [
     {
-      "type": "node2",
+      "type": "node",
       "name": "attach",
       "port": 9229,
       "request": "attach",
       "skipFiles": ["<node_internals>/**"],
       "localRoot": "${workspaceFolder}",
-      "remoteRoot": "/data/app",
       "sourceMaps": true
     }
   ]

diff --git a/package.json b/package.json
@@ -80,28 +80,28 @@
   },
   "devDependencies": {
     "@cenk1cenk2/cz-cc": "^1.5.3",
-    "@cenk1cenk2/eslint-config": "2.5.21",
+    "@cenk1cenk2/eslint-config": "2.5.26",
     "@types/clone": "^2.1.1",
-    "@types/jest": "^28.1.6",
-    "@types/node": "^18.6.1",
+    "@types/jest": "^29.0.0",
+    "@types/node": "^18.7.15",
     "@types/through": "^0.0.30",
     "@types/wrap-ansi": "^3.0.0",
     "delay": "^5.0.0",
     "enquirer": "^2.3.6",
-    "eslint": "^8.21.0",
-    "jest": "^28.1.3",
+    "eslint": "^8.23.0",
+    "jest": "^29.0.2",
     "jest-mock-process": "^2.0.0",
     "lint-staged": "^13.0.3",
     "prettier": "^2.7.1",
     "rimraf": "^3.0.2",
     "simple-git-hooks": "^2.8.0",
-    "ts-jest": "^28.0.7",
+    "ts-jest": "^28.0.8",
     "ts-node": "^10.9.1",
-    "tsconfig-paths": "^4.0.0",
-    "tsup": "6.2.1",
-    "typedoc": "^0.23.10",
-    "typedoc-plugin-markdown": "^3.13.4",
-    "typescript": "^4.7.4"
+    "tsconfig-paths": "^4.1.0",
+    "tsup": "6.2.3",
+    "typedoc": "^0.23.14",
+    "typedoc-plugin-markdown": "^3.13.6",
+    "typescript": "^4.8.2"
   },
   "peerDependencies": {
     "enquirer": ">= 2.3.0 < 3"

diff --git a/src/interfaces/listr-error.interface.ts b/src/interfaces/listr-error.interface.ts
@@ -1,9 +1,10 @@
+import type { ListrContext } from './listr.interface'
 import type { ListrRendererFactory } from './renderer.interface'
 import type { Task } from '@lib/task'
 import { cloneObject } from '@utils/general'
 
 /** The internal error handling mechanism.. */
-export class ListrError<Ctx extends Record<PropertyKey, any> = Record<PropertyKey, any>> extends Error {
+export class ListrError<Ctx extends ListrContext = ListrContext> extends Error {
   public path: string
   public ctx: Ctx
 

diff --git a/src/lib/task-wrapper.ts b/src/lib/task-wrapper.ts
@@ -12,7 +12,7 @@ import { createPrompt, destroyPrompt } from '@utils/prompt'
 import type { PromptOptions } from '@utils/prompt.interface'
 
 /**
- * Extend the task to have more functionality while accesing from the outside.
+ * Extend the task to have more functionality while accessing from the outside.
  */
 export class TaskWrapper<Ctx, Renderer extends ListrRendererFactory> {
   constructor (public task: Task<Ctx, ListrRendererFactory>, public errors: ListrError<Ctx>[], private options: ListrBaseClassOptions<Ctx, any, any>) {}
@@ -94,7 +94,7 @@ export class TaskWrapper<Ctx, Renderer extends ListrRendererFactory> {
    * Pass stream of data to internal stdout.
    *
    * Since Listr2 takes control of process.stdout utilizing the default renderer, any data outputted to process.stdout
-   * will corupt its looks.
+   * will corrupt its looks.
    *
    * This returns a fake stream to pass any stream inside Listr as task data.
    */

diff --git a/src/listr.ts b/src/listr.ts
@@ -20,7 +20,11 @@ import { getRenderer } from '@utils/renderer'
 /**
  * Creates a new set of Listr2 task list.
  */
-export class Listr<Ctx = ListrContext, Renderer extends ListrRendererValue = ListrDefaultRendererValue, FallbackRenderer extends ListrRendererValue = ListrFallbackRendererValue> {
+export class Listr<
+  Ctx extends ListrContext = ListrContext,
+  Renderer extends ListrRendererValue = ListrDefaultRendererValue,
+  FallbackRenderer extends ListrRendererValue = ListrFallbackRendererValue
+> {
   public tasks: Task<Ctx, ListrGetRendererClassFromValue<Renderer>>[] = []
   public err: ListrError<Ctx>[] = []
   public ctx: Ctx

diff --git a/src/manager.ts b/src/manager.ts
@@ -6,7 +6,7 @@ import type { ListrGetRendererClassFromValue, ListrRendererValue } from '@interf
 /**
  * Creates a new Listr2 task manager.
  *
- * Useful for creating a single instace of Listr2 with pre-set settings.
+ * Useful for creating a single instance of Listr2 with pre-set settings.
  */
 export class Manager<Ctx = ListrContext, Renderer extends ListrRendererValue = 'default', FallbackRenderer extends ListrRendererValue = 'verbose'> {
   public err: ListrError[] = []

diff --git a/src/utils/logger.spec.ts b/src/utils/logger.spec.ts
@@ -52,8 +52,8 @@ describe('logger', () => {
     testForAllExcept(instances, error, 1, {
       onOne: () => {
         expect(error.mock.calls).toMatchInlineSnapshot(`
-        Array [
-          Array [
+        [
+          [
             "[FAILED] test message",
           ],
         ]
@@ -70,8 +70,8 @@ describe('logger', () => {
     testForAllExcept(instances, info, 1, {
       onOne: () => {
         expect(info.mock.calls).toMatchInlineSnapshot(`
-        Array [
-          Array [
+        [
+          [
             "[SKIPPED] test message",
           ],
         ]
@@ -88,8 +88,8 @@ describe('logger', () => {
     testForAllExcept(instances, log, 1, {
       onOne: () => {
         expect(log.mock.calls).toMatchInlineSnapshot(`
-        Array [
-          Array [
+        [
+          [
             "[SUCCESS] test message",
           ],
         ]
@@ -106,8 +106,8 @@ describe('logger', () => {
     testForAllExcept(instances, info, 1, {
       onOne: () => {
         expect(info.mock.calls).toMatchInlineSnapshot(`
-        Array [
-          Array [
+        [
+          [
             "[DATA] test message",
           ],
         ]
@@ -124,8 +124,8 @@ describe('logger', () => {
     testForAllExcept(instances, log, 1, {
       onOne: () => {
         expect(log.mock.calls).toMatchInlineSnapshot(`
-        Array [
-          Array [
+        [
+          [
             "[STARTED] test message",
           ],
         ]
@@ -142,8 +142,8 @@ describe('logger', () => {
     testForAllExcept(instances, info, 1, {
       onOne: () => {
         expect(info.mock.calls).toMatchInlineSnapshot(`
-        Array [
-          Array [
+        [
+          [
             "[TITLE] test message",
           ],
         ]
@@ -160,8 +160,8 @@ describe('logger', () => {
     testForAllExcept(instances, warn, 1, {
       onOne: () => {
         expect(warn.mock.calls).toMatchInlineSnapshot(`
-        Array [
-          Array [
+        [
+          [
             "[ROLLBACK] test message",
           ],
         ]
@@ -178,8 +178,8 @@ describe('logger', () => {
     testForAllExcept(instances, warn, 1, {
       onOne: () => {
         expect(warn.mock.calls).toMatchInlineSnapshot(`
-        Array [
-          Array [
+        [
+          [
             "[RETRY] test message",
           ],
         ]
@@ -200,8 +200,8 @@ describe('logger', () => {
     testForAllExcept(instances, info, 1, {
       onOne: () => {
         expect(info.mock.calls).toMatchInlineSnapshot(`
-        Array [
-          Array [
+        [
+          [
             "[DATA] THIS IS A LONG LONG MESSAGE
         [DATA] THIS IS A LONG LONG MESSAGE
         [DATA] THIS IS A LONG LONG MESSAGE

diff --git a/tests/__snapshots__/renderer-access-parent.e2e-spec.ts.snap b/tests/__snapshots__/renderer-access-parent.e2e-spec.ts.snap
@@ -1,70 +1,70 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`show subtasks should be able to change the title of parent from subtask: nvFwliir81dQSzoa7xPXaq0E1lauH674-err 1`] = `Array []`;
+exports[`show subtasks should be able to change the title of parent from subtask: nvFwliir81dQSzoa7xPXaq0E1lauH674-err 1`] = `[]`;
 
-exports[`show subtasks should be able to change the title of parent from subtask: nvFwliir81dQSzoa7xPXaq0E1lauH674-exit 1`] = `Array []`;
+exports[`show subtasks should be able to change the title of parent from subtask: nvFwliir81dQSzoa7xPXaq0E1lauH674-exit 1`] = `[]`;
 
 exports[`show subtasks should be able to change the title of parent from subtask: nvFwliir81dQSzoa7xPXaq0E1lauH674-out 1`] = `
-Array [
-  Array [
+[
+  [
     "◼ This task will execute.
 ",
   ],
-  Array [
+  [
     "[2K[1A[2K[G❯ This task will execute.
 ",
   ],
-  Array [
+  [
     "[2K[1A[2K[G❯ This task will execute.
   ◼ This is a subtask.
 ",
   ],
-  Array [
+  [
     "[2K[1A[2K[1A[2K[G❯ This task will execute.
   ◼ This is a subtask.
   ◼ This is a subtask.
 ",
   ],
-  Array [
+  [
     "[2K[1A[2K[1A[2K[1A[2K[G❯ This task will execute.
   ❯ This is a subtask.
   ◼ This is a subtask.
 ",
   ],
-  Array [
+  [
     "[2K[1A[2K[1A[2K[1A[2K[G❯ Title changed from subtask.
   ❯ This is a subtask.
   ◼ This is a subtask.
 ",
   ],
-  Array [
+  [
     "[2K[1A[2K[1A[2K[1A[2K[G❯ Title changed from subtask.
   ✔ This is a subtask.
   ◼ This is a subtask.
 ",
   ],
-  Array [
+  [
     "[2K[1A[2K[1A[2K[1A[2K[G❯ Title changed from subtask.
   ✔ This is a subtask.
   ❯ This is a subtask.
 ",
   ],
-  Array [
+  [
     "[2K[1A[2K[1A[2K[1A[2K[G❯ Title changed from subtask.
   ✔ This is a subtask.
   ✔ This is a subtask.
 ",
   ],
-  Array [
+  [
     "[2K[1A[2K[1A[2K[1A[2K[G✔ Title changed from subtask.
 ",
   ],
-  Array [
+  [
     "[2K[1A[2K[G",
   ],
-  Array [
+  [
     "✔ Title changed from subtask.
 ",
   ],
 ]
-`;
+`;