graphql-codegen-modules-gen - npm Package Compare versions

Comparing version 1.0.5 to 1.1.0

package.json

 {
   "name": "graphql-codegen-modules-gen",
-  "version": "1.0.5",
+  "version": "1.1.0",
   "description": "",
@@ -5,0 +5,0 @@ "scripts": {

README.md

@@ -1,5 +0,141 @@
-# graphql-codegen-modules-gen
+# Welcome to graphql-codegen-modules-gen 🔥
 
-Welcome to graphql-codegen-modules-gen!
+## 💡 Motivation
 
-//Todo...
+To use [Graphql-Modules](https://www.graphql-modules.com/) well, you need to organize your code by modules _(that's the all point 😉)_.
+
+Something like:
+
+```
+...
+├── modules
+│   │
+│   ├── user
+│   │   └── graphql                        <-- client graphql operations
+│   │   │   └── FRAG.user.gql
+│   │   │   └── MUTATION.CreateUser.gql
+│   │   │   └── QUERY.GetUser.gql
+│   │   │   └── QUERY.GetUsers.gql
+│   │   └── resolvers                      <-- server graphql resolvers
+│   │   │   └── _Mutation.ts
+│   │   │   └── _Query.ts
+│   │   │   └── User.ts
+│   │   └── typedefs                       <-- server graphql type definitions
+│   │   │   └── _Mutation.graphql
+│   │   │   └── _Query.graphql
+│   │   │   └── TYPE.User.graphql
+│   │   └── index.ts                       <-- server module creation / orchestration
+│   │
+│   ├── module2
+│   │   └── graphql
+│   │   │   └── ...
+│   │   └── resolvers
+│   │   │   └── ...
+│   │   └── typedefs
+│   │   │   └── ...
+│   │   └── index.ts
+│   │
+│   ├── module3
+│   │   └── ...
+...
+```
+
+In `index.ts` of each module, you will bring all your resolvers and type definitions together. To do this, you can use [GraphQL Tools - Merging resolvers](https://www.graphql-tools.com/docs/schema-merging#merging-resolvers) and the merge will be done at runtime. Unfortunately, it will not work well with bundlers (check [this](https://github.com/ardatan/graphql-tools/issues/2808))
+
+That's why `graphql-codegen-modules-gen` exist. The cli, will generate you `resolvers.ts` and `typedefs.ts` per module at build time. Then, you will compose your `index.ts` with these files.
+
+## 🛠 Usage
+
+### ▶ Install
+
+```
+yarn add graphql-codegen-modules-gen -D
+```
+
+### ▶ Add in your `package.json`
+
+```
+"gen-mg": "yarn graphql-codegen-modules-gen ./src/lib/modules",
+```
+
+_replacing `./src/lib/modules` by the location of your modules_
+
+### ▶ Run it
+
+```
+yarn gen-mg
+```
+
+### ▶ Add it at the end of your usual @graphql-codegen
+
+At the end of your `codegen.yml` file, add:
+
+```
+hooks:
+  afterAllFileWrite:
+    - yarn gen-mg
+```
+
+## ✨ Result
+
+A new folder named `_gen` with `resolvers.ts` and `typedefs.ts` containing everything needed in your `index.ts` file.
+
+```
+...
+├── modules
+│   │
+│   ├── user
+│   │   └── _gen                           <-- ✨ new folder (I put it in the .gitignore)
+│   │   │   └── resolvers.ts               <-- ✨ new file, combine resolvers, export resolvers
+│   │   │   └── typedefs.ts                <-- ✨ new file, merged typedefs, export typedefs
+│   │   └── graphql
+│   │   │   └── FRAG.user.gql
+│   │   │   └── MUTATION.CreateUser.gql
+│   │   │   └── QUERY.GetUser.gql
+│   │   │   └── QUERY.GetUsers.gql
+│   │   └── resolvers
+│   │   │   └── _Mutation.ts
+│   │   │   └── _Query.ts
+│   │   │   └── User.ts
+│   │   └── typedefs
+│   │   │   └── _Mutation.graphql
+│   │   │   └── _Query.graphql
+│   │   │   └── TYPE.User.graphql
+│   │   └── index.ts
+│   │
+│   ├── module2
+│   │   └── graphql
+│   │   │   └── ...
+│   │   └── resolvers
+│   │   │   └── ...
+│   │   └── typedefs
+│   │   │   └── ...
+│   │   └── index.ts
+│   │
+│   ├── module3
+│   │   └── ...
+...
+```
+
+And here is how my `index.ts` file looks like:
+
+```
+import { createModule } from 'graphql-modules';
+import { resolvers } from './_gen/resolvers';
+import { typeDefs } from './_gen/typedefs';
+
+export const userModule = createModule({
+	id: 'user-module',
+	typeDefs,
+	resolvers,
+	providers: [],
+	middlewares: {
+		'*': {
+			'*': []
+		}
+	}
+});
+
+```
+
+## Now, enjoy! 🔥

src/cli.js

 import yargs from "yargs";
 import { hideBin } from "yargs/helpers";
-import { gen } from "./graphql-codegen-modules-gen";
+import { gen } from "./graphql-codegen-modules-gen.js";
 
@@ -5,0 +5,0 @@ const argv =

src/graphql-codegen-modules-gen.js

@@ -1,2 +0,8 @@
-import { readdirSync, writeFileSync, readFileSync, existsSync } from "fs";
+import {
+  readdirSync,
+  writeFileSync,
+  readFileSync,
+  existsSync,
+  mkdirSync,
+} from "fs";
 import { join } from "path";
@@ -60,2 +66,6 @@
 
+      if (!existsSync(join(modulePath, moduleName, genFolder))) {
+        mkdirSync(join(modulePath, moduleName, genFolder));
+      }
+
       writeFileSync(
@@ -62,0 +72,0 @@ join(modulePath, moduleName, genFolder, "resolvers.ts"),

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

13229

increased by47.32%

Lines of code

283

increased by3.28%

Number of lines in readme file

142

increased by2266.67%

No dependency changes