Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Typescript-TDD/ts-auto-mock

Typescript transformer to unlock automatic mock creation for interfaces and classes
https://github.com/Typescript-TDD/ts-auto-mock

automatic fake mock mocking testing typescript typescript-transformer

Last synced: 1 day ago
JSON representation

Typescript transformer to unlock automatic mock creation for interfaces and classes

Host: GitHub
URL: https://github.com/Typescript-TDD/ts-auto-mock
Owner: Typescript-TDD
License: mit
Created: 2019-01-02T15:24:32.000Z (almost 6 years ago)
Default Branch: master
Last Pushed: 2024-10-29T09:07:37.000Z (14 days ago)
Last Synced: 2024-10-29T10:56:50.851Z (13 days ago)
Topics: automatic, fake, mock, mocking, testing, typescript, typescript-transformer
Language: TypeScript
Homepage: https://typescript-tdd.github.io/ts-auto-mock
Size: 38 MB
Stars: 600
Watchers: 6
Forks: 16
Open Issues: 29
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/contributing.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

README

        # TS auto mock

![Test](https://github.com/Typescript-TDD/ts-auto-mock/workflows/Test/badge.svg)

[![npm version](https://badge.fury.io/js/ts-auto-mock.svg)](https://badge.fury.io/js/ts-auto-mock)

[![Downloads](https://img.shields.io/npm/dw/ts-auto-mock.svg)](https://www.npmjs.com/package/ts-auto-mock)

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

![GitHub Sponsor](https://img.shields.io/github/sponsors/uittorio?label=sponsor&logo=GitHub)

[![All Contributors](https://img.shields.io/badge/all_contributors-7-orange.svg?style=flat-square)](#contributors-)

![Slack](docs/slack_small.png) Need help? Join us

on [Slack](https://join.slack.com/t/typescripttdd/shared_invite/enQtODk3MjQwNzUwNTk2LTMzNjdlZTNmMmY3Nzg2NDNiZDA1YzJmZjk2NjcwZjQwODQ3YzE5NGZjM2Q4MzZjYWNiMWE4MGU0NjEzM2E5YzE)

# :warning: This repository is now no longer maintained for new features development :warning:

A few years ago we've created this project with the idea in mind that typescript transformers would be easier

to

configure.

Unfortunately the typescript team has no intention to improve the developer experience. You can see more information at

this [link](https://github.com/Microsoft/TypeScript/issues/14419).

We believe that stop developing new features is the best decision to inform who is currently using it and who

find it for the first time.

We will keep fixing bugs and vulnerability.

Other reasons why this library might not be for you:

- Typescript transformers works only when using the tsc typescript compiler. If you are using esbuild or swc you will

  not

  be able to use this library.

- Test double are a double-edge sword. They have to be used carefully and at the right time. Increasing the number of

  test doubles could decrease the value of your tests. The amount of configuration required by this library might not

  justify the amount of test doubles that your application requires.

A TypeScript transformer that will allow you to create mocks for any types (interfaces, classes, etc.) without the need

to create manual fakes/mocks.

## [API Documentation](https://typescript-tdd.github.io/ts-auto-mock)

#### [Installation](https://typescript-tdd.github.io/ts-auto-mock/installation)

#### [Usage](https://typescript-tdd.github.io/ts-auto-mock/create-mock)

#### Quick overview

```ts

import { createMock } from 'ts-auto-mock';

interface Person {

    id: string;

    getName(): string;

    details: {

        phone: number

    }

}

const mock = createMock();

mock.id // ""

mock.getName() // ""

mock.details // "{ phone: 0 }"

```

* If you are interested to use it with jasmine please go

  to [jasmine-ts-auto-mock](https://github.com/Typescript-TDD/jasmine-ts-auto-mock)

* If you are interested to use it with jest please go

  to [jest-ts-auto-mock](https://github.com/Typescript-TDD/jest-ts-auto-mock)

## Changelog

Find the changelog here: [Changelog](CHANGELOG.md).

## Roadmap

You can find the roadmap of this project on the Wiki

page: [Roadmap](https://github.com/Typescript-TDD/ts-auto-mock/wiki/Roadmap).

## Do you want to contribute?

* [Check how to make changes to the code base](https://typescript-tdd.github.io/ts-auto-mock/local-development)

## Authors

* [**Vittorio Guerriero**](https://github.com/uittorio)

* [**Giulio Caprino**](https://github.com/pmyl)

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    
_{Artem Kornev}
🐛 💻

    
_Fabian
🐛 💻

    
_{Geoffrey 'C0ZEN' Testelin}
🐛 💻 🤔 🔧

    
_{Giulio Caprino}
💬 💻 📖 🤔 🚇 🚧 📆

    
_Marc
🐛 💻

    
_{Martin Jesper Low Madsen}
🐛 💻 🤔

    
_{Vittorio Guerriero}
💬 💻 🤔 🚇 🚧 📆 🔧

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification.

Contributions of any kind welcome!

## Sponsor ✨

Thanks to these people

  

    

        

            


        _{Kenta Mukai}

        

    

  

## License

This project is licensed under the [MIT License](LICENSE.md)