gql.tada 1.0.0-beta.2 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +29 -55
  2. package/package.json +3 -2
package/README.md CHANGED
@@ -23,7 +23,26 @@ In short, `gql.tada`,
23
23
  Since this is all done in the TypeScript type system and type checker, this all happens
24
24
  while you edit your GraphQL front-end code and is always accurate.
25
25
 
26
- ### Let’s take a look!
26
+ In short, **with `gql.tada` and [GraphQLSP](https://github.com/0no-co/graphqlsp) you get on-the-fly, automatically typed GraphQL documents
27
+ with full editor feedback, auto-completion, and type hints!**
28
+
29
+ ## 📃 [Documentation](https://gql-tada.0no.co)
30
+
31
+ Check out the [“Get Started” section’s Installation page](https://gql-tada.0no.co/get-started/installation/) in the documentation.
32
+
33
+ - Get Started
34
+ - **[Introduction](https://gql-tada.0no.co)** — everything you need to know
35
+ - **[Installation](https://gql-tada.0no.co/get-started/installation)** — an installation guide
36
+ - **[Writing GraphQL](https://gql-tada.0no.co/get-started/writing-graphql/)** — how to write GraphQL documents
37
+ - API Reference
38
+ - **[`gql.tada` API](https://gql-tada.0no.co/reference/gql-tada-api/)** — `gql.tada` API Reference docs
39
+ - **[GraphQLSP Config](https://gql-tada.0no.co/reference/graphqlsp-config/)** — GraphQLSP Configuration Reference docs
40
+
41
+ Furthermore, all APIs and packages are self-documented using TSDocs. If you’re using a language
42
+ server for TypeScript, the documentation for each API should pop up in your editor when hovering
43
+ `gql.tada`’s code and APIs.
44
+
45
+ ## 🔎 Let’s take a look!
27
46
 
28
47
  ```ts
29
48
  import { graphql } from 'gql.tada';
@@ -56,60 +75,15 @@ const query = graphql(
56
75
  );
57
76
  ```
58
77
 
59
- ## 💾 Setup
60
-
61
- Install `gql.tada` using your project’s package manager,
62
-
63
- ```sh
64
- npm i gql.tada
65
- pnpm add graphql
66
- yarn add gql.tada
67
- bun add graphql
68
- ```
69
-
70
- `gql.tada` infers the types of your queries. However, it can’t provide you with editor feedback,
71
- like autocompletion, diagnostics & errors, and hover information inside GraphQL queries.
72
- For the best experience, it’s recommended to install [GraphQLSP](https://github.com/0no-co/graphqlsp)
73
- to supplement these features.
74
-
75
- Install `@0no-co/graphqlsp` as a dev dependency,
76
-
77
- ```sh
78
- npm i -D gql.tada
79
- pnpm add -D graphql
80
- yarn add --dev gql.tada
81
- bun add --dev graphql
82
- ```
83
-
84
- Then, update your `tsconfig.json` to enable the `graphqlsp` plugin in your TypeScript server,
78
+ ## 📦 [Releases](https://github.com/0no-co/gql.tada/releases)
85
79
 
86
- **tsconfig.json**
80
+ If you'd like to get involved, [check out our Contributor's guide.](https://github.com/0no-co/gql.tada/blob/main/CONTRIBUTING.md)
87
81
 
88
- ```diff
89
- {
90
- "compilerOptions": {
91
- + "plugins": [
92
- + {
93
- + "name": "@0no-co/graphqlsp",
94
- + "schema": "./schema.graphql"
95
- + }
96
- + ]
97
- }
98
- }
99
- ```
82
+ All new releases and updates are listed on GitHub with full changelogs.
83
+ The [`CHANGELOG.md` file](https://github.com/0no-co/gql.tada/blob/main/CHANGELOG.md) further documents all the historical changes for `gql.tada`.
100
84
 
101
- > **Note:**
102
- > If you are using VSCode, you may want to update your `.vscode/config.json` file to use the
103
- > [use the **workspace version** of TypeScript](https://code.visualstudio.com/docs/typescript/typescript-compiling#_using-the-workspace-version-of-typescript)
104
- > automatically.
105
- >
106
- > **.vscode/config.json**
107
- >
108
- > ```diff
109
- > {
110
- > + "typescript.tsdk": "node_modules/typescript/lib",
111
- > + "typescript.enablePromptUseWorkspaceTsdk": true
112
- > }
113
- > ```
114
-
115
- <!-- TODO -->
85
+ New releases are prepared using
86
+ [changesets](https://github.com/0no-co/gql.tada/blob/main/CONTRIBUTING.md#how-do-i-document-a-change-for-the-changelog),
87
+ which are changelog entries added to each PR, and we have “Version Packages” PRs that once merged
88
+ will release new versions of the `gql.tada` package. You can use `@canary` releases from `npm` if you’d
89
+ like to get a preview of the merged changes.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "gql.tada",
3
3
  "description": "The spec-compliant & magical GraphQL query language engine in the TypeScript type system",
4
- "version": "1.0.0-beta.2",
4
+ "version": "1.0.0",
5
5
  "author": "0no.co <hi@0no.co>",
6
6
  "source": "./src/index.ts",
7
7
  "main": "./dist/gql-tada",
@@ -88,7 +88,8 @@
88
88
  "vitest": "1.1.3"
89
89
  },
90
90
  "publishConfig": {
91
- "access": "public"
91
+ "access": "public",
92
+ "provenance": true
92
93
  },
93
94
  "scripts": {
94
95
  "test": "vitest test",