@graphql-markdown/core 1.19.0 → 1.21.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.
- package/assets/generated.md +1 -8
- package/dist/config.d.ts +9 -55
- package/dist/config.d.ts.map +1 -1
- package/dist/config.js +24 -39
- package/dist/const/patterns.d.ts +9 -9
- package/dist/const/patterns.d.ts.map +1 -1
- package/dist/const/patterns.js +9 -9
- package/dist/diff.d.ts.map +1 -1
- package/dist/diff.js +1 -34
- package/dist/directives/normalize.d.ts +2 -2
- package/dist/directives/normalize.d.ts.map +1 -1
- package/dist/directives/normalize.js +3 -1
- package/dist/directives/validation.d.ts.map +1 -1
- package/dist/event-emitter.d.ts +7 -2
- package/dist/event-emitter.d.ts.map +1 -1
- package/dist/event-emitter.js +32 -23
- package/dist/event-handlers.d.ts.map +1 -1
- package/dist/event-map.d.ts +2 -0
- package/dist/event-map.d.ts.map +1 -1
- package/dist/event-map.js +3 -0
- package/dist/events/diff-check.d.ts +7 -8
- package/dist/events/diff-check.d.ts.map +1 -1
- package/dist/events/diff-check.js +3 -6
- package/dist/events/diff-events.d.ts.map +1 -1
- package/dist/events/generate-index-metafile-events.d.ts.map +1 -1
- package/dist/events/generate-index-metafile.d.ts +7 -8
- package/dist/events/generate-index-metafile.d.ts.map +1 -1
- package/dist/events/generate-index-metafile.js +3 -6
- package/dist/events/index.d.ts +2 -3
- package/dist/events/index.d.ts.map +1 -1
- package/dist/events/index.js +21 -21
- package/dist/events/print-type-events.d.ts +5 -2
- package/dist/events/print-type-events.d.ts.map +1 -1
- package/dist/events/print-type-events.js +5 -2
- package/dist/events/print-type.d.ts +4 -78
- package/dist/events/print-type.d.ts.map +1 -1
- package/dist/events/print-type.js +3 -66
- package/dist/events/render-files-events.d.ts +13 -0
- package/dist/events/render-files-events.d.ts.map +1 -0
- package/dist/events/render-files-events.js +15 -0
- package/dist/events/render-files.d.ts +26 -0
- package/dist/events/render-files.d.ts.map +1 -0
- package/dist/events/render-files.js +20 -0
- package/dist/events/render-homepage-events.d.ts.map +1 -1
- package/dist/events/render-homepage.d.ts +5 -6
- package/dist/events/render-homepage.d.ts.map +1 -1
- package/dist/events/render-homepage.js +3 -6
- package/dist/events/render-root-types-events.d.ts.map +1 -1
- package/dist/events/render-root-types.d.ts +5 -6
- package/dist/events/render-root-types.d.ts.map +1 -1
- package/dist/events/render-root-types.js +3 -6
- package/dist/events/render-type-entities-events.d.ts.map +1 -1
- package/dist/events/render-type-entities.d.ts +10 -7
- package/dist/events/render-type-entities.d.ts.map +1 -1
- package/dist/events/render-type-entities.js +3 -6
- package/dist/events/schema-events.d.ts.map +1 -1
- package/dist/events/schema-load.d.ts +7 -8
- package/dist/events/schema-load.d.ts.map +1 -1
- package/dist/events/schema-load.js +3 -6
- package/dist/generator.d.ts +3 -14
- package/dist/generator.d.ts.map +1 -1
- package/dist/generator.js +16 -11
- package/dist/graphql-config.d.ts +0 -5
- package/dist/graphql-config.d.ts.map +1 -1
- package/dist/graphql-config.js +8 -38
- package/dist/index.d.ts +2 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +15 -13
- package/dist/options/builder.d.ts +13 -13
- package/dist/options/builder.d.ts.map +1 -1
- package/dist/options/builder.js +25 -25
- package/dist/printer.d.ts +9 -10
- package/dist/printer.d.ts.map +1 -1
- package/dist/printer.js +11 -53
- package/dist/renderer.d.ts +5 -5
- package/dist/renderer.d.ts.map +1 -1
- package/dist/renderer.js +24 -15
- package/package.json +24 -16
- package/dist/events/base.d.ts +0 -119
- package/dist/events/base.d.ts.map +0 -1
- package/dist/events/base.js +0 -149
|
@@ -6,18 +6,15 @@
|
|
|
6
6
|
*/
|
|
7
7
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
8
8
|
exports.RenderRootTypesEvent = void 0;
|
|
9
|
-
const
|
|
9
|
+
const utils_1 = require("@graphql-markdown/utils");
|
|
10
10
|
/**
|
|
11
11
|
* Event emitted before/after rendering root types.
|
|
12
12
|
*
|
|
13
13
|
* @category Events
|
|
14
14
|
*/
|
|
15
|
-
class RenderRootTypesEvent extends
|
|
16
|
-
/** Event data containing root types */
|
|
17
|
-
data;
|
|
15
|
+
class RenderRootTypesEvent extends utils_1.DataEvent {
|
|
18
16
|
constructor(data, options) {
|
|
19
|
-
super(options);
|
|
20
|
-
this.data = data;
|
|
17
|
+
super(data, options);
|
|
21
18
|
}
|
|
22
19
|
}
|
|
23
20
|
exports.RenderRootTypesEvent = RenderRootTypesEvent;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"render-type-entities-events.d.ts","sourceRoot":"","sources":["../../src/events/render-type-entities-events.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;GAEG;AACH,eAAO,MAAM,wBAAwB;IACnC,6CAA6C
|
|
1
|
+
{"version":3,"file":"render-type-entities-events.d.ts","sourceRoot":"","sources":["../../src/events/render-type-entities-events.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;GAEG;AACH,eAAO,MAAM,wBAAwB;IACnC,6CAA6C;aAC7C,aAAa,EAAE,iCAAiC;IAChD,4CAA4C;aAC5C,YAAY,EAAE,gCAAgC;CACtC,CAAC"}
|
|
@@ -3,21 +3,24 @@
|
|
|
3
3
|
*
|
|
4
4
|
* @packageDocumentation
|
|
5
5
|
*/
|
|
6
|
-
import {
|
|
6
|
+
import type { CancellableEventOptions } from "@graphql-markdown/utils";
|
|
7
|
+
import { DataEvent } from "@graphql-markdown/utils";
|
|
7
8
|
/**
|
|
8
9
|
* Event emitted before/after rendering type entities.
|
|
9
10
|
*
|
|
10
11
|
* @category Events
|
|
11
12
|
*/
|
|
12
|
-
export declare class RenderTypeEntitiesEvent extends
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
13
|
+
export declare class RenderTypeEntitiesEvent extends DataEvent<{
|
|
14
|
+
baseURL: string;
|
|
15
|
+
name: string;
|
|
16
|
+
filePath: string;
|
|
17
|
+
outputDir: string;
|
|
18
|
+
}> {
|
|
18
19
|
constructor(data: {
|
|
20
|
+
baseURL: string;
|
|
19
21
|
name: string;
|
|
20
22
|
filePath: string;
|
|
23
|
+
outputDir: string;
|
|
21
24
|
}, options?: CancellableEventOptions);
|
|
22
25
|
}
|
|
23
26
|
//# sourceMappingURL=render-type-entities.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"render-type-entities.d.ts","sourceRoot":"","sources":["../../src/events/render-type-entities.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"render-type-entities.d.ts","sourceRoot":"","sources":["../../src/events/render-type-entities.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,yBAAyB,CAAC;AACvE,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAEpD;;;;GAIG;AACH,qBAAa,uBAAwB,SAAQ,SAAS,CAAC;IACrD,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;IACA,YACE,IAAI,EAAE;QACJ,OAAO,EAAE,MAAM,CAAC;QAChB,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,EAAE,MAAM,CAAC;QACjB,SAAS,EAAE,MAAM,CAAC;KACnB,EACD,OAAO,CAAC,EAAE,uBAAuB,EAGlC;CACF"}
|
|
@@ -6,18 +6,15 @@
|
|
|
6
6
|
*/
|
|
7
7
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
8
8
|
exports.RenderTypeEntitiesEvent = void 0;
|
|
9
|
-
const
|
|
9
|
+
const utils_1 = require("@graphql-markdown/utils");
|
|
10
10
|
/**
|
|
11
11
|
* Event emitted before/after rendering type entities.
|
|
12
12
|
*
|
|
13
13
|
* @category Events
|
|
14
14
|
*/
|
|
15
|
-
class RenderTypeEntitiesEvent extends
|
|
16
|
-
/** Event data containing name and file path */
|
|
17
|
-
data;
|
|
15
|
+
class RenderTypeEntitiesEvent extends utils_1.DataEvent {
|
|
18
16
|
constructor(data, options) {
|
|
19
|
-
super(options);
|
|
20
|
-
this.data = data;
|
|
17
|
+
super(data, options);
|
|
21
18
|
}
|
|
22
19
|
}
|
|
23
20
|
exports.RenderTypeEntitiesEvent = RenderTypeEntitiesEvent;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"schema-events.d.ts","sourceRoot":"","sources":["../../src/events/schema-events.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;GAEG;AACH,eAAO,MAAM,YAAY;IACvB,4CAA4C
|
|
1
|
+
{"version":3,"file":"schema-events.d.ts","sourceRoot":"","sources":["../../src/events/schema-events.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;GAEG;AACH,eAAO,MAAM,YAAY;IACvB,4CAA4C;aAC5C,WAAW,EAAE,mBAAmB;IAChC,2CAA2C;aAC3C,UAAU,EAAE,kBAAkB;IAC9B,4CAA4C;aAC5C,UAAU,EAAE,kBAAkB;IAC9B,2CAA2C;aAC3C,SAAS,EAAE,iBAAiB;CACpB,CAAC"}
|
|
@@ -4,19 +4,18 @@
|
|
|
4
4
|
* @packageDocumentation
|
|
5
5
|
*/
|
|
6
6
|
import type { GraphQLSchema, Maybe, SchemaMap } from "@graphql-markdown/types";
|
|
7
|
-
import {
|
|
7
|
+
import type { CancellableEventOptions } from "@graphql-markdown/utils";
|
|
8
|
+
import { DataEvent } from "@graphql-markdown/utils";
|
|
8
9
|
/**
|
|
9
10
|
* Event emitted before/after loading a GraphQL schema.
|
|
10
11
|
*
|
|
11
12
|
* @category Events
|
|
12
13
|
*/
|
|
13
|
-
export declare class SchemaEvent extends
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
rootTypes?: Maybe<SchemaMap>;
|
|
19
|
-
};
|
|
14
|
+
export declare class SchemaEvent extends DataEvent<{
|
|
15
|
+
schemaLocation?: string;
|
|
16
|
+
schema?: Maybe<GraphQLSchema>;
|
|
17
|
+
rootTypes?: Maybe<SchemaMap>;
|
|
18
|
+
}> {
|
|
20
19
|
constructor(data: {
|
|
21
20
|
schemaLocation?: string;
|
|
22
21
|
schema?: Maybe<GraphQLSchema>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"schema-load.d.ts","sourceRoot":"","sources":["../../src/events/schema-load.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAC/E,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"schema-load.d.ts","sourceRoot":"","sources":["../../src/events/schema-load.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAC/E,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,yBAAyB,CAAC;AACvE,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAEpD;;;;GAIG;AACH,qBAAa,WAAY,SAAQ,SAAS,CAAC;IACzC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,MAAM,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IAC9B,SAAS,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;CAC9B,CAAC;IACA,YACE,IAAI,EAAE;QACJ,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,MAAM,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;QAC9B,SAAS,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;KAC9B,EACD,OAAO,CAAC,EAAE,uBAAuB,EAGlC;CACF"}
|
|
@@ -6,18 +6,15 @@
|
|
|
6
6
|
*/
|
|
7
7
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
8
8
|
exports.SchemaEvent = void 0;
|
|
9
|
-
const
|
|
9
|
+
const utils_1 = require("@graphql-markdown/utils");
|
|
10
10
|
/**
|
|
11
11
|
* Event emitted before/after loading a GraphQL schema.
|
|
12
12
|
*
|
|
13
13
|
* @category Events
|
|
14
14
|
*/
|
|
15
|
-
class SchemaEvent extends
|
|
16
|
-
/** Event data containing schema location, schema, and root types */
|
|
17
|
-
data;
|
|
15
|
+
class SchemaEvent extends utils_1.DataEvent {
|
|
18
16
|
constructor(data, options) {
|
|
19
|
-
super(options);
|
|
20
|
-
this.data = data;
|
|
17
|
+
super(data, options);
|
|
21
18
|
}
|
|
22
19
|
}
|
|
23
20
|
exports.SchemaEvent = SchemaEvent;
|
package/dist/generator.d.ts
CHANGED
|
@@ -8,17 +8,6 @@
|
|
|
8
8
|
* @packageDocumentation
|
|
9
9
|
*/
|
|
10
10
|
import type { DirectiveName, Formatter, GeneratorOptions, GraphQLDirective, GraphQLSchema, LoaderOption, Maybe, MetaInfo, PackageName, TypeDiffMethod } from "@graphql-markdown/types";
|
|
11
|
-
/**
|
|
12
|
-
* Supported file extensions for generated documentation files.
|
|
13
|
-
*
|
|
14
|
-
* @remarks
|
|
15
|
-
* - MDX: MDX file extension (.mdx) for React component-enabled markdown
|
|
16
|
-
* - MD: Standard markdown file extension (.md)
|
|
17
|
-
*/
|
|
18
|
-
export declare const FILE_EXTENSION: {
|
|
19
|
-
readonly MDX: ".mdx";
|
|
20
|
-
readonly MD: ".md";
|
|
21
|
-
};
|
|
22
11
|
/**
|
|
23
12
|
* Asynchronously loads an MDX module dynamically.
|
|
24
13
|
*
|
|
@@ -29,7 +18,7 @@ export declare const FILE_EXTENSION: {
|
|
|
29
18
|
*
|
|
30
19
|
* @internal
|
|
31
20
|
*/
|
|
32
|
-
export declare const loadMDXModule: (mdxParser: Maybe<
|
|
21
|
+
export declare const loadMDXModule: (mdxParser: Maybe<PackageName | string>) => Promise<unknown>;
|
|
33
22
|
/**
|
|
34
23
|
* Gets a property from an MDX module, checking both the module directly and `module.default`.
|
|
35
24
|
*
|
|
@@ -97,7 +86,7 @@ export declare const checkSchemaDifferences: (schema: GraphQLSchema, schemaLocat
|
|
|
97
86
|
* @returns A tuple containing two arrays: the first with resolved "only" directives,
|
|
98
87
|
* the second with resolved "skip" directives. Only defined directives are included.
|
|
99
88
|
*/
|
|
100
|
-
export declare const resolveSkipAndOnlyDirectives: (onlyDocDirective: Maybe<DirectiveName
|
|
89
|
+
export declare const resolveSkipAndOnlyDirectives: (onlyDocDirective: Maybe<DirectiveName | DirectiveName[]>, skipDocDirective: Maybe<DirectiveName | DirectiveName[]>, schema: GraphQLSchema) => GraphQLDirective[][];
|
|
101
90
|
/**
|
|
102
91
|
* Main entry point for generating Markdown documentation from a GraphQL schema.
|
|
103
92
|
*
|
|
@@ -111,5 +100,5 @@ export declare const resolveSkipAndOnlyDirectives: (onlyDocDirective: Maybe<Dire
|
|
|
111
100
|
* @param options - Complete configuration for the documentation generation
|
|
112
101
|
* @returns Promise that resolves when documentation is fully generated
|
|
113
102
|
*/
|
|
114
|
-
export declare const generateDocFromSchema: ({ baseURL, customDirective, diffMethod, docOptions, force, groupByDirective, homepageLocation, linkRoot, loaders: loadersList, loggerModule,
|
|
103
|
+
export declare const generateDocFromSchema: ({ baseURL, customDirective, diffMethod, docOptions, force, groupByDirective, homepageLocation, linkRoot, loaders: loadersList, loggerModule, formatter, metatags, onlyDocDirective, outputDir, prettify, printTypeOptions, schemaLocation, skipDocDirective, tmpDir, }: GeneratorOptions) => Promise<void>;
|
|
115
104
|
//# sourceMappingURL=generator.d.ts.map
|
package/dist/generator.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"generator.d.ts","sourceRoot":"","sources":["../src/generator.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,OAAO,KAAK,EAEV,aAAa,EACb,SAAS,EACT,gBAAgB,EAChB,gBAAgB,EAChB,aAAa,EACb,YAAY,EACZ,KAAK,EACL,QAAQ,EACR,WAAW,EAEX,cAAc,EAEf,MAAM,yBAAyB,CAAC;
|
|
1
|
+
{"version":3,"file":"generator.d.ts","sourceRoot":"","sources":["../src/generator.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,OAAO,KAAK,EAEV,aAAa,EACb,SAAS,EACT,gBAAgB,EAChB,gBAAgB,EAChB,aAAa,EACb,YAAY,EACZ,KAAK,EACL,QAAQ,EACR,WAAW,EAEX,cAAc,EAEf,MAAM,yBAAyB,CAAC;AA6DjC;;;;;;;;;GASG;AACH,eAAO,MAAM,aAAa,cACb,KAAK,CAAC,WAAW,GAAG,MAAM,CAAC,KACrC,OAAO,CAAC,OAAO,CAYjB,CAAC;AAgBF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,oBAAoB,GAAI,CAAC,aACzB,OAAO,gBACJ,MAAM,KACnB,CAAC,GAAG,SAmBN,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,yBAAyB,cACzB,OAAO,SACX,QAAQ,KACd,OAAO,CAAC,SAAS,CAAC,GAAG,SA+CvB,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,iBAAiB,mBACZ,MAAM,eACT,KAAK,CAAC,YAAY,CAAC,KAC/B,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,CAY9B,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,sBAAsB,WACzB,aAAa,kBACL,MAAM,cACV,KAAK,CAAC,cAAc,CAAC,UACzB,MAAM,KACb,OAAO,CAAC,OAAO,CAWjB,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,4BAA4B,qBACrB,KAAK,CAAC,aAAa,GAAG,aAAa,EAAE,CAAC,oBACtC,KAAK,CAAC,aAAa,GAAG,aAAa,EAAE,CAAC,UAChD,aAAa,KACpB,gBAAgB,EAAE,EAsBpB,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,qBAAqB,2QAoB/B,gBAAgB,KAAG,OAAO,CAAC,IAAI,CA0MjC,CAAC"}
|
package/dist/generator.js
CHANGED
|
@@ -33,10 +33,11 @@ var __importStar = (this && this.__importStar) || (function () {
|
|
|
33
33
|
};
|
|
34
34
|
})();
|
|
35
35
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
36
|
-
exports.generateDocFromSchema = exports.resolveSkipAndOnlyDirectives = exports.checkSchemaDifferences = exports.loadGraphqlSchema = exports.getFormatterFromMDXModule = exports.getMDXModuleProperty = exports.loadMDXModule =
|
|
36
|
+
exports.generateDocFromSchema = exports.resolveSkipAndOnlyDirectives = exports.checkSchemaDifferences = exports.loadGraphqlSchema = exports.getFormatterFromMDXModule = exports.getMDXModuleProperty = exports.loadMDXModule = void 0;
|
|
37
37
|
const logger_1 = __importStar(require("@graphql-markdown/logger"));
|
|
38
38
|
const graphql_1 = require("@graphql-markdown/graphql");
|
|
39
39
|
const utils_1 = require("@graphql-markdown/utils");
|
|
40
|
+
const node_path_1 = require("node:path");
|
|
40
41
|
const config_1 = require("./config");
|
|
41
42
|
const diff_1 = require("./diff");
|
|
42
43
|
const printer_1 = require("./printer");
|
|
@@ -51,7 +52,7 @@ const event_handlers_1 = require("./event-handlers");
|
|
|
51
52
|
* - MDX: MDX file extension (.mdx) for React component-enabled markdown
|
|
52
53
|
* - MD: Standard markdown file extension (.md)
|
|
53
54
|
*/
|
|
54
|
-
|
|
55
|
+
const FILE_EXTENSION = {
|
|
55
56
|
MDX: ".mdx",
|
|
56
57
|
MD: ".md",
|
|
57
58
|
};
|
|
@@ -80,7 +81,7 @@ const SEC_DECIMALS = 3;
|
|
|
80
81
|
*/
|
|
81
82
|
const loadMDXModule = async (mdxParser) => {
|
|
82
83
|
return mdxParser !== undefined && mdxParser !== null
|
|
83
|
-
?
|
|
84
|
+
? import(mdxParser).catch((error) => {
|
|
84
85
|
const errorMessage = error instanceof Error ? error.message : String(error);
|
|
85
86
|
(0, logger_1.log)(`An error occurred while loading MDX formatter "${mdxParser}": ${errorMessage}`, logger_1.LogLevel.warn);
|
|
86
87
|
return undefined;
|
|
@@ -273,10 +274,10 @@ exports.resolveSkipAndOnlyDirectives = resolveSkipAndOnlyDirectives;
|
|
|
273
274
|
* @param options - Complete configuration for the documentation generation
|
|
274
275
|
* @returns Promise that resolves when documentation is fully generated
|
|
275
276
|
*/
|
|
276
|
-
const generateDocFromSchema = async ({ baseURL, customDirective, diffMethod, docOptions, force, groupByDirective, homepageLocation, linkRoot, loaders: loadersList, loggerModule,
|
|
277
|
+
const generateDocFromSchema = async ({ baseURL, customDirective, diffMethod, docOptions, force, groupByDirective, homepageLocation, linkRoot, loaders: loadersList, loggerModule, formatter, metatags, onlyDocDirective, outputDir, prettify, printTypeOptions, schemaLocation, skipDocDirective, tmpDir, }) => {
|
|
277
278
|
const start = process.hrtime.bigint();
|
|
278
279
|
await (0, logger_1.default)(loggerModule);
|
|
279
|
-
const mdxModule = await (0, exports.loadMDXModule)(
|
|
280
|
+
const mdxModule = await (0, exports.loadMDXModule)(formatter);
|
|
280
281
|
// Register MDX lifecycle event handlers if mdxModule loaded successfully
|
|
281
282
|
// This must be called BEFORE getEvents() because it resets the singleton
|
|
282
283
|
(0, event_handlers_1.registerMDXEventHandlers)(mdxModule);
|
|
@@ -307,12 +308,10 @@ const generateDocFromSchema = async ({ baseURL, customDirective, diffMethod, doc
|
|
|
307
308
|
const customDirectives = (0, graphql_1.getCustomDirectives)(rootTypes, customDirective);
|
|
308
309
|
const groups = (0, graphql_1.getGroups)(rootTypes, groupByDirective);
|
|
309
310
|
// Extract formatter from the MDX module (for direct function calls)
|
|
310
|
-
const
|
|
311
|
+
const mdxFormatter = (0, exports.getFormatterFromMDXModule)(mdxModule, docOptions);
|
|
311
312
|
// Extract mdxDeclaration from the MDX module (if available)
|
|
312
313
|
const mdxDeclaration = (0, exports.getMDXModuleProperty)(mdxModule, "mdxDeclaration");
|
|
313
314
|
const printer = await (0, printer_1.getPrinter)(
|
|
314
|
-
// module mandatory
|
|
315
|
-
printerModule,
|
|
316
315
|
// config mandatory
|
|
317
316
|
{
|
|
318
317
|
baseURL,
|
|
@@ -332,7 +331,7 @@ const generateDocFromSchema = async ({ baseURL, customDirective, diffMethod, doc
|
|
|
332
331
|
printTypeOptions,
|
|
333
332
|
skipDocDirectives,
|
|
334
333
|
sectionHeaderId: docOptions?.sectionHeaderId,
|
|
335
|
-
},
|
|
334
|
+
}, mdxFormatter, mdxDeclaration,
|
|
336
335
|
// Pass event emitter to enable print events
|
|
337
336
|
events);
|
|
338
337
|
// allow mdxModule to specify custom extension
|
|
@@ -342,10 +341,10 @@ const generateDocFromSchema = async ({ baseURL, customDirective, diffMethod, doc
|
|
|
342
341
|
mdxExtension = mdxExtensionFromModule;
|
|
343
342
|
}
|
|
344
343
|
else if (mdxModule) {
|
|
345
|
-
mdxExtension =
|
|
344
|
+
mdxExtension = FILE_EXTENSION.MDX;
|
|
346
345
|
}
|
|
347
346
|
else {
|
|
348
|
-
mdxExtension =
|
|
347
|
+
mdxExtension = FILE_EXTENSION.MD;
|
|
349
348
|
}
|
|
350
349
|
const renderer = await (0, renderer_1.getRenderer)(printer, outputDir, baseURL, groups, prettify, {
|
|
351
350
|
...docOptions,
|
|
@@ -376,6 +375,12 @@ const generateDocFromSchema = async ({ baseURL, customDirective, diffMethod, doc
|
|
|
376
375
|
outputDir,
|
|
377
376
|
});
|
|
378
377
|
await events.emitAsync(events_1.RenderHomepageEvents.AFTER_RENDER, afterRenderHomepageEvent);
|
|
378
|
+
await events.emitAsync(events_1.RenderFilesEvents.AFTER_RENDER, new events_1.RenderFilesEvent({
|
|
379
|
+
baseURL,
|
|
380
|
+
outputDir,
|
|
381
|
+
rootDir: (0, node_path_1.dirname)(outputDir),
|
|
382
|
+
pages,
|
|
383
|
+
}));
|
|
379
384
|
const duration = (Number(process.hrtime.bigint() - start) / NS_PER_SEC).toFixed(SEC_DECIMALS);
|
|
380
385
|
(0, logger_1.log)(`Documentation successfully generated in "${outputDir}" with base URL "${baseURL}".`, "success");
|
|
381
386
|
(0, logger_1.log)(`${pages.flat().length} pages generated in ${duration}s from schema "${(0, utils_1.toString)(schemaLocation)}".`);
|
package/dist/graphql-config.d.ts
CHANGED
|
@@ -7,11 +7,6 @@
|
|
|
7
7
|
* @module graphql-config
|
|
8
8
|
*/
|
|
9
9
|
import type { ExtensionProjectConfig, GraphQLExtensionDeclaration, LoaderOption, Maybe, PackageOptionsConfig } from "@graphql-markdown/types";
|
|
10
|
-
/**
|
|
11
|
-
* The name of the GraphQL Markdown extension.
|
|
12
|
-
* Used to identify the extension in graphql-config.
|
|
13
|
-
*/
|
|
14
|
-
export declare const EXTENSION_NAME: "graphql-markdown";
|
|
15
10
|
/**
|
|
16
11
|
* GraphQL extension declaration for graphql-config.
|
|
17
12
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"graphql-config.d.ts","sourceRoot":"","sources":["../src/graphql-config.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,OAAO,KAAK,EAEV,sBAAsB,EACtB,2BAA2B,EAC3B,YAAY,EACZ,KAAK,EAEL,oBAAoB,EACrB,MAAM,yBAAyB,CAAC;
|
|
1
|
+
{"version":3,"file":"graphql-config.d.ts","sourceRoot":"","sources":["../src/graphql-config.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,OAAO,KAAK,EAEV,sBAAsB,EACtB,2BAA2B,EAC3B,YAAY,EACZ,KAAK,EAEL,oBAAoB,EACrB,MAAM,yBAAyB,CAAC;AAgBjC;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,sBAAsB,EAAE,2BAEpC,CAAC;AAEF;;;;;;GAMG;AACH,UAAU,YAAY;IACpB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAWD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAIH,eAAO,MAAM,gBAAgB,YAClB,YAAY,WACZ,oBAAoB,KAC5B,YAeF,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAO,MAAM,iBAAiB,OACxB,KAAK,CAAC,MAAM,CAAC,YACP,KAAK,CAAC,oBAAoB,CAAC,qCACH,YAAY,KAC7C,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,sBAAsB,CAAC,CAAC,CAkDjD,CAAC"}
|
package/dist/graphql-config.js
CHANGED
|
@@ -1,46 +1,13 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
-
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
-
if (k2 === undefined) k2 = k;
|
|
4
|
-
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
-
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
-
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
-
}
|
|
8
|
-
Object.defineProperty(o, k2, desc);
|
|
9
|
-
}) : (function(o, m, k, k2) {
|
|
10
|
-
if (k2 === undefined) k2 = k;
|
|
11
|
-
o[k2] = m[k];
|
|
12
|
-
}));
|
|
13
|
-
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
14
|
-
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
15
|
-
}) : function(o, v) {
|
|
16
|
-
o["default"] = v;
|
|
17
|
-
});
|
|
18
|
-
var __importStar = (this && this.__importStar) || (function () {
|
|
19
|
-
var ownKeys = function(o) {
|
|
20
|
-
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
21
|
-
var ar = [];
|
|
22
|
-
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
23
|
-
return ar;
|
|
24
|
-
};
|
|
25
|
-
return ownKeys(o);
|
|
26
|
-
};
|
|
27
|
-
return function (mod) {
|
|
28
|
-
if (mod && mod.__esModule) return mod;
|
|
29
|
-
var result = {};
|
|
30
|
-
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
31
|
-
__setModuleDefault(result, mod);
|
|
32
|
-
return result;
|
|
33
|
-
};
|
|
34
|
-
})();
|
|
35
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
36
|
-
exports.loadConfiguration = exports.setLoaderOptions = exports.graphQLConfigExtension =
|
|
3
|
+
exports.loadConfiguration = exports.setLoaderOptions = exports.graphQLConfigExtension = void 0;
|
|
37
4
|
const logger_1 = require("@graphql-markdown/logger");
|
|
38
5
|
const validation_1 = require("./directives/validation");
|
|
39
6
|
/**
|
|
40
7
|
* The name of the GraphQL Markdown extension.
|
|
41
8
|
* Used to identify the extension in graphql-config.
|
|
42
9
|
*/
|
|
43
|
-
|
|
10
|
+
const EXTENSION_NAME = "graphql-markdown";
|
|
44
11
|
/**
|
|
45
12
|
* GraphQL extension declaration for graphql-config.
|
|
46
13
|
*
|
|
@@ -55,7 +22,7 @@ exports.EXTENSION_NAME = "graphql-markdown";
|
|
|
55
22
|
* ```
|
|
56
23
|
*/
|
|
57
24
|
const graphQLConfigExtension = () => {
|
|
58
|
-
return { name:
|
|
25
|
+
return { name: EXTENSION_NAME };
|
|
59
26
|
};
|
|
60
27
|
exports.graphQLConfigExtension = graphQLConfigExtension;
|
|
61
28
|
/**
|
|
@@ -89,6 +56,9 @@ const DEFAULT_THROW_OPTIONS = {
|
|
|
89
56
|
* // Result: loaders with { baseDir: "./src", outputDir: "./docs" }
|
|
90
57
|
* ```
|
|
91
58
|
*/
|
|
59
|
+
// Exported so tests can jest.spyOn via namespace import; fallow can't trace
|
|
60
|
+
// dynamic spy interception and production: true excludes the test callers.
|
|
61
|
+
// fallow-ignore-next-line unused-export
|
|
92
62
|
const setLoaderOptions = (loaders, options) => {
|
|
93
63
|
for (const loader in loaders) {
|
|
94
64
|
if ((0, validation_1.isLoaderString)(loaders[loader])) {
|
|
@@ -141,7 +111,7 @@ const loadConfiguration = async (id, options, { throwOnMissing, throwOnEmpty } =
|
|
|
141
111
|
return undefined;
|
|
142
112
|
}
|
|
143
113
|
try {
|
|
144
|
-
graphQLConfig = await
|
|
114
|
+
graphQLConfig = await import("graphql-config");
|
|
145
115
|
}
|
|
146
116
|
catch {
|
|
147
117
|
(0, logger_1.log)("Cannot find module 'graphql-config'!");
|
|
@@ -159,7 +129,7 @@ const loadConfiguration = async (id, options, { throwOnMissing, throwOnEmpty } =
|
|
|
159
129
|
try {
|
|
160
130
|
const projectConfig = config
|
|
161
131
|
.getProject(id)
|
|
162
|
-
.extension(
|
|
132
|
+
.extension(EXTENSION_NAME);
|
|
163
133
|
if (Array.isArray(projectConfig.schema)) {
|
|
164
134
|
const schema = projectConfig.schema[0];
|
|
165
135
|
if ((0, validation_1.isSchemaString)(schema)) {
|
package/dist/index.d.ts
CHANGED
|
@@ -13,12 +13,12 @@ export { RenderHomepageEvents } from "./events/render-homepage-events";
|
|
|
13
13
|
export { RenderTypeEntitiesEvents } from "./events/render-type-entities-events";
|
|
14
14
|
export { GenerateIndexMetafileEvents } from "./events/generate-index-metafile-events";
|
|
15
15
|
export { PrintTypeEvents } from "./events/print-type-events";
|
|
16
|
-
export type { CancellableEvent } from "./events/base";
|
|
17
16
|
export type { SchemaEvent as SchemaLoadEvent } from "./events/schema-load";
|
|
18
17
|
export type { DiffCheckEvent } from "./events/diff-check";
|
|
19
18
|
export type { RenderRootTypesEvent } from "./events/render-root-types";
|
|
20
19
|
export type { RenderHomepageEvent } from "./events/render-homepage";
|
|
21
20
|
export type { RenderTypeEntitiesEvent } from "./events/render-type-entities";
|
|
22
21
|
export type { GenerateIndexMetafileEvent } from "./events/generate-index-metafile";
|
|
23
|
-
export type {
|
|
22
|
+
export type { ComposePageTypeEventData, IPrintCodeEvent, IPrintTypeEvent, PageSection, PageSections, PrintCodeEventData, PrintTypeEventData, } from "@graphql-markdown/types";
|
|
23
|
+
export { CancellableEvent } from "@graphql-markdown/utils";
|
|
24
24
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAGvC,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,KAAK,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC1E,OAAO,EAAE,wBAAwB,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAGjD,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AACvE,OAAO,EAAE,wBAAwB,EAAE,MAAM,sCAAsC,CAAC;AAChF,OAAO,EAAE,2BAA2B,EAAE,MAAM,yCAAyC,CAAC;AACtF,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAG7D,YAAY,EAAE,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAGvC,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,KAAK,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC1E,OAAO,EAAE,wBAAwB,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAGjD,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AACvE,OAAO,EAAE,wBAAwB,EAAE,MAAM,sCAAsC,CAAC;AAChF,OAAO,EAAE,2BAA2B,EAAE,MAAM,yCAAyC,CAAC;AACtF,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAG7D,YAAY,EAAE,WAAW,IAAI,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC3E,YAAY,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAC1D,YAAY,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AACvE,YAAY,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AACpE,YAAY,EAAE,uBAAuB,EAAE,MAAM,+BAA+B,CAAC;AAC7E,YAAY,EAAE,0BAA0B,EAAE,MAAM,kCAAkC,CAAC;AACnF,YAAY,EACV,wBAAwB,EACxB,eAAe,EACf,eAAe,EACf,WAAW,EACX,YAAY,EACZ,kBAAkB,EAClB,kBAAkB,GACnB,MAAM,yBAAyB,CAAC;AAEjC,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC"}
|
package/dist/index.js
CHANGED
|
@@ -4,31 +4,33 @@
|
|
|
4
4
|
*/
|
|
5
5
|
/* istanbul ignore file */
|
|
6
6
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
7
|
-
exports.PrintTypeEvents = exports.GenerateIndexMetafileEvents = exports.RenderTypeEntitiesEvents = exports.RenderHomepageEvents = exports.RenderRootTypesEvents = exports.DiffEvents = exports.SchemaEvents = exports.EVENT_CALLBACK_MAP = exports.registerMDXEventHandlers = exports.resetEvents = exports.getEvents = exports.buildConfig = exports.generateDocFromSchema = void 0;
|
|
8
|
-
|
|
7
|
+
exports.CancellableEvent = exports.PrintTypeEvents = exports.GenerateIndexMetafileEvents = exports.RenderTypeEntitiesEvents = exports.RenderHomepageEvents = exports.RenderRootTypesEvents = exports.DiffEvents = exports.SchemaEvents = exports.EVENT_CALLBACK_MAP = exports.registerMDXEventHandlers = exports.resetEvents = exports.getEvents = exports.buildConfig = exports.generateDocFromSchema = void 0;
|
|
8
|
+
var generator_1 = require("./generator");
|
|
9
9
|
Object.defineProperty(exports, "generateDocFromSchema", { enumerable: true, get: function () { return generator_1.generateDocFromSchema; } });
|
|
10
|
-
|
|
10
|
+
var config_1 = require("./config");
|
|
11
11
|
Object.defineProperty(exports, "buildConfig", { enumerable: true, get: function () { return config_1.buildConfig; } });
|
|
12
12
|
// Event system exports
|
|
13
|
-
|
|
13
|
+
var event_emitter_1 = require("./event-emitter");
|
|
14
14
|
Object.defineProperty(exports, "getEvents", { enumerable: true, get: function () { return event_emitter_1.getEvents; } });
|
|
15
15
|
Object.defineProperty(exports, "resetEvents", { enumerable: true, get: function () { return event_emitter_1.resetEvents; } });
|
|
16
|
-
|
|
16
|
+
var event_handlers_1 = require("./event-handlers");
|
|
17
17
|
Object.defineProperty(exports, "registerMDXEventHandlers", { enumerable: true, get: function () { return event_handlers_1.registerMDXEventHandlers; } });
|
|
18
|
-
|
|
18
|
+
var event_map_1 = require("./event-map");
|
|
19
19
|
Object.defineProperty(exports, "EVENT_CALLBACK_MAP", { enumerable: true, get: function () { return event_map_1.EVENT_CALLBACK_MAP; } });
|
|
20
20
|
// Event constant exports
|
|
21
|
-
|
|
21
|
+
var schema_events_1 = require("./events/schema-events");
|
|
22
22
|
Object.defineProperty(exports, "SchemaEvents", { enumerable: true, get: function () { return schema_events_1.SchemaEvents; } });
|
|
23
|
-
|
|
23
|
+
var diff_events_1 = require("./events/diff-events");
|
|
24
24
|
Object.defineProperty(exports, "DiffEvents", { enumerable: true, get: function () { return diff_events_1.DiffEvents; } });
|
|
25
|
-
|
|
25
|
+
var render_root_types_events_1 = require("./events/render-root-types-events");
|
|
26
26
|
Object.defineProperty(exports, "RenderRootTypesEvents", { enumerable: true, get: function () { return render_root_types_events_1.RenderRootTypesEvents; } });
|
|
27
|
-
|
|
27
|
+
var render_homepage_events_1 = require("./events/render-homepage-events");
|
|
28
28
|
Object.defineProperty(exports, "RenderHomepageEvents", { enumerable: true, get: function () { return render_homepage_events_1.RenderHomepageEvents; } });
|
|
29
|
-
|
|
29
|
+
var render_type_entities_events_1 = require("./events/render-type-entities-events");
|
|
30
30
|
Object.defineProperty(exports, "RenderTypeEntitiesEvents", { enumerable: true, get: function () { return render_type_entities_events_1.RenderTypeEntitiesEvents; } });
|
|
31
|
-
|
|
31
|
+
var generate_index_metafile_events_1 = require("./events/generate-index-metafile-events");
|
|
32
32
|
Object.defineProperty(exports, "GenerateIndexMetafileEvents", { enumerable: true, get: function () { return generate_index_metafile_events_1.GenerateIndexMetafileEvents; } });
|
|
33
|
-
|
|
33
|
+
var print_type_events_1 = require("./events/print-type-events");
|
|
34
34
|
Object.defineProperty(exports, "PrintTypeEvents", { enumerable: true, get: function () { return print_type_events_1.PrintTypeEvents; } });
|
|
35
|
+
var utils_1 = require("@graphql-markdown/utils");
|
|
36
|
+
Object.defineProperty(exports, "CancellableEvent", { enumerable: true, get: function () { return utils_1.CancellableEvent; } });
|
|
@@ -88,19 +88,6 @@ export declare class OptionBuilder<T extends Record<string, unknown>> {
|
|
|
88
88
|
* ```
|
|
89
89
|
*/
|
|
90
90
|
addFromCli<K extends keyof T>(value: Maybe<T[K]>, key: K): this;
|
|
91
|
-
/**
|
|
92
|
-
* Sets a value if it's not null or undefined, respecting precedence.
|
|
93
|
-
* Internal helper method used by addDefault, addFromConfig, and addFromCli.
|
|
94
|
-
*
|
|
95
|
-
* Only updates the merged value if the source has equal or higher precedence
|
|
96
|
-
* than the currently stored source. Precedence order: default < config < cli.
|
|
97
|
-
*
|
|
98
|
-
* @param value - The value to set
|
|
99
|
-
* @param key - The key to set
|
|
100
|
-
* @param source - The source of this value ('default', 'config', or 'cli')
|
|
101
|
-
* @returns This builder for method chaining
|
|
102
|
-
*/
|
|
103
|
-
private setIfProvided;
|
|
104
91
|
/**
|
|
105
92
|
* Transforms a value using a function if the key exists.
|
|
106
93
|
* Useful for processing values after they've been set.
|
|
@@ -153,5 +140,18 @@ export declare class OptionBuilder<T extends Record<string, unknown>> {
|
|
|
153
140
|
* @returns The constructed options object with type `Partial<T>` (may not have all properties of `T`)
|
|
154
141
|
*/
|
|
155
142
|
build(): Partial<T>;
|
|
143
|
+
/**
|
|
144
|
+
* Sets a value if it's not null or undefined, respecting precedence.
|
|
145
|
+
* Internal helper method used by addDefault, addFromConfig, and addFromCli.
|
|
146
|
+
*
|
|
147
|
+
* Only updates the merged value if the source has equal or higher precedence
|
|
148
|
+
* than the currently stored source. Precedence order: `default < config < cli`.
|
|
149
|
+
*
|
|
150
|
+
* @param value - The value to set
|
|
151
|
+
* @param key - The key to set
|
|
152
|
+
* @param source - The source of this value ('default', 'config', or 'cli')
|
|
153
|
+
* @returns This builder for method chaining
|
|
154
|
+
*/
|
|
155
|
+
private setIfProvided;
|
|
156
156
|
}
|
|
157
157
|
//# sourceMappingURL=builder.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"builder.d.ts","sourceRoot":"","sources":["../../src/options/builder.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAEH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAC;AAOrD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,qBAAa,aAAa,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAC1D,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,gBAAgB,CAItC;IAEF,OAAO,CAAC,MAAM,CAAkB;IAChC,OAAO,CAAC,QAAQ,CAAC,OAAO,
|
|
1
|
+
{"version":3,"file":"builder.d.ts","sourceRoot":"","sources":["../../src/options/builder.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAEH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAC;AAOrD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,qBAAa,aAAa,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAC1D,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,gBAAgB,CAItC;IAEF,OAAO,CAAC,MAAM,CAAkB;IAChC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAoC;IAE5D;;;;;;;;;;;;;OAaG;IACH,UAAU,CAAC,CAAC,SAAS,MAAM,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,IAAI,CAE9D;IAED;;;;;;;;;;;;;OAaG;IACH,aAAa,CAAC,CAAC,SAAS,MAAM,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,IAAI,CAEjE;IAED;;;;;;;;;;;;;OAaG;IACH,UAAU,CAAC,CAAC,SAAS,MAAM,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,IAAI,CAE9D;IAED;;;;;;;;;;;;OAYG;IACH,SAAS,CAAC,CAAC,SAAS,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAKhE;IAED;;;;;;;;;;;;;OAaG;IACH,WAAW,CAAC,CAAC,SAAS,MAAM,CAAC,EAC3B,GAAG,EAAE,CAAC,EACN,SAAS,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,OAAO,EAC1C,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GACpB,IAAI,CAKN;IAED;;;;;;;;OAQG;IACH,GAAG,CAAC,CAAC,SAAS,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,SAAS,CAS/C;IAED;;;;;;;;;;;OAWG;IACH,KAAK,IAAI,OAAO,CAAC,CAAC,CAAC,CAalB;IAED;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,aAAa;CAmBtB"}
|
package/dist/options/builder.js
CHANGED
|
@@ -100,31 +100,6 @@ class OptionBuilder {
|
|
|
100
100
|
addFromCli(value, key) {
|
|
101
101
|
return this.setIfProvided(value, key, "cli");
|
|
102
102
|
}
|
|
103
|
-
/**
|
|
104
|
-
* Sets a value if it's not null or undefined, respecting precedence.
|
|
105
|
-
* Internal helper method used by addDefault, addFromConfig, and addFromCli.
|
|
106
|
-
*
|
|
107
|
-
* Only updates the merged value if the source has equal or higher precedence
|
|
108
|
-
* than the currently stored source. Precedence order: default < config < cli.
|
|
109
|
-
*
|
|
110
|
-
* @param value - The value to set
|
|
111
|
-
* @param key - The key to set
|
|
112
|
-
* @param source - The source of this value ('default', 'config', or 'cli')
|
|
113
|
-
* @returns This builder for method chaining
|
|
114
|
-
*/
|
|
115
|
-
setIfProvided(value, key, source) {
|
|
116
|
-
if (value !== null && value !== undefined) {
|
|
117
|
-
const currentSource = this.sources.get(key);
|
|
118
|
-
const shouldUpdate = !currentSource ||
|
|
119
|
-
OptionBuilder.PRECEDENCE_ORDER[source] >=
|
|
120
|
-
OptionBuilder.PRECEDENCE_ORDER[currentSource];
|
|
121
|
-
if (shouldUpdate) {
|
|
122
|
-
this.merged[key] = value;
|
|
123
|
-
this.sources.set(key, source);
|
|
124
|
-
}
|
|
125
|
-
}
|
|
126
|
-
return this;
|
|
127
|
-
}
|
|
128
103
|
/**
|
|
129
104
|
* Transforms a value using a function if the key exists.
|
|
130
105
|
* Useful for processing values after they've been set.
|
|
@@ -211,5 +186,30 @@ class OptionBuilder {
|
|
|
211
186
|
}
|
|
212
187
|
return result;
|
|
213
188
|
}
|
|
189
|
+
/**
|
|
190
|
+
* Sets a value if it's not null or undefined, respecting precedence.
|
|
191
|
+
* Internal helper method used by addDefault, addFromConfig, and addFromCli.
|
|
192
|
+
*
|
|
193
|
+
* Only updates the merged value if the source has equal or higher precedence
|
|
194
|
+
* than the currently stored source. Precedence order: `default < config < cli`.
|
|
195
|
+
*
|
|
196
|
+
* @param value - The value to set
|
|
197
|
+
* @param key - The key to set
|
|
198
|
+
* @param source - The source of this value ('default', 'config', or 'cli')
|
|
199
|
+
* @returns This builder for method chaining
|
|
200
|
+
*/
|
|
201
|
+
setIfProvided(value, key, source) {
|
|
202
|
+
if (value !== null && value !== undefined) {
|
|
203
|
+
const currentSource = this.sources.get(key);
|
|
204
|
+
const shouldUpdate = !currentSource ||
|
|
205
|
+
OptionBuilder.PRECEDENCE_ORDER[source] >=
|
|
206
|
+
OptionBuilder.PRECEDENCE_ORDER[currentSource];
|
|
207
|
+
if (shouldUpdate) {
|
|
208
|
+
this.merged[key] = value;
|
|
209
|
+
this.sources.set(key, source);
|
|
210
|
+
}
|
|
211
|
+
}
|
|
212
|
+
return this;
|
|
213
|
+
}
|
|
214
214
|
}
|
|
215
215
|
exports.OptionBuilder = OptionBuilder;
|