https://github.com/efekos/es-test

Test runner designed for TS+ESM environments
https://github.com/efekos/es-test

es es-test esm esmodule esmodules javascript-test test test-esm test-js test-ts testing typescript-test

Last synced: about 2 months ago
JSON representation

Test runner designed for TS+ESM environments

• Host: GitHub
• URL: https://github.com/efekos/es-test
• Owner: efekos
• License: mit
• Created: 2024-04-17T14:49:59.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-08-10T09:50:07.000Z (5 months ago)
• Last Synced: 2024-08-10T21:58:55.111Z (5 months ago)
• Topics: es, es-test, esm, esmodule, esmodules, javascript-test, test, test-esm, test-js, test-ts, testing, typescript-test
• Language: TypeScript
• Homepage:
• Size: 185 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# es-test `v1.0.7`

> Simple test runner to use in ESM modules.

After trying to use jest with an esm module for so long i just gave up and made this module. This module will scan for every .test.js or .spec.js file in current workspace and try

running them. You can limit scanning into one directory by passing in the dir name like this:

- `C:\myapp> estest` - Scans C:\myapp

- `C:\myapp> estest dist` - Scans C:\myapp\dist

# Usage

* `npm i -D @efekos/es-test`

* Create a test script to run estest: `"estest"` (Also create `pretest` to compile if you use TypeScript)

* Write some tests

* Run `npm test`

## Writing tests

```javascript

import {describe,it,inst} from '@efekos/es-test/bin/testRunner.js' // You excplicitly have to import from testRunner.js i have no idea why

import {expect} from 'chai' // or any other assertion module

describe('9 + 10',()=>{ // create a suite with describe

    it('should be 21',()=>{ // create a test with it

        expect(9+10).to.be.equal(21);

    });

});

function isNumber(s){

    return /[+-]?\d+(\.\d+)?/.test(s);

}

describe('isNumber function',()=>{

    it('should match all the numbers',()=>{

        inst(()=>{ // Create different cases with inst

            expect(isNumber('5')).to.be.equal(true)

        });

        

        inst(()=>{

            expect(isNumber('455.34')).to.be.equal(true)

        });

        

        inst(()=>{

            expect(isNumber('-145')).to.be.equal(true)

        });

        

        inst(()=>{

            expect(isNumber('-3465.0000000003')).to.be.equal(true)

        });

        

        inst(()=>{

            expect(isNumber('-.3495')).to.be.equal(true)

        });

        

        inst(()=>{

            expect(isNumber('+.25')).to.be.equal(true)

        });

    },true /*this true makes this test a cased test*/);

});

```

## Handling errors

```javascript

import {onError} from '@efekos/es-test/bin/testRunner.js'

onError('CustomError',(err)=>{ // Handle custom error types

    return {

        passed:false,

        expected:err.exp,

        actual:err.act,

        formatMode:'none' // 'str' will make every difference in actual value look red instead of making it completely red in summary

    }

})

```