@graphql-codegen/schema-ast 2.5.1 → 2.5.2-alpha-20221207031847-2e87bf712

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 (3) hide show
  1. package/package.json +2 -2
  2. package/typings/index.d.cts +45 -26
  3. package/typings/index.d.ts +45 -26
package/package.json CHANGED
@@ -1,12 +1,12 @@
1
1
  {
2
2
  "name": "@graphql-codegen/schema-ast",
3
- "version": "2.5.1",
3
+ "version": "2.5.2-alpha-20221207031847-2e87bf712",
4
4
  "description": "GraphQL Code Generator plugin for generating a .graphql file from a given schema",
5
5
  "peerDependencies": {
6
6
  "graphql": "^0.8.0 || ^0.9.0 || ^0.10.0 || ^0.11.0 || ^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0"
7
7
  },
8
8
  "dependencies": {
9
- "@graphql-codegen/plugin-helpers": "^2.6.2",
9
+ "@graphql-codegen/plugin-helpers": "3.0.0-alpha-20221207031847-2e87bf712",
10
10
  "@graphql-tools/utils": "^8.8.0",
11
11
  "tslib": "~2.4.0"
12
12
  },
package/typings/index.d.cts CHANGED
@@ -9,15 +9,21 @@ export interface SchemaASTConfig {
9
9
  * @default false
10
10
  *
11
11
  * @exampleMarkdown
12
- * ```yaml {8}
13
- * schema:
14
- * - './src/schema.graphql'
15
- * generates:
16
- * path/to/file.graphql:
17
- * plugins:
18
- * - schema-ast
19
- * config:
20
- * includeDirectives: true
12
+ * ```tsx {9} filename="codegen.ts"
13
+ * import type { CodegenConfig } from '@graphql-codegen/cli';
14
+ *
15
+ * const config: CodegenConfig = {
16
+ * schema: './src/schema.graphql',
17
+ * generates: {
18
+ * 'path/to/file.graphql': {
19
+ * plugins: ['schema-ast'],
20
+ * config: {
21
+ * includeDirectives: true
22
+ * },
23
+ * },
24
+ * },
25
+ * };
26
+ * export default config;
21
27
  * ```
22
28
  */
23
29
  includeDirectives?: boolean;
@@ -26,15 +32,21 @@ export interface SchemaASTConfig {
26
32
  * @default false
27
33
  *
28
34
  * @exampleMarkdown
29
- * ```yaml {8}
30
- * schema:
31
- * - './src/schema.graphql'
32
- * generates:
33
- * path/to/file.graphql:
34
- * plugins:
35
- * - schema-ast
36
- * config:
37
- * includeIntrospectionTypes: true
35
+ * ```tsx {9} filename="codegen.ts"
36
+ * import type { CodegenConfig } from '@graphql-codegen/cli';
37
+ *
38
+ * const config: CodegenConfig = {
39
+ * schema: './src/schema.graphql',
40
+ * generates: {
41
+ * 'path/to/file.graphql': {
42
+ * plugins: ['schema-ast'],
43
+ * config: {
44
+ * includeIntrospectionTypes: true
45
+ * },
46
+ * },
47
+ * },
48
+ * };
49
+ * export default config;
38
50
  * ```
39
51
  */
40
52
  includeIntrospectionTypes?: boolean;
@@ -43,14 +55,21 @@ export interface SchemaASTConfig {
43
55
  * @default false
44
56
  *
45
57
  * @exampleMarkdown
46
- * ```yaml {7}
47
- * schema: http://localhost:3000/graphql
48
- * generates:
49
- * schema.graphql:
50
- * plugins:
51
- * - schema-ast
52
- * config:
53
- * commentDescriptions: true
58
+ * ```tsx {9} filename="codegen.ts"
59
+ * import type { CodegenConfig } from '@graphql-codegen/cli';
60
+ *
61
+ * const config: CodegenConfig = {
62
+ * schema: './src/schema.graphql',
63
+ * generates: {
64
+ * 'path/to/file.graphql': {
65
+ * plugins: ['schema-ast'],
66
+ * config: {
67
+ * commentDescriptions: true
68
+ * },
69
+ * },
70
+ * },
71
+ * };
72
+ * export default config;
54
73
  * ```
55
74
  */
56
75
  commentDescriptions?: boolean;
package/typings/index.d.ts CHANGED
@@ -9,15 +9,21 @@ export interface SchemaASTConfig {
9
9
  * @default false
10
10
  *
11
11
  * @exampleMarkdown
12
- * ```yaml {8}
13
- * schema:
14
- * - './src/schema.graphql'
15
- * generates:
16
- * path/to/file.graphql:
17
- * plugins:
18
- * - schema-ast
19
- * config:
20
- * includeDirectives: true
12
+ * ```tsx {9} filename="codegen.ts"
13
+ * import type { CodegenConfig } from '@graphql-codegen/cli';
14
+ *
15
+ * const config: CodegenConfig = {
16
+ * schema: './src/schema.graphql',
17
+ * generates: {
18
+ * 'path/to/file.graphql': {
19
+ * plugins: ['schema-ast'],
20
+ * config: {
21
+ * includeDirectives: true
22
+ * },
23
+ * },
24
+ * },
25
+ * };
26
+ * export default config;
21
27
  * ```
22
28
  */
23
29
  includeDirectives?: boolean;
@@ -26,15 +32,21 @@ export interface SchemaASTConfig {
26
32
  * @default false
27
33
  *
28
34
  * @exampleMarkdown
29
- * ```yaml {8}
30
- * schema:
31
- * - './src/schema.graphql'
32
- * generates:
33
- * path/to/file.graphql:
34
- * plugins:
35
- * - schema-ast
36
- * config:
37
- * includeIntrospectionTypes: true
35
+ * ```tsx {9} filename="codegen.ts"
36
+ * import type { CodegenConfig } from '@graphql-codegen/cli';
37
+ *
38
+ * const config: CodegenConfig = {
39
+ * schema: './src/schema.graphql',
40
+ * generates: {
41
+ * 'path/to/file.graphql': {
42
+ * plugins: ['schema-ast'],
43
+ * config: {
44
+ * includeIntrospectionTypes: true
45
+ * },
46
+ * },
47
+ * },
48
+ * };
49
+ * export default config;
38
50
  * ```
39
51
  */
40
52
  includeIntrospectionTypes?: boolean;
@@ -43,14 +55,21 @@ export interface SchemaASTConfig {
43
55
  * @default false
44
56
  *
45
57
  * @exampleMarkdown
46
- * ```yaml {7}
47
- * schema: http://localhost:3000/graphql
48
- * generates:
49
- * schema.graphql:
50
- * plugins:
51
- * - schema-ast
52
- * config:
53
- * commentDescriptions: true
58
+ * ```tsx {9} filename="codegen.ts"
59
+ * import type { CodegenConfig } from '@graphql-codegen/cli';
60
+ *
61
+ * const config: CodegenConfig = {
62
+ * schema: './src/schema.graphql',
63
+ * generates: {
64
+ * 'path/to/file.graphql': {
65
+ * plugins: ['schema-ast'],
66
+ * config: {
67
+ * commentDescriptions: true
68
+ * },
69
+ * },
70
+ * },
71
+ * };
72
+ * export default config;
54
73
  * ```
55
74
  */
56
75
  commentDescriptions?: boolean;