jest-parser

Parses jest tests into an object

Manifesto

Since nothing describes better what a software does than its tests, in order to make easy the documentation process, I want to be able to parse the content of a jest file.

Installation

$ npm i jest-parser --save
# or
$ yarn add jest-parser

Features

Parses jest syntax

Parses jest syntax

Take the following jest file:

describe('Some describe title 1', () => {
  // some code 1
  describe('Nested describe 1', () => {
    it('does this and that', () => {
      // code of what it does
    })
  })
})

describe('Some describe title 2', () => {
  // some code 2
})

describe('Some describe title 3', () => {
  // some code 3
})

...and the following script:

const { parse } = require('jest-parser')
const { readFileSync } = require('fs')

console.log(parse('My test file', readFileSync('jest-test.js').toString()))

would produce the following output:

{
  "title": "My test file",
  "describe": [
    {
      "title": "Some describe title 1",
      "code": "// some code 1\ndescribe('Nested describe 1', () => {\n    it('does this and that', () => {\n        // code of what it does\n    })\n})",
      "start": 0,
      "end": 7,
      "describe": [
        {
          "title": "Nested describe 1",
          "code": "it('does this and that', () => {\n    // code of what it does\n})",
          "start": 1,
          "end": 5,
          "describe": [],
          "test": [],
          "it": [
            {
              "title": "does this and that",
              "code": "// code of what it does",
              "start": 0,
              "end": 2,
              "describe": [],
              "test": [],
              "it": []
            }
          ]
        }
      ],
      "test": [],
      "it": []
    },
    {
      "title": "Some describe title 2",
      "code": "// some code 2",
      "start": 9,
      "end": 11,
      "describe": [],
      "test": [],
      "it": []
    },
    {
      "title": "Some describe title 3",
      "code": "// some code 3",
      "start": 13,
      "end": 15,
      "describe": [],
      "test": [],
      "it": []
    }
  ],
  "test": [],
  "it": []
}

License

MIT

TSMMark / jest-parser