Merge pull request #3 from Siddharth9890/develop

Feat: Release 1.0

Author: Siddharth9890

.eslintignore

@@ -7,5 +7,5 @@ release.config.js
 .husky/*
 scripts/*
 node_modules/*
-build
+dist
 test/*

.github/ISSUE_TEMPLATE/bug_report.md

@@ -28,4 +28,4 @@ If applicable, add screenshots to help explain your problem.
 - Package Manager [e.g. pnpm,npm,yarn]
 
 **Additional context**
-Add any other context about the problem here.
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -16,4 +16,4 @@ A clear and concise description of what you want to happen.
 A clear and concise description of any alternative solutions or features you've considered.
 
 **Additional context**
-Add any other context or screenshots about the feature request here.
+Add any other context or screenshots about the feature request here.

.github/workflows/release.yml

@@ -34,4 +34,4 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-        run: pnpm dlx [email protected]
+        run: pnpm dlx [email protected]

.gitignore

@@ -4,4 +4,6 @@ graphqlTypescriptTypes
 
 coverage
 
-build
+build
+
+dist

README.md

@@ -0,0 +1,95 @@
+![](https://github.com/user-attachments/assets/6e4183f5-4432-4e20-99eb-17f2ce0e0ef7)
+
+# GraphQL SDK Generator
+
+The GraphQL SDK Generator converts GraphQL schemas into JavaScript or TypeScript code, enabling smooth autocomplete and validation for your GraphQL queries.
+
+[![NPM version][npm-image]][npm-url]
+[![Run Eslint & Test cases](https://github.com/Siddharth9890/graphql-sdk-generator/actions/workflows/test.yaml/badge.svg)](https://github.com/Siddharth9890/graphql-sdk-generator/actions/workflows/test.yaml)
+[![Coverage Status][codecov-image]][codecov-url]
+
+<!-- [![NPM downloads][downloads-image]][downloads-url] -->
+
+Read this [quick start guide](https://docs.siddharth9890.com/graphql-sdk-generator) to generate your client and start writing queries
+
+## Features
+
+- ✅ Type completion & validation for enhanced developer experience
+- 🍃 Few runtime dependencies as compared to GraphQL Mesh
+- 🐎 Generate client only if schema changes
+- 🥃 Supports custom headers for requests
+- 🚂  Compatible with both browsers and Node.js, thanks to[graphql-request](https://www.npmjs.com/package/graphql-request)
+
+## Example
+
+1. Install the required package from npm globally recommended
+
+```bash
+npm install -g graphql-sdk-generator
+```
+
+2. Then will create a config.json file with the following contents.
+
+```json
+{
+  "url": "your-graphql-endpoint",
+  "sdkName": "custom-name",
+  "fileType": "ts",
+  "debug": true
+}
+```
+
+3. Run the generator and install additional dependencies required for making requests:
+
+```bash
+// use a custom json file path
+graphql-sdk-generator -c config.json
+npm i @graphql-typed-document-node/core graphql-request
+```
+
+4. Use the generated client to write methods and send data:
+
+```typescript
+import { GraphQLClient } from 'graphql-request';
+import { getSdk } from '../graphqlSDKGenerator/graphqlSDKGenerator';
+
+const initializeSDK = () => {
+  // we can set custom headers
+  const client = new GraphQLClient('https://your-graphql-url', {
+    headers: {},
+  });
+
+  return getSdk(client);
+};
+
+const main = async () => {
+  const sdkInstance = initializeSDK();
+  const companies = await sdkInstance.companyQuery();
+
+  // we get autocomplete here both for the arguments && output.
+  const user = await sdkInstance.insert_usersMutation({
+    objects: { id: 1, name: 'test', rocket: 'spacex' },
+  });
+
+  console.log(companies, user);
+};
+
+main();
+```
+
+## Docs
+
+- All the documententation can be [found here.](https://docs.siddharth9890.com/graphql-sdk-generator)
+
+## Example
+
+- Example repo with config file examples can be [found here](https://github.com/Siddharth9890/space-x-graphql-example)
+
+[Licensed under MIT]().
+
+[npm-image]: https://img.shields.io/npm/v/graphql-sdk-generator
+[npm-url]: https://www.npmjs.com/package/graphql-sdk-generator
+[downloads-image]: https://img.shields.io/npm/v/graphql-sdk-generator
+[downloads-url]: https://www.npmjs.com/package/graphql-sdk-generator
+[codecov-image]: https://codecov.io/gh/Siddharth9890/graphql-sdk-generator/graph/badge.svg?token=H6ROEG8C9L
+[codecov-url]: https://app.codecov.io/gh/Siddharth9890/graphql-sdk-generator

docs/CHANGELOG.md

@@ -0,0 +1,36 @@
+# [1.0.0-develop.5](https://github.com/Siddharth9890/graphql-sdk-generator/compare/v1.0.0-develop.4...v1.0.0-develop.5) (2024-08-31)
+
+
+### Bug Fixes
+
+* modified readme, added contributing guidelines ([4c96619](https://github.com/Siddharth9890/graphql-sdk-generator/commit/4c96619667dc2650513fc0c631c8154d094c336f))
+
+# [1.0.0-develop.4](https://github.com/Siddharth9890/graphql-sdk-generator/compare/v1.0.0-develop.3...v1.0.0-develop.4) (2024-08-30)
+
+### Bug Fixes
+
+- remove prepare command ([df96855](https://github.com/Siddharth9890/graphql-sdk-generator/commit/df96855d0860d6916a6d4857e9f9f19b20cdb3b3))
+
+# [1.0.0-develop.3](https://github.com/Siddharth9890/graphql-sdk-generator/compare/v1.0.0-develop.2...v1.0.0-develop.3) (2024-08-30)
+
+### Bug Fixes
+
+- fixed husky error ([859489c](https://github.com/Siddharth9890/graphql-sdk-generator/commit/859489c0cd07f6c166a167378fdfc606780583e4))
+
+# [1.0.0-develop.2](https://github.com/Siddharth9890/graphql-sdk-generator/compare/v1.0.0-develop.1...v1.0.0-develop.2) (2024-08-29)
+
+### Features
+
+- added readme, improved tests ([dcdc386](https://github.com/Siddharth9890/graphql-sdk-generator/commit/dcdc38613d37014fbe351bf2206e701065c7cf07))
+
+# 1.0.0-develop.1 (2024-08-16)
+
+### Features
+
+- added ajv and commander ([76b94cb](https://github.com/Siddharth9890/graphql-sdk-generator/commit/76b94cb18f4417ae46655a574b6fcc66d2d0397e))
+- added debug mode ([ea9b844](https://github.com/Siddharth9890/graphql-sdk-generator/commit/ea9b8445295b066c6310545593a46d7e0d9d1cab))
+- **ci/cd:** added husky, commit lint ([c50a2dd](https://github.com/Siddharth9890/graphql-sdk-generator/commit/c50a2ddf6bbc68f128458685667fff3c9a279a2d))
+- inital tests ([09a1dce](https://github.com/Siddharth9890/graphql-sdk-generator/commit/09a1dce430ba38212db6ede98a27e699927526b5))
+- initial test code ([f33e5ea](https://github.com/Siddharth9890/graphql-sdk-generator/commit/f33e5ea48099421f8321697641caa81c4d9f592f))
+- jest setup and ci/cd for tests ([ef7718a](https://github.com/Siddharth9890/graphql-sdk-generator/commit/ef7718a66ce968587bdbfd5751efaca2c81d1fed))
+- tests are complete ([d951541](https://github.com/Siddharth9890/graphql-sdk-generator/commit/d9515413fb64c796e90ba227d6c9bd2b6155a8b1))

docs/CODE_BASE_OVERVIEW.md

@@ -0,0 +1,17 @@
+## Code Base Overview
+
+This section will give you an overview of the package codebase. We will also discuss in short the tools we use and the implementation.
+
+- If you want to contribute to the package make sure you read this document and the [Contributing Guildelines](https://github.com/Siddharth9890/graphql-sdk-generator/blob/main/docs/CONTRIBUTING.md) before proceeding.
+
+### Top Level Folder Structure
+
+- The src folder has all the classes which a developer will use. The following are the classes which we are using:-
+
+1. generateCode Folder:- Has all methods to generate types using GraphQL.
+
+- The utils file has basic utilities functions like file related operations.
+
+- The tests folder has all the unit test for the above classes. We are using mocking to mock the SDK.
+
+- We are using prettier and eslint to make sure that code format is maintained. Across all the files.

docs/CODE_OF_CONDUCT.md

@@ -124,4 +124,4 @@ enforcement ladder](https://github.com/mozilla/diversity).
 
 For answers to common questions about this code of conduct, see the FAQ at
 https://www.contributor-covenant.org/faq. Translations are available at
-https://www.contributor-covenant.org/translations.
+https://www.contributor-covenant.org/translations.

docs/CONTRUBUTING.md

@@ -0,0 +1,73 @@
+## How to contribute on package
+
+### Open Development
+
+- All work on the SDK happens directly on GitHub. Both core team members and external contributors send pull requests which go through the same review process.
+
+### Semantic Versioning
+
+- The SDK follows [semantic versioning](https://semver.org/). We release patch versions for critical bugfixes, minor versions for new features or non-essential changes, and major versions for any breaking changes.
+
+- When we make breaking changes, we also introduce deprecation warnings in a minor version so that our users learn about the upcoming changes and migrate their code in advance.
+
+- Every significant change is documented in the [changelog file](https://github.com/Siddharth9890/graphql-sdk-generator/blob/main/docs/CHANGELOG.md).
+
+### Branch Organization
+
+- Make sure to fork the repository before contributing and create the new branch using develop as the base branch.
+
+- Submit all changes directly to the `develop` branch. We use separate branches for development or for upcoming releases. And then after the bug/feature is working we release in main branch.
+
+- Code that lands in `develop` must be compatible with the latest stable release. It may contain additional features, but no breaking changes. We should be able to release a new minor version from the tip of develop at any time.
+
+### Bugs
+
+- **Do not open up a GitHub issue if the bug is a security vulnerability**, and instead refer our [security policy](https://github.com/Siddharth9890/graphql-sdk-generator/blob/main/docs/SECURITY.md).
+
+- **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/Siddharth9890/graphql-sdk-generator/issues).
+
+- If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/Siddharth9890/graphql-sdk-generator/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** demonstrating the expected behavior that is not occurring.
+
+- Once the issue is created you can follow the contributing steps below to start contributing
+
+### **Add a new Feature**
+
+- If you intend to change/add a new feature to the package please discuss with on github issues page. This lets us reach an agreement on your proposal before you put significant effort into it.
+
+- Do not open an PR on GitHub until you have collected positive feedback about the feature from us.
+
+- We will reject pull requests which are not discussed with us regarding feature development.
+
+- Once the issue is created you can follow the contributing steps below to start contributing.
+
+### Contributing Guildeline
+
+- You have Node.js installed at LTS with version 18+ and using pnpm as package manager.
+- You have knowldge of git.
+- Read the [code base overview](https://github.com/Siddharth9890/graphql-sdk-generator/blob/main/docs/CODE_BASE_OVERVIEW.md) to have a short introduction about how we manage/write code.
+
+### Development Workflow
+
+1. After cloning the repo
+
+2. Install dependencies using pnpm
+
+   ```sh
+   pnpm i
+   ```
+
+3. Do you changes and then use dev command
+
+   ```sh
+   pnpm dev
+   ```
+
+4. Run test command to test sdk using jest
+
+   ```sh
+   pnpm test
+   ```
+
+- We recommend to keep test coverage above 90% this way we make sure that the feature/bug you add don't reduce the test coverage. Also make sure that there are no linting errors as we use prettier and eslint to maintain proper code structure.
+
+Thanks!