@graphql-markdown/docusaurus 1.33.0 → 1.34.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.
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAC5E,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,yBAAyB,CAAC;AAczE;;;;;;;;GAQG;AACH,wBAA8B,yBAAyB,CACrD,CAAC,EAAE,WAAW,EACd,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,aAAa,CAAC,GAC1D,OAAO,CAAC,MAAM,CAAC,CAyCjB;AAED,OAAO,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAC5E,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,yBAAyB,CAAC;AAczE;;;;;;;;GAQG;AACH,wBAA8B,yBAAyB,CACrD,CAAC,EAAE,WAAW,EACd,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,aAAa,CAAC,GAC1D,OAAO,CAAC,MAAM,CAAC,CA6CjB;AAED,OAAO,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAC"}
package/dist/index.js CHANGED
@@ -1,13 +1,43 @@
1
1
  "use strict";
2
- var __importDefault = (this && this.__importDefault) || function (mod) {
3
- return (mod && mod.__esModule) ? mod : { "default": mod };
4
- };
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
+ })();
5
35
  Object.defineProperty(exports, "__esModule", { value: true });
6
36
  exports.createMDXFormatter = void 0;
7
37
  exports.default = pluginGraphQLDocGenerator;
8
38
  const utils_1 = require("@docusaurus/utils");
9
39
  const cli_1 = require("@graphql-markdown/cli");
10
- const logger_1 = __importDefault(require("@graphql-markdown/logger"));
40
+ const logger_1 = __importStar(require("@graphql-markdown/logger"));
11
41
  const NAME = "docusaurus-graphql-doc-generator";
12
42
  const LOGGER_MODULE = "@docusaurus/logger";
13
43
  const MDX_PACKAGE = "@graphql-markdown/docusaurus/mdx";
@@ -31,6 +61,7 @@ async function pluginGraphQLDocGenerator(_, options) {
31
61
  if (options.runOnBuild !== true) {
32
62
  return;
33
63
  }
64
+ (0, logger_1.log)("`runOnBuild` option is deprecated and will be removed in a future release. Use the `graphql-to-doc` CLI command instead.", logger_1.LogLevel.warn);
34
65
  await (0, cli_1.runGraphQLMarkdown)(options, {}, LOGGER_MODULE);
35
66
  },
