From 59787df04f623c4d22d334d0517b1ce13160d934 Mon Sep 17 00:00:00 2001 From: Aviv Keller Date: Thu, 30 Jul 2026 14:23:49 -0700 Subject: [PATCH] refactor(node): extract @doc-kittens/node package --- .changeset/node-kitten-package.md | 9 +++++++++ README.md | 2 +- docs/configuration.md | 2 +- eslint.config.mjs | 2 +- package-lock.json | 17 ++++++++++++++++- packages/core/package.json | 4 ---- packages/core/src/generators/index.mjs | 6 +++--- .../src}/addon-verify/README.md | 0 .../src}/addon-verify/constants.mjs | 0 .../src}/addon-verify/generate.mjs | 4 ++-- .../src}/addon-verify/index.mjs | 0 .../src}/addon-verify/types.d.ts | 2 +- .../utils/__tests__/generateFileList.test.mjs | 0 .../utils/__tests__/section.test.mjs | 0 .../addon-verify/utils/generateFileList.mjs | 2 +- .../src}/addon-verify/utils/section.mjs | 0 .../generators => node/src}/api-links/README.md | 0 .../src}/api-links/__tests__/fixtures.test.mjs | 10 +++++----- .../__tests__/fixtures.test.mjs.snapshot | 0 .../src}/api-links/__tests__/fixtures/buffer.js | 0 .../src}/api-links/__tests__/fixtures/class.js | 0 .../api-links/__tests__/fixtures/exports.js | 0 .../src}/api-links/__tests__/fixtures/mod.js | 0 .../api-links/__tests__/fixtures/prototype.js | 0 .../api-links/__tests__/fixtures/reverse.js | 0 .../src}/api-links/__tests__/fixtures/root.js | 0 .../src}/api-links/constants.mjs | 0 .../src}/api-links/generate.mjs | 7 ++++--- .../generators => node/src}/api-links/index.mjs | 3 ++- .../src}/api-links/types.d.ts | 0 .../api-links/utils/checkIndirectReferences.mjs | 0 .../src}/api-links/utils/extractExports.mjs | 0 .../src}/api-links/utils/findDefinitions.mjs | 0 .../generators => node/src}/man-page/README.md | 0 .../src}/man-page/generate.mjs | 9 +++++---- .../generators => node/src}/man-page/index.mjs | 0 .../generators => node/src}/man-page/template.1 | 0 .../generators => node/src}/man-page/types.d.ts | 2 +- .../man-page/utils/__tests__/converter.test.mjs | 0 .../src}/man-page/utils/converter.mjs | 4 ++-- 40 files changed, 54 insertions(+), 31 deletions(-) create mode 100644 .changeset/node-kitten-package.md rename packages/{core/src/generators => node/src}/addon-verify/README.md (100%) rename packages/{core/src/generators => node/src}/addon-verify/constants.mjs (100%) rename packages/{core/src/generators => node/src}/addon-verify/generate.mjs (93%) rename packages/{core/src/generators => node/src}/addon-verify/index.mjs (100%) rename packages/{core/src/generators => node/src}/addon-verify/types.d.ts (58%) rename packages/{core/src/generators => node/src}/addon-verify/utils/__tests__/generateFileList.test.mjs (100%) rename packages/{core/src/generators => node/src}/addon-verify/utils/__tests__/section.test.mjs (100%) rename packages/{core/src/generators => node/src}/addon-verify/utils/generateFileList.mjs (95%) rename packages/{core/src/generators => node/src}/addon-verify/utils/section.mjs (100%) rename packages/{core/src/generators => node/src}/api-links/README.md (100%) rename packages/{core/src/generators => node/src}/api-links/__tests__/fixtures.test.mjs (79%) rename packages/{core/src/generators => node/src}/api-links/__tests__/fixtures.test.mjs.snapshot (100%) rename packages/{core/src/generators => node/src}/api-links/__tests__/fixtures/buffer.js (100%) rename packages/{core/src/generators => node/src}/api-links/__tests__/fixtures/class.js (100%) rename packages/{core/src/generators => node/src}/api-links/__tests__/fixtures/exports.js (100%) rename packages/{core/src/generators => node/src}/api-links/__tests__/fixtures/mod.js (100%) rename packages/{core/src/generators => node/src}/api-links/__tests__/fixtures/prototype.js (100%) rename packages/{core/src/generators => node/src}/api-links/__tests__/fixtures/reverse.js (100%) rename packages/{core/src/generators => node/src}/api-links/__tests__/fixtures/root.js (100%) rename packages/{core/src/generators => node/src}/api-links/constants.mjs (100%) rename packages/{core/src/generators => node/src}/api-links/generate.mjs (87%) rename packages/{core/src/generators => node/src}/api-links/index.mjs (90%) rename packages/{core/src/generators => node/src}/api-links/types.d.ts (100%) rename packages/{core/src/generators => node/src}/api-links/utils/checkIndirectReferences.mjs (100%) rename packages/{core/src/generators => node/src}/api-links/utils/extractExports.mjs (100%) rename packages/{core/src/generators => node/src}/api-links/utils/findDefinitions.mjs (100%) rename packages/{core/src/generators => node/src}/man-page/README.md (100%) rename packages/{core/src/generators => node/src}/man-page/generate.mjs (83%) rename packages/{core/src/generators => node/src}/man-page/index.mjs (100%) rename packages/{core/src/generators => node/src}/man-page/template.1 (100%) rename packages/{core/src/generators => node/src}/man-page/types.d.ts (73%) rename packages/{core/src/generators => node/src}/man-page/utils/__tests__/converter.test.mjs (100%) rename packages/{core/src/generators => node/src}/man-page/utils/converter.mjs (95%) diff --git a/.changeset/node-kitten-package.md b/.changeset/node-kitten-package.md new file mode 100644 index 00000000..8094c948 --- /dev/null +++ b/.changeset/node-kitten-package.md @@ -0,0 +1,9 @@ +--- +'@doc-kittens/node': major +'@node-core/doc-kit': minor +--- + +The Node.js-specific generators (`api-links`, `addon-verify`, and +`man-page`) now live in the new `@doc-kittens/node` package and are loaded +via import specifiers such as `@doc-kittens/node/man-page`. The CLI +shorthand names are unchanged. diff --git a/README.md b/README.md index d77417c2..d2c352ef 100644 --- a/README.md +++ b/README.md @@ -98,7 +98,7 @@ To generate [our redesigned documentation pages](https://nodejs-api-docs-tooling ```sh npx doc-kit generate \ - -t web \ + -t html \ -t orama-db \ -i "path/to/node/doc/api/*.md" \ -o out \ diff --git a/docs/configuration.md b/docs/configuration.md index eef68555..214d2857 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -39,7 +39,7 @@ export default { // Targets, alternatively supplied by command line flags. Each entry is // either a built-in shorthand name or an import specifier resolving to a // generator module (e.g. '@my-scope/my-package/my-generator'). - target: ['orama-db', 'web'], + target: ['orama-db', 'html'], global: { version: '20.0.0', minify: true, diff --git a/eslint.config.mjs b/eslint.config.mjs index f8dceaa5..5f890af3 100644 --- a/eslint.config.mjs +++ b/eslint.config.mjs @@ -13,7 +13,7 @@ export default defineConfig([ ignores: [ 'www/out', 'out/', - 'packages/core/src/generators/api-links/__tests__/fixtures/', + 'packages/node/src/api-links/__tests__/fixtures/', ], }, { diff --git a/package-lock.json b/package-lock.json index 9c8ad678..2020df5f 100644 --- a/package-lock.json +++ b/package-lock.json @@ -409,6 +409,10 @@ "resolved": "packages/legacy", "link": true }, + "node_modules/@doc-kittens/node": { + "resolved": "packages/node", + "link": true + }, "node_modules/@doc-kittens/react": { "resolved": "packages/react", "link": true @@ -11357,7 +11361,6 @@ "commander": "^15.0.0", "cosmiconfig": "^9.0.2", "dedent": "^1.7.2", - "estree-util-visit": "^2.0.0", "github-slugger": "^2.0.0", "glob-parent": "^6.0.2", "hastscript": "^9.0.1", @@ -11394,6 +11397,18 @@ "unist-util-visit": "^5.1.0" } }, + "packages/node": { + "name": "@doc-kittens/node", + "version": "0.0.0", + "dependencies": { + "@node-core/doc-kit": "^1.4.3", + "dedent": "^1.7.2", + "estree-util-visit": "^2.0.0", + "tinyglobby": "^0.2.17", + "unist-builder": "^4.0.0", + "unist-util-visit": "^5.1.0" + } + }, "packages/react": { "name": "@doc-kittens/react", "version": "0.0.0", diff --git a/packages/core/package.json b/packages/core/package.json index b0a870c0..19e5c08b 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -18,12 +18,9 @@ "main": "./src/generators.mjs", "exports": { ".": "./src/generators.mjs", - "./addon-verify": "./src/generators/addon-verify/index.mjs", - "./api-links": "./src/generators/api-links/index.mjs", "./ast": "./src/generators/ast/index.mjs", "./ast-js": "./src/generators/ast-js/index.mjs", "./json-simple": "./src/generators/json-simple/index.mjs", - "./man-page": "./src/generators/man-page/index.mjs", "./metadata": "./src/generators/metadata/index.mjs", "./package.json": "./package.json", "./shiki.config.mjs": "./shiki.config.mjs", @@ -52,7 +49,6 @@ "commander": "^15.0.0", "cosmiconfig": "^9.0.2", "dedent": "^1.7.2", - "estree-util-visit": "^2.0.0", "github-slugger": "^2.0.0", "glob-parent": "^6.0.2", "hastscript": "^9.0.1", diff --git a/packages/core/src/generators/index.mjs b/packages/core/src/generators/index.mjs index ae94a6b2..fd4c0580 100644 --- a/packages/core/src/generators/index.mjs +++ b/packages/core/src/generators/index.mjs @@ -13,11 +13,11 @@ export const publicGenerators = { 'json-simple': '@node-core/doc-kit/json-simple', 'legacy-html': '@doc-kittens/legacy/legacy-html', 'legacy-html-all': '@doc-kittens/legacy/legacy-html-all', - 'man-page': '@node-core/doc-kit/man-page', + 'man-page': '@doc-kittens/node/man-page', 'legacy-json': '@doc-kittens/legacy/legacy-json', 'legacy-json-all': '@doc-kittens/legacy/legacy-json-all', - 'addon-verify': '@node-core/doc-kit/addon-verify', - 'api-links': '@node-core/doc-kit/api-links', + 'addon-verify': '@doc-kittens/node/addon-verify', + 'api-links': '@doc-kittens/node/api-links', 'orama-db': '@doc-kittens/react/orama-db', 'llms-txt': '@doc-kittens/react/llms-txt', sitemap: '@doc-kittens/react/sitemap', diff --git a/packages/core/src/generators/addon-verify/README.md b/packages/node/src/addon-verify/README.md similarity index 100% rename from packages/core/src/generators/addon-verify/README.md rename to packages/node/src/addon-verify/README.md diff --git a/packages/core/src/generators/addon-verify/constants.mjs b/packages/node/src/addon-verify/constants.mjs similarity index 100% rename from packages/core/src/generators/addon-verify/constants.mjs rename to packages/node/src/addon-verify/constants.mjs diff --git a/packages/core/src/generators/addon-verify/generate.mjs b/packages/node/src/addon-verify/generate.mjs similarity index 93% rename from packages/core/src/generators/addon-verify/generate.mjs rename to packages/node/src/addon-verify/generate.mjs index 91f9b463..c30949ec 100644 --- a/packages/core/src/generators/addon-verify/generate.mjs +++ b/packages/node/src/addon-verify/generate.mjs @@ -3,6 +3,8 @@ import { mkdir } from 'node:fs/promises'; import { join } from 'node:path'; +import getConfig from '@node-core/doc-kit/utils/configuration/index.mjs'; +import { writeFile } from '@node-core/doc-kit/utils/file.mjs'; import { visit } from 'unist-util-visit'; import { EXTRACT_CODE_FILENAME_COMMENT } from './constants.mjs'; @@ -12,8 +14,6 @@ import { isBuildableSection, normalizeSectionName, } from './utils/section.mjs'; -import getConfig from '../../utils/configuration/index.mjs'; -import { writeFile } from '../../utils/file.mjs'; /** * Generates a file list from code blocks. diff --git a/packages/core/src/generators/addon-verify/index.mjs b/packages/node/src/addon-verify/index.mjs similarity index 100% rename from packages/core/src/generators/addon-verify/index.mjs rename to packages/node/src/addon-verify/index.mjs diff --git a/packages/core/src/generators/addon-verify/types.d.ts b/packages/node/src/addon-verify/types.d.ts similarity index 58% rename from packages/core/src/generators/addon-verify/types.d.ts rename to packages/node/src/addon-verify/types.d.ts index c893d8d0..42f449ff 100644 --- a/packages/core/src/generators/addon-verify/types.d.ts +++ b/packages/node/src/addon-verify/types.d.ts @@ -1,4 +1,4 @@ -import type { MetadataEntry } from '../metadata/types'; +import type { MetadataEntry } from '@node-core/doc-kit/generators/metadata/types'; export type Generator = GeneratorMetadata< {}, diff --git a/packages/core/src/generators/addon-verify/utils/__tests__/generateFileList.test.mjs b/packages/node/src/addon-verify/utils/__tests__/generateFileList.test.mjs similarity index 100% rename from packages/core/src/generators/addon-verify/utils/__tests__/generateFileList.test.mjs rename to packages/node/src/addon-verify/utils/__tests__/generateFileList.test.mjs diff --git a/packages/core/src/generators/addon-verify/utils/__tests__/section.test.mjs b/packages/node/src/addon-verify/utils/__tests__/section.test.mjs similarity index 100% rename from packages/core/src/generators/addon-verify/utils/__tests__/section.test.mjs rename to packages/node/src/addon-verify/utils/__tests__/section.test.mjs diff --git a/packages/core/src/generators/addon-verify/utils/generateFileList.mjs b/packages/node/src/addon-verify/utils/generateFileList.mjs similarity index 95% rename from packages/core/src/generators/addon-verify/utils/generateFileList.mjs rename to packages/node/src/addon-verify/utils/generateFileList.mjs index 14c56c67..6df13554 100644 --- a/packages/core/src/generators/addon-verify/utils/generateFileList.mjs +++ b/packages/node/src/addon-verify/utils/generateFileList.mjs @@ -9,7 +9,7 @@ import dedent from 'dedent'; const updateJsRequirePaths = content => { return dedent` 'use strict'; - const common = require('../../common'); + const common = require('@node-core/doc-kit/generators/common'); ${content.replace( "'./build/Release/addon'", '`./build/${common.buildType}/addon`' diff --git a/packages/core/src/generators/addon-verify/utils/section.mjs b/packages/node/src/addon-verify/utils/section.mjs similarity index 100% rename from packages/core/src/generators/addon-verify/utils/section.mjs rename to packages/node/src/addon-verify/utils/section.mjs diff --git a/packages/core/src/generators/api-links/README.md b/packages/node/src/api-links/README.md similarity index 100% rename from packages/core/src/generators/api-links/README.md rename to packages/node/src/api-links/README.md diff --git a/packages/core/src/generators/api-links/__tests__/fixtures.test.mjs b/packages/node/src/api-links/__tests__/fixtures.test.mjs similarity index 79% rename from packages/core/src/generators/api-links/__tests__/fixtures.test.mjs rename to packages/node/src/api-links/__tests__/fixtures.test.mjs index f3199e6d..432c09b6 100644 --- a/packages/core/src/generators/api-links/__tests__/fixtures.test.mjs +++ b/packages/node/src/api-links/__tests__/fixtures.test.mjs @@ -1,13 +1,13 @@ import { basename, join, relative, sep } from 'node:path'; import { after, before, describe, it } from 'node:test'; +import { generate as astJsGenerate } from '@node-core/doc-kit/generators/ast-js/generate.mjs'; +import { loadGenerator } from '@node-core/doc-kit/generators/loader.mjs'; +import createWorkerPool from '@node-core/doc-kit/threading/index.mjs'; +import createParallelWorker from '@node-core/doc-kit/threading/parallel.mjs'; +import { setConfig } from '@node-core/doc-kit/utils/configuration/index.mjs'; import { globSync } from 'tinyglobby'; -import { loadGenerator } from '../../../generators/loader.mjs'; -import createWorkerPool from '../../../threading/index.mjs'; -import createParallelWorker from '../../../threading/parallel.mjs'; -import { setConfig } from '../../../utils/configuration/index.mjs'; -import { generate as astJsGenerate } from '../../ast-js/generate.mjs'; import { generate as apiLinksGenerate } from '../generate.mjs'; const relativePath = relative(process.cwd(), import.meta.dirname); diff --git a/packages/core/src/generators/api-links/__tests__/fixtures.test.mjs.snapshot b/packages/node/src/api-links/__tests__/fixtures.test.mjs.snapshot similarity index 100% rename from packages/core/src/generators/api-links/__tests__/fixtures.test.mjs.snapshot rename to packages/node/src/api-links/__tests__/fixtures.test.mjs.snapshot diff --git a/packages/core/src/generators/api-links/__tests__/fixtures/buffer.js b/packages/node/src/api-links/__tests__/fixtures/buffer.js similarity index 100% rename from packages/core/src/generators/api-links/__tests__/fixtures/buffer.js rename to packages/node/src/api-links/__tests__/fixtures/buffer.js diff --git a/packages/core/src/generators/api-links/__tests__/fixtures/class.js b/packages/node/src/api-links/__tests__/fixtures/class.js similarity index 100% rename from packages/core/src/generators/api-links/__tests__/fixtures/class.js rename to packages/node/src/api-links/__tests__/fixtures/class.js diff --git a/packages/core/src/generators/api-links/__tests__/fixtures/exports.js b/packages/node/src/api-links/__tests__/fixtures/exports.js similarity index 100% rename from packages/core/src/generators/api-links/__tests__/fixtures/exports.js rename to packages/node/src/api-links/__tests__/fixtures/exports.js diff --git a/packages/core/src/generators/api-links/__tests__/fixtures/mod.js b/packages/node/src/api-links/__tests__/fixtures/mod.js similarity index 100% rename from packages/core/src/generators/api-links/__tests__/fixtures/mod.js rename to packages/node/src/api-links/__tests__/fixtures/mod.js diff --git a/packages/core/src/generators/api-links/__tests__/fixtures/prototype.js b/packages/node/src/api-links/__tests__/fixtures/prototype.js similarity index 100% rename from packages/core/src/generators/api-links/__tests__/fixtures/prototype.js rename to packages/node/src/api-links/__tests__/fixtures/prototype.js diff --git a/packages/core/src/generators/api-links/__tests__/fixtures/reverse.js b/packages/node/src/api-links/__tests__/fixtures/reverse.js similarity index 100% rename from packages/core/src/generators/api-links/__tests__/fixtures/reverse.js rename to packages/node/src/api-links/__tests__/fixtures/reverse.js diff --git a/packages/core/src/generators/api-links/__tests__/fixtures/root.js b/packages/node/src/api-links/__tests__/fixtures/root.js similarity index 100% rename from packages/core/src/generators/api-links/__tests__/fixtures/root.js rename to packages/node/src/api-links/__tests__/fixtures/root.js diff --git a/packages/core/src/generators/api-links/constants.mjs b/packages/node/src/api-links/constants.mjs similarity index 100% rename from packages/core/src/generators/api-links/constants.mjs rename to packages/node/src/api-links/constants.mjs diff --git a/packages/core/src/generators/api-links/generate.mjs b/packages/node/src/api-links/generate.mjs similarity index 87% rename from packages/core/src/generators/api-links/generate.mjs rename to packages/node/src/api-links/generate.mjs index 3890a308..f8cf9247 100644 --- a/packages/core/src/generators/api-links/generate.mjs +++ b/packages/node/src/api-links/generate.mjs @@ -2,12 +2,13 @@ import { basename, join } from 'node:path'; +import getConfig from '@node-core/doc-kit/utils/configuration/index.mjs'; +import { populate } from '@node-core/doc-kit/utils/configuration/templates.mjs'; +import { withExt, writeFile } from '@node-core/doc-kit/utils/file.mjs'; + import { checkIndirectReferences } from './utils/checkIndirectReferences.mjs'; import { extractExports } from './utils/extractExports.mjs'; import { findDefinitions } from './utils/findDefinitions.mjs'; -import getConfig from '../../utils/configuration/index.mjs'; -import { populate } from '../../utils/configuration/templates.mjs'; -import { withExt, writeFile } from '../../utils/file.mjs'; /** * Generates the `apilinks.json` file. diff --git a/packages/core/src/generators/api-links/index.mjs b/packages/node/src/api-links/index.mjs similarity index 90% rename from packages/core/src/generators/api-links/index.mjs rename to packages/node/src/api-links/index.mjs index fb988f99..677ef958 100644 --- a/packages/core/src/generators/api-links/index.mjs +++ b/packages/node/src/api-links/index.mjs @@ -1,7 +1,8 @@ 'use strict'; +import { GITHUB_BLOB_URL } from '@node-core/doc-kit/utils/configuration/templates.mjs'; + import { generate } from './generate.mjs'; -import { GITHUB_BLOB_URL } from '../../utils/configuration/templates.mjs'; /** * This generator is responsible for mapping publicly accessible functions in diff --git a/packages/core/src/generators/api-links/types.d.ts b/packages/node/src/api-links/types.d.ts similarity index 100% rename from packages/core/src/generators/api-links/types.d.ts rename to packages/node/src/api-links/types.d.ts diff --git a/packages/core/src/generators/api-links/utils/checkIndirectReferences.mjs b/packages/node/src/api-links/utils/checkIndirectReferences.mjs similarity index 100% rename from packages/core/src/generators/api-links/utils/checkIndirectReferences.mjs rename to packages/node/src/api-links/utils/checkIndirectReferences.mjs diff --git a/packages/core/src/generators/api-links/utils/extractExports.mjs b/packages/node/src/api-links/utils/extractExports.mjs similarity index 100% rename from packages/core/src/generators/api-links/utils/extractExports.mjs rename to packages/node/src/api-links/utils/extractExports.mjs diff --git a/packages/core/src/generators/api-links/utils/findDefinitions.mjs b/packages/node/src/api-links/utils/findDefinitions.mjs similarity index 100% rename from packages/core/src/generators/api-links/utils/findDefinitions.mjs rename to packages/node/src/api-links/utils/findDefinitions.mjs diff --git a/packages/core/src/generators/man-page/README.md b/packages/node/src/man-page/README.md similarity index 100% rename from packages/core/src/generators/man-page/README.md rename to packages/node/src/man-page/README.md diff --git a/packages/core/src/generators/man-page/generate.mjs b/packages/node/src/man-page/generate.mjs similarity index 83% rename from packages/core/src/generators/man-page/generate.mjs rename to packages/node/src/man-page/generate.mjs index 4f779f71..e690fd30 100644 --- a/packages/core/src/generators/man-page/generate.mjs +++ b/packages/node/src/man-page/generate.mjs @@ -3,18 +3,19 @@ import { readFile } from 'node:fs/promises'; import { join } from 'node:path'; +import getConfig from '@node-core/doc-kit/utils/configuration/index.mjs'; +import { writeFile } from '@node-core/doc-kit/utils/file.mjs'; + import { convertOptionToMandoc, convertEnvVarToMandoc, } from './utils/converter.mjs'; -import getConfig from '../../utils/configuration/index.mjs'; -import { writeFile } from '../../utils/file.mjs'; /** - * @param {Array} components + * @param {Array} components * @param {number} start * @param {number} end - * @param {(element: import('../metadata/types').MetadataEntry) => string} convert + * @param {(element: import('@node-core/doc-kit/generators/metadata/types').MetadataEntry) => string} convert * @returns {string} */ function extractMandoc(components, start, end, convert) { diff --git a/packages/core/src/generators/man-page/index.mjs b/packages/node/src/man-page/index.mjs similarity index 100% rename from packages/core/src/generators/man-page/index.mjs rename to packages/node/src/man-page/index.mjs diff --git a/packages/core/src/generators/man-page/template.1 b/packages/node/src/man-page/template.1 similarity index 100% rename from packages/core/src/generators/man-page/template.1 rename to packages/node/src/man-page/template.1 diff --git a/packages/core/src/generators/man-page/types.d.ts b/packages/node/src/man-page/types.d.ts similarity index 73% rename from packages/core/src/generators/man-page/types.d.ts rename to packages/node/src/man-page/types.d.ts index 3bab3f6f..d435c89b 100644 --- a/packages/core/src/generators/man-page/types.d.ts +++ b/packages/node/src/man-page/types.d.ts @@ -1,4 +1,4 @@ -import { MetadataEntry } from '../metadata/types'; +import { MetadataEntry } from '@node-core/doc-kit/generators/metadata/types'; export type Generator = GeneratorMetadata< { diff --git a/packages/core/src/generators/man-page/utils/__tests__/converter.test.mjs b/packages/node/src/man-page/utils/__tests__/converter.test.mjs similarity index 100% rename from packages/core/src/generators/man-page/utils/__tests__/converter.test.mjs rename to packages/node/src/man-page/utils/__tests__/converter.test.mjs diff --git a/packages/core/src/generators/man-page/utils/converter.mjs b/packages/node/src/man-page/utils/converter.mjs similarity index 95% rename from packages/core/src/generators/man-page/utils/converter.mjs rename to packages/node/src/man-page/utils/converter.mjs index fe496285..e5bf9b5a 100644 --- a/packages/core/src/generators/man-page/utils/converter.mjs +++ b/packages/node/src/man-page/utils/converter.mjs @@ -126,7 +126,7 @@ const formatFlag = flag => * This function formats command-line options, including flags and descriptions, * for display in Unix manual pages using Mandoc. * - * @param {import('../../metadata/types').MetadataEntry} element - The metadata entry containing details about the API option. + * @param {import('@node-core/doc-kit/generators/metadata/types').MetadataEntry} element - The metadata entry containing details about the API option. * @returns {string} The Mandoc formatted string representing the API option, including flags and content. */ export function convertOptionToMandoc(element) { @@ -150,7 +150,7 @@ export function convertOptionToMandoc(element) { * This function formats environment variables for Unix manual pages, converting * the variable name and value, along with any associated descriptions, into Mandoc. * - * @param {import('../../metadata/types').MetadataEntry} element - The metadata entry containing details about the environment variable. + * @param {import('@node-core/doc-kit/generators/metadata/types').MetadataEntry} element - The metadata entry containing details about the environment variable. * @returns {string} The Mandoc formatted representation of the environment variable and its content. */ export function convertEnvVarToMandoc(element) {