# resgen

> CLI tool to generate GraphQL resolver files

Latest version **1.1.6** (published 2024-01-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install resgen
pnpm add resgen
yarn add resgen
bun add resgen
```

Provides the command `rgen`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.6 |
| Published | 2024-01-19 |
| First published | 2022-09-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 45.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Maintainers | segun_os |
| Keywords | graphql, cli, codegen, resolver, typescript, typegraphql, folder, file, graphql file gen, decorator, class resolver |

## Links

- npm: https://www.npmjs.com/package/resgen
- Repository: https://github.com/Segun98/rgen
- Homepage: https://github.com/Segun98/rgen#readme
- Issues: https://github.com/Segun98/rgen/issues
- npm.io page: https://npm.io/package/resgen

## Dependencies (4)

- [yargs](https://npm.io/package/yargs.md) ^17.5.1
- [fs-extra](https://npm.io/package/fs-extra.md) ^10.1.0
- [prettier](https://npm.io/package/prettier.md) ^2.7.1
- [case-anything](https://npm.io/package/case-anything.md) ^2.1.13

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 1.1.6 (latest) — 2024-01-19
- 1.1.5 — 2024-01-19
- 1.1.4 — 2024-01-17
- 1.1.3 — 2022-09-22
- 1.1.2 — 2022-09-20
- 1.1.1 — 2022-09-20
- 1.1.0 — 2022-09-20
- 1.0.9 — 2022-09-20
- 1.0.8 — 2022-09-20
- 1.0.7 — 2022-09-20
- 1.0.6 — 2022-09-20
- 1.0.5 — 2022-09-20
- 1.0.4 — 2022-09-19
- 1.0.3 — 2022-09-19
- 1.0.2 — 2022-09-19
- … 2 more at https://npm.io/package/resgen/versions

## README

# resgen

An opinionated CLI tool to generate GraphQL resolver folders

## Installing

```
Install globally:

$ npm i -g resgen or yarn global add resgen
```

## Commands

```
Options:
      --help     Show help
      --version  Show version
  -n, --name     folder name                                          [required]
  -s, --skip     skip a folder: fields (f), mutations(m), queries (q)
                                               choices: "f", "m", "q"
  --qs --queries specify query names to be generated
  --ms --mutations specify mutation names to be generated
  --fs --fields specify field names to be generated
```

## Usage

```
$ rgen -n User -s f
```

```
The above command generates a 'User' folder with 'mutations' and 'queries' subfolders, skipping 'fields' subfolder.

Note: rgen looks for a 'src' folder in your root directory and creates a 'resolvers' folder in 'src' if it doesn't exist.


| +-- resolvers
|    +-- User
|       +-- mutations
|           +-- index.ts
|        +-- queries
|           +-- index.ts
|      +-- index.ts

```

### Specify queries

```

$ rgen -n User -s f --qs getUser --ms createUser

`getUser` and `createUser`  files are added to the 'queries' and 'mutations' subfolders respectively. These files have a starter Class method.

| +-- resolvers
|    +-- User
|       +-- mutations
|           +-- createUser.ts
|           +-- index.ts
|        +-- queries
|           +-- getUser.ts
|           +-- index.ts
|      +-- index.ts

```

### Skip more than one folder

```
$ rgen -n User -s m q
```

```
The above command skips 'mutations' and 'queries' subfolders.

| +-- resolvers
|    +-- User
|       +-- fields
|          +-- index.ts
|      +-- index.ts

```

```
This tool was modelled after the folder structure I use for my GraphQL server applications

| +-- src
|   +-- resolvers
|     +-- User
|        +-- fields
|          +-- index.ts
|        +-- mutations
|          +-- index.ts
|        +-- queries
|          +-- index.ts
|       +-- index.ts

```

---
_Source: https://npm.io/package/resgen · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._