Skip to content

Commit

Permalink
feat: basic cases, and test todos
Browse files Browse the repository at this point in the history
* working through thought model

* visitor

* passing test

* more tests for base cases

* test cleanup

* can mock interfaces

* bunch of test todos

* cleanup

* fix tsc

* fix coverage

Co-authored-by: Joel Marcotte <joelm@surveymonkey.com>
  • Loading branch information
joual and joual authored Mar 10, 2020
1 parent 05ec4b0 commit 5bc3036
Show file tree
Hide file tree
Showing 8 changed files with 729 additions and 52 deletions.
52 changes: 13 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,11 @@
<h3 align="center">graphql-ergonomock</h3>

<p align="center">
An awesome README template to jumpstart your projects!
Developer-friendly automock for GraphQL
<br />
<a href="https://github.com/joual/graphql-ergonomock"><strong>Explore the docs »</strong></a>
<br />
<br />
<a href="https://github.com/joual/graphql-ergonomock">View Demo</a>
·
<a href="https://github.com/joual/graphql-ergonomock/issues">Report Bug</a>
·
<a href="https://github.com/joual/graphql-ergonomock/issues">Request Feature</a>
Expand All @@ -49,9 +47,8 @@
- [About The Project](#about-the-project)
- [Built With](#built-with)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Usage](#usage)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [License](#license)
Expand All @@ -78,50 +75,25 @@ A list of commonly used resources that I find helpful are listed in the acknowle

### Built With
This section should list any major frameworks that you built your project using. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.
* [Bootstrap](https://getbootstrap.com)
* [JQuery](https://jquery.com)
* [Laravel](https://laravel.com)
* [Typescript](https://www.typescriptlang.org/)
* [GraphQL](https://graphql.org)
* [Jest](https://jestjs.io)



<!-- GETTING STARTED -->
## Getting Started

This is an example of how you may give instructions on setting up your project locally.
To get a local copy up and running follow these simple example steps.

### Prerequisites

This is an example of how to list things you need to use the software and how to install them.
* npm
```sh
npm install npm@latest -g
```

### Installation

1. Get a free API Key at [https://example.com](https://example.com)
2. Clone the repo
```sh
git clone https://github.com/your_username_/Project-Name.git
```
3. Install NPM packages
```sh
npm install
```shell
npm i graphql-ergonomock --save-dev
```
4. Enter your API in `config.js`
```JS
const API_KEY = 'ENTER YOUR API';
```



<!-- USAGE EXAMPLES -->
## Usage
### Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

_For more examples, please refer to the [Documentation](https://example.com)_
TBD



Expand Down Expand Up @@ -155,14 +127,16 @@ Distributed under the MIT License. See `LICENSE` for more information.
<!-- CONTACT -->
## Contact

Your Name - [@your_twitter](https://twitter.com/your_username) - email@example.com
Your Name - [@your_twitter](https://twitter.com/joual) - email@example.com

Project Link: [https://github.com/your_username/repo_name](https://github.com/your_username/repo_name)
Project Link: [https://github.com/joual/graphql-ergonomock](https://github.com/joual/graphql-ergonomock)



<!-- ACKNOWLEDGEMENTS -->
## Acknowledgements

TBD
* [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet)
* [Img Shields](https://shields.io)
* [Choose an Open Source License](https://choosealicense.com)
Expand Down
6 changes: 6 additions & 0 deletions jest.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,11 @@ module.exports = {
testMatch: ["__tests__/**/*.+(ts|tsx|js)", "**/?(*.)+(spec|test).+(ts|tsx|js)"],
transform: {
"^.+\\.(ts|tsx)$": "ts-jest"
},
setupFilesAfterEnv: ["jest-extended"],
globals: {
"ts-jest": {
diagnostics: false
}
}
};
9 changes: 7 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,11 @@
"devDependencies": {
"@types/jest": "25.1.4",
"jest": "25.1.0",
"jest-extended": "^0.11.5",
"prettier": "1.19.1",
"semantic-release": "17.0.4",
"ts-jest": "25.2.1",
"typescript": "3.8.3",
"semantic-release": "17.0.4"
"typescript": "3.8.3"
},
"renovate": {
"extends": [
Expand All @@ -26,5 +27,9 @@
"repository": {
"type": "git",
"url": "https://github.com/joual/graphql-ergonomock.git"
},
"dependencies": {
"graphql": "^14.6.0",
"graphql-tools": "^4.0.7"
}
}
Loading

0 comments on commit 5bc3036

Please sign in to comment.