https://github.com/wednesday-solutions/negt-cli

GraphQL auto generation cli app.
https://github.com/wednesday-solutions/negt-cli

automation node-express-grapqhl scaffolding

Last synced: about 1 year ago
JSON representation

GraphQL auto generation cli app.

• Host: GitHub
• URL: https://github.com/wednesday-solutions/negt-cli
• Owner: wednesday-solutions
• License: mit
• Created: 2022-11-23T07:16:53.000Z (over 3 years ago)
• Default Branch: develop
• Last Pushed: 2023-04-10T12:20:59.000Z (about 3 years ago)
• Last Synced: 2025-04-13T21:13:03.254Z (about 1 year ago)
• Topics: automation, node-express-grapqhl, scaffolding
• Language: Go
• Homepage: https://wednesday.is/building-products
• Size: 44.9 MB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          




  

    

  

  


    

NEGT CLI

  


  


A CLI tool that works with the Node Express GraphQL Template and allows you to create queries, mutations and its scaffold tests for graphql models and stitches them all together preventing wastage of time in setup and boilerplate code.

  


---

  


    



      Expert teams of digital product strategists, developers, and designers.

    

  


  


    

      

    

    

      

    

  


##

  


    

Built using Node Express GraphQL Template

    

  




[![Go Report Card](https://goreportcard.com/badge/github.com/wednesday-solutions/negt)](https://goreportcard.com/report/github.com/wednesday-solutions/negt) ![example workflow](https://github.com/wednesday-solutions/negt-cli/actions/workflows/ci.yml/badge.svg) ![example workflow](https://github.com/wednesday-solutions/negt-cli/actions/workflows/product-release.yml/badge.svg) [![GoDoc](https://godoc.org/github.com/wednesday-solutions/negt?status.svg)](https://godoc.org/github.com/wednesday-solutions/negt)

## Installation

    go install github.com/wednesday-solutions/negt@latest

    

## Examples of generated files



  
models

  
tests

  
mock data



## Generating GraphQL models and tests



## Documentation

Help


To get a list of commands and usage hints use


    negt --help

    

    negt gqlgen --help

    

## Creating a new NEGT Application

     negt gqlgen init

     



Hint: If you are using Node-Express-GraphQL-Template, it will create directories `server/gql/models` otherwise `gql/models`.

## Creating GraphQL models

    negt gqlgen model

https://user-images.githubusercontent.com/114065489/207503280-004171e6-2efe-4f52-9b6f-842e202cf171.mp4

## Generated files contain the following

    Files :-

        1. index.js                 - It contains all relations of the gql model.

        2. models.js                - It contains fields and GraphQLObjectType of the model.

        3. query.js                 - It contains query of the model.

        4. list.js                  - It contains connection and query list of the model.

        5. mutation.js              - It contains the mutation fields and mutation object.

        6. customCreateMutation.js  - If you need custom resolvers for the GraphQL model, you can say yes for the question in the CLI.

           If you said yes, then it will create 3 custom resolver files. This file contains the custom create mutation object.

        7. customUpdateMutation.js  - It contains the custom update mutation object.

        8. customDeleteMutation.js  - It contains the custom delete mutation object.

It will create its test files also in `gql/models//tests` directory.

    Test files :-

        1. index.test.js                - It contains the test cases of index.js file. It checks the importing is working properly.

        2. models.test.js               - It contains the test case for type of the GraphQL model.

        3. query.test.js                - It contains the test case of GraphQL query.

        4. list.test.js                 - It contains the test case of GraphQL query list.

        5. mutation.test.js             - It contains the test cases of GraphQL mutations like creating, updating and deleting.

        6. pagination.test.js           - It contains the test case for checking the pagination of GraphQL queries is working properly.

           Most of the case, we don't need to change this file anymore. So it will create this test case in a different file.

        7. customCreateMutation.test.js - It contains the test case of custom create mutation resolver.

        8. customUpdateMutation.test.js - It contains the test case of custom update mutation resolver.

        9. customDeleteMutation.test.js - It contains the test case of custom delete mutation resolver.

Also, it will create mockData file for the model in `utils/testUtils` directory.

## Projects using it

Node Express GraphQL Template


## Licence

This project is released under the MIT License.