npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

jest-parser

v1.1.1

Published

regexp-base library that parses jest files into an object

Downloads

1,330

Readme

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.

Mind this library is RegExp-based. See disclaimer below.

Installation

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

Features

Parses jest syntax

Take the following jest file:

describe('Some describe title 1', () => {
    // some code 1
    /* eslint-disable-next-line */
    describe.only('Nested describe 1', () => {
        // some setup
        // some more setup

        it('does this and that', () => {
            // code of what it does
            expect(true).toBeTruthy()
        })
    })
})

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('Some jest file', readFileSync('jest-test.js').toString()))

would produce the following output:

{
  "title": "Some jest file",
  "describe": [
    {
      "title": "Some describe title 1",
      // entire file code
      "code": "// some code 1\n/* eslint-disable-next-line */\ndescribe.only('Nested describe 1', () => {\n    // some setup\n    // some more setup\n\n    it('does this and that', () => {\n        // code of what it does\n        expect(true).toBeTruthy()\n    })\n})",
      "start": 0,
      "end": 12,
      "describe": [
        {
          "title": "Nested describe 1",
          // piece of code within "Nested describe 1"
          "code": "// some setup\n// some more setup\n\nit('does this and that', () => {\n    // code of what it does\n    expect(true).toBeTruthy()\n})",
          // position where "Nested describe 1" starts in parent's code
          "start": 2,
          // position where "Nested describe 1" ends in parent's code
          "end": 10,
          "flag": "only", // flags the test scenario might have (only, skip, todo...)
          "describe": [],
          "test": [],
          "it": [
            {
              "title": "does this and that",
              "code": "// code of what it does\nexpect(true).toBeTruthy()",
              "start": 3,
              "end": 6,
              "describe": [],
              "test": [],
              "it": []
            }
          ]
        }
      ],
      "test": [],
      "it": []
    },
    {
      "title": "Some describe title 2",
      "code": "// some code 2",
      "start": 14,
      "end": 16,
      "describe": [],
      "test": [],
      "it": []
    },
    {
      "title": "Some describe title 3",
      "code": "// some code 3",
      "start": 18,
      "end": 20,
      "describe": [],
      "test": [],
      "it": []
    }
  ],
  "test": [],
  "it": []
}

Disclaimer

Mind this library is RegExp-based (not AST-based). That said, it might not work well using funky syntax.

One known scenario it won't work is a oneliner test (see discussion here):

// none of this would work
it('one line explicit-return arrow function', () => { return Promise.resolve(true) })
it('one line implicit-return arrow function', () => Promise.resolve(true))
it('multiline implicit-return arrow function', () =>
    Promise.resolve(true)
)

License

MIT

© 2021-present Martin Rafael Gonzalez [email protected]