feat: provide validate-skipped-stacks (#44)

issues:
* feat: provide validate-skipped-stacks (#43)

commits:
* feat: provide validate-skipped-stacks (90faa6e)

README.md

@@ -54,11 +54,26 @@ stackTrace(
 )
 ```
 
+## Utils
+```javascript
+import {
+  /**
+   * A utility to validate a name or a list of names of stack traces that need to be skipped.
+   *
+   * @see https://github.com/mnrendra/validate-skipped-stacks
+   */
+  validateSkippedStacks
+} from '@mnrendra/stack-trace'
+```
+
 ## Types
 ```typescript
 import type {
   CallSite, // NodeJS.CallSite
-  Options // { limit?: number }
+  Options, // { limit?: number },
+  // @mnrendra/validate-skipped-stacks
+  SkippedStacks,
+  ValidSkippedStacks
 } from '@mnrendra/stack-trace'
 ```
 

__tests__/index.ts

@@ -1,4 +1,4 @@
-import { stackTrace } from '..'
+import { stackTrace, validateSkippedStacks } from '..'
 
 describe('Test all features:', () => {
   describe('Test `stackTrace` feature:', () => {
@@ -18,13 +18,20 @@ describe('Test all features:', () => {
       ])
     })
 
-    it('Should only return the first default value when given an option with `limit` is set to `1`!', () => {
+    it('Should only return the first default value when given an option with `limit` is set to `1` and first argument is set to `undefined`!', () => {
       const result = stackTrace(undefined, { limit: 1 })
       expect(result).toEqual([
         expect.any(Object)
       ])
     })
 
+    it('Should only return the first default value when given an option with `limit` is set to `1` and first argument is set to `null`!', () => {
+      const result = stackTrace(null, { limit: 1 })
+      expect(result).toEqual([
+        expect.any(Object)
+      ])
+    })
+
     describe('Test properties of the first default value from the `stackTrace` when given an empty argument:', () => {
       it('Should return a `string` (a type name) when invoke the `getTypeName` property!', () => {
         const result = stackTrace()
@@ -38,7 +45,7 @@ describe('Test all features:', () => {
 
       it('Should return a `number` (a line number) when invoke the `getLineNumber` property!', () => {
         const result = stackTrace()
-        expect(result[0].getLineNumber()).toBe(37)
+        expect(result[0].getLineNumber()).toBe(43)
       })
 
       it('Should return a `number` (a column number) when invoke the `getColumnNumber` property!', () => {
@@ -92,4 +99,27 @@ describe('Test all features:', () => {
       })
     })
   })
+
+  describe('Test `validateSkippedStacks` feature:', () => {
+    it('Should return a valid skipped-stacks when given a skipped-stack!', () => {
+      const received = validateSkippedStacks('SKIPPED_STACK')
+      const expected = ['SKIPPED_STACK']
+
+      expect(received).toEqual(expected)
+    })
+
+    it('Should return a valid skipped-stacks when given a skipped-stack and a `skippedStacks` option with a string!', () => {
+      const received = validateSkippedStacks('SKIPPED_STACK', 'any')
+      const expected = ['SKIPPED_STACK', 'any']
+
+      expect(received).toEqual(expected)
+    })
+
+    it('Should return a valid skipped-stacks when given a skipped-stack and a `skippedStacks` option with a list of strings!', () => {
+      const received = validateSkippedStacks('SKIPPED_STACK', ['any'])
+      const expected = ['SKIPPED_STACK', 'any']
+
+      expect(received).toEqual(expected)
+    })
+  })
 })

package.json

@@ -24,6 +24,9 @@
     "url": "https://github.com/mnrendra/stack-trace/issues"
   },
   "homepage": "https://github.com/mnrendra/stack-trace#readme",
+  "dependencies": {
+    "@mnrendra/validate-skipped-stacks": "^2.0.1"
+  },
   "devDependencies": {
     "@semantic-release/exec": "^6.0.3",
     "@semantic-release/git": "^10.0.1",

src/index.ts

@@ -1,5 +1,11 @@
 import main from './main'
 
+export {
+  type SkippedStacks,
+  type ValidSkippedStacks,
+  validateSkippedStacks
+} from '@mnrendra/validate-skipped-stacks'
+
 export type {
   CallSite,
   Options