36
67
  /**
@@ -40,7 +40,7 @@ const beforeGenerateIndexMetafileHook = async (event) => {
40
40
  const position = typeof options?.sidebarPosition === "number"
41
41
  ? options.sidebarPosition
42
42
  : SidebarPosition.FIRST;
43
- const content = `label: ${label}\nposition: ${position}\n${className}link: ${link}\ncollapsible: ${options?.collapsible ?? true}\ncollapsed: ${options?.collapsed ?? true}\n`;
43
+ const content = `label: ${label}\nposition: ${position}\n${className}link: ${link}\ncollapsible: ${Boolean(options?.collapsible ?? true)}\ncollapsed: ${Boolean(options?.collapsed ?? true)}\n`;
44
44
  await (0, utils_1.ensureDir)(dirPath);
45
45
  await (0, utils_1.saveFile)(filePath, content);
46
46
  };
@@ -1 +1 @@
1
- {"version":3,"file":"components.d.ts","sourceRoot":"","sources":["../../src/mdx/components.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAEzD;;;;;;GAMG;AAEH;;;GAGG;AACH,eAAO,MAAM,cAAc,EAAE,SA4Bf,CAAC"}
1
+ {"version":3,"file":"components.d.ts","sourceRoot":"","sources":["../../src/mdx/components.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAEzD;;;;;;GAMG;AAEH;;;GAGG;AACH,eAAO,MAAM,cAAc,EAAE,SAQf,CAAC"}
@@ -23,25 +23,5 @@ export const SpecifiedBy = (props) => <>Specification<a className="link" style={
23
23
 
24
24
  export const Badge = (props) => <><span className={props.class}>{props.text}</span></>
25
25
 
26
- import { useState } from 'react';
27
-
28
- export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => {
29
- const [open, setOpen] = useState(startOpen);
30
- return (
31
- <details {...(open ? { open: true } : {})} className="details" style={{ border:'none', boxShadow:'none', background:'var(--ifm-background-color)' }}>
32
- <summary
33
- onClick={(e) => {
34
- e.preventDefault();
35
- setOpen((open) => !open);
36
- }}
37
- style={{ listStyle:'none' }}
38
- >
39
- {open ? dataOpen : dataClose}
40
- </summary>
41
- {open && children}
42
- </details>
43
- );
44
- };
45
-
46
26
 
47
27
  `;
@@ -65,9 +65,9 @@ export declare const formatMDXFrontmatter: (_props: Maybe<FrontMatterOptions>, f
65
65
  /**
66
66
  * Creates an MDX formatter for Docusaurus documentation.
67
67
  *
68
- * The MDX formatter produces React component-based markup compatible
69
- * with Docusaurus MDX rendering. It uses components like `<Badge>`,
70
- * `<Bullet>`, `<Details>`, and `<SpecifiedBy>`.
68
+ * The MDX formatter produces MDX/HTML markup compatible with Docusaurus.
69
+ * It uses helper components like `<Badge>`, `<Bullet>`, and `<SpecifiedBy>`,
70
+ * and emits native `<details>/<summary>` blocks for collapsible sections.
71
71
  *
72
72
  * @param meta - Optional metadata for framework-specific formatting
73
73
  * @returns A complete Formatter implementation for MDX output
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/mdx/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EACV,cAAc,EACd,KAAK,EACL,iBAAiB,EACjB,SAAS,EACT,kBAAkB,EAClB,KAAK,EACL,SAAS,EACT,QAAQ,EACR,QAAQ,EACT,MAAM,yBAAyB,CAAC;AAWjC,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,EAAE,+BAA+B,EAAE,MAAM,YAAY,CAAC;AAE7D;;;;GAIG;AACH,eAAO,MAAM,cAAc,2CAI1B,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,6EAU/B,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,eAAe,8BAE3B,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,4DAK5B,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,4BAEpC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,yDAM/B,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,aAAa,uCAKzB,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB,8EAShC,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,kBAAkB,uCAU7B,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/mdx/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EACV,cAAc,EACd,KAAK,EACL,iBAAiB,EACjB,SAAS,EACT,kBAAkB,EAClB,KAAK,EACL,SAAS,EACT,QAAQ,EACR,QAAQ,EACT,MAAM,yBAAyB,CAAC;AAWjC,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,EAAE,+BAA+B,EAAE,MAAM,YAAY,CAAC;AAE7D;;;;GAIG;AACH,eAAO,MAAM,cAAc,2CAI1B,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,6EAU/B,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,eAAe,8BAE3B,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,4DAO5B,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,4BAEpC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,yDAM/B,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,aAAa,uCAKzB,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB,8EAShC,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,kBAAkB,uCAgB9B,CAAC"}
package/dist/mdx/index.js CHANGED
@@ -57,7 +57,9 @@ exports.formatMDXBullet = formatMDXBullet;
57
57
  * @returns Formatted MDX string for the collapsible section
58
58
  */
59
59
  const formatMDXDetails = ({ dataOpen, dataClose, }) => {
60
- return `${utils_1.MARKDOWN_EOP}<Details dataOpen="Hide ${dataOpen}" dataClose="Show ${dataClose}">${utils_1.MARKDOWN_EOP}\r${utils_1.MARKDOWN_EOP}</Details>${utils_1.MARKDOWN_EOP}`;
60
+ const openLabel = (0, utils_1.escapeMDX)(`Hide ${dataOpen}`);
61
+ const closeLabel = (0, utils_1.escapeMDX)(`Show ${dataClose}`);
62
+ return `${utils_1.MARKDOWN_EOP}<details class="graphql-markdown-details">${utils_1.MARKDOWN_EOL}<summary>${utils_1.MARKDOWN_EOL}<span class="graphql-markdown-details-label-closed">${closeLabel}</span>${utils_1.MARKDOWN_EOL}<span class="graphql-markdown-details-label-open">${openLabel}</span>${utils_1.MARKDOWN_EOL}</summary>${utils_1.MARKDOWN_EOP}\r${utils_1.MARKDOWN_EOP}</details>${utils_1.MARKDOWN_EOP}`;
61
63
  };
62
64
  exports.formatMDXDetails = formatMDXDetails;
63
65
  /**
@@ -108,9 +110,9 @@ exports.formatMDXFrontmatter = formatMDXFrontmatter;
108
110
  /**
109
111
  * Creates an MDX formatter for Docusaurus documentation.
110
112
  *
111
- * The MDX formatter produces React component-based markup compatible
112
- * with Docusaurus MDX rendering. It uses components like `<Badge>`,
113
- * `<Bullet>`, `<Details>`, and `<SpecifiedBy>`.
113
+ * The MDX formatter produces MDX/HTML markup compatible with Docusaurus.
114
+ * It uses helper components like `<Badge>`, `<Bullet>`, and `<SpecifiedBy>`,
115
+ * and emits native `<details>/<summary>` blocks for collapsible sections.
114
116
  *
115
117
  * @param meta - Optional metadata for framework-specific formatting
116
118
  * @returns A complete Formatter implementation for MDX output
@@ -124,14 +126,18 @@ exports.formatMDXFrontmatter = formatMDXFrontmatter;
124
126
  * // '<Badge class="badge badge--secondary " text="Required"/>'
125
127
  * ```
126
128
  */
127
- const createMDXFormatter = (meta) => ({
128
- formatMDXBadge: exports.formatMDXBadge,
129
- formatMDXAdmonition: (admonition, _meta) => (0, exports.formatMDXAdmonition)(admonition, meta ?? _meta),
130
- formatMDXBullet: exports.formatMDXBullet,
131
- formatMDXDetails: exports.formatMDXDetails,
132
- formatMDXFrontmatter: exports.formatMDXFrontmatter,
133
- formatMDXLink: exports.formatMDXLink,
134
- formatMDXNameEntity: exports.formatMDXNameEntity,
135
- formatMDXSpecifiedByLink: exports.formatMDXSpecifiedByLink,
136
- });
129
+ const createMDXFormatter = (meta) => {
130
+ return {
131
+ formatMDXBadge: exports.formatMDXBadge,
132
+ formatMDXAdmonition: (admonition, _meta) => {
133
+ return (0, exports.formatMDXAdmonition)(admonition, meta ?? _meta);
134
+ },
135
+ formatMDXBullet: exports.formatMDXBullet,
136
+ formatMDXDetails: exports.formatMDXDetails,
137
+ formatMDXFrontmatter: exports.formatMDXFrontmatter,
138
+ formatMDXLink: exports.formatMDXLink,
139
+ formatMDXNameEntity: exports.formatMDXNameEntity,
140
+ formatMDXSpecifiedByLink: exports.formatMDXSpecifiedByLink,
141
+ };
142
+ };
137
143
  exports.createMDXFormatter = createMDXFormatter;
package/package.json CHANGED
@@ -5,7 +5,7 @@
5
5
  "bugs": {
6
6
  "url": "https://github.com/graphql-markdown/graphql-markdown/issues"
7
7
  },
8
- "version": "1.33.0",
8
+ "version": "1.34.0",
9
9
  "license": "MIT",
10
10
  "repository": {
11
11
  "type": "git",
@@ -60,18 +60,29 @@
60
60
  "scripts": {
61
61
  "stryker": "stryker run",
62
62
  "clean": "tsgo --build --clean && rm -rf ./dist",
63
- "docs": "typedoc",
64
- "build": "tsgo --build"
63
+ "docs": "typedoc --options typedoc.config.mjs",
64
+ "build": "tsgo --build",
65
+ "lint": "eslint --config ../../packages/tooling-config/eslint/config.ts \"{src,tests}/**/*.{ts,js,json,gql}\"",
66
+ "lint:fix": "eslint --config ../../packages/tooling-config/eslint/config.ts \"{src,tests}/**/*.{ts,js,json,gql}\" --fix",
67
+ "prettier": "prettier \"{src,tests,assets}/**/*.{ts,js,json,md,gql}\" --check",
68
+ "prettier:fix": "prettier \"{src,tests,assets}/**/*.{ts,js,json,md,gql}\" --write",
69
+ "ts:check": "tsgo --noEmit",
70
+ "test": "jest",
71
+ "test:unit": "jest --passWithNoTests --testPathPatterns=tests/unit",
72
+ "test:integration": "jest --passWithNoTests --testPathPatterns=tests/integration",
73
+ "test:ci": "jest --passWithNoTests --ci --silent --randomize --runInBand",
74
+ "test:watch": "jest --watch"
65
75
  },
66
76
  "dependencies": {
67
- "@graphql-markdown/cli": "^0.6.1",
68
- "@graphql-markdown/logger": "^1.0.5",
69
- "@graphql-markdown/utils": "^1.9.2",
77
+ "@graphql-markdown/cli": "^0.7.1",
78
+ "@graphql-markdown/logger": "^1.0.6",
79
+ "@graphql-markdown/types": "^1.12.0",
80
+ "@graphql-markdown/utils": "^1.11.0",
70
81
  "@docusaurus/utils": ">=3.9.2"
71
82
  },
72
83
  "devDependencies": {
73
84
  "@docusaurus/types": "^3.7.0",
74
- "@graphql-markdown/types": "^1.10.1"
85
+ "@graphql-markdown/tooling-config": "^1.0.0"
75
86
  },
76
87
  "peerDependencies": {
77
88
  "@docusaurus/logger": "*"