diff --git a/docs/generators.md b/docs/generators.md index d86f9465..90f9c829 100644 --- a/docs/generators.md +++ b/docs/generators.md @@ -83,8 +83,6 @@ import { createLazyGenerator } from '../../utils/generators.mjs'; export default createLazyGenerator({ name: 'my-format', - version: '1.0.0', - description: 'Generates documentation in MyFormat', // This generator depends on the metadata generator @@ -189,8 +187,6 @@ import { createLazyGenerator } from '../../utils/generators.mjs'; export default createLazyGenerator({ name: 'parallel-generator', - version: '1.0.0', - description: 'Processes data in parallel', dependsOn: 'metadata', @@ -285,8 +281,6 @@ import { createLazyGenerator } from '../../utils/generators.mjs'; export default createLazyGenerator({ name: 'streaming-generator', - version: '1.0.0', - description: 'Streams results as they are ready', dependsOn: 'metadata', @@ -345,8 +339,6 @@ import { createLazyGenerator } from '../../utils/generators.mjs'; export default createLazyGenerator({ name: 'batch-generator', - version: '1.0.0', - description: 'Requires all input at once', dependsOn: 'jsx-ast', diff --git a/src/generators/__tests__/index.test.mjs b/src/generators/__tests__/index.test.mjs index 8efd3c9a..865eac65 100644 --- a/src/generators/__tests__/index.test.mjs +++ b/src/generators/__tests__/index.test.mjs @@ -1,8 +1,6 @@ import assert from 'node:assert/strict'; import { describe, it } from 'node:test'; -import semver from 'semver'; - import { allGenerators } from '../index.mjs'; const validDependencies = Object.keys(allGenerators); @@ -20,16 +18,6 @@ describe('All Generators', () => { }); }); - it('should have valid semver versions', () => { - allGeneratorsEntries.forEach(([key, generator]) => { - const isValid = semver.valid(generator.version); - assert.ok( - isValid, - `Generator "${key}" has invalid semver version: "${generator.version}"` - ); - }); - }); - it('should have valid dependsOn references', () => { allGeneratorsEntries.forEach(([key, generator]) => { if (generator.dependsOn) { diff --git a/src/generators/addon-verify/index.mjs b/src/generators/addon-verify/index.mjs index fab78599..8f6c4c70 100644 --- a/src/generators/addon-verify/index.mjs +++ b/src/generators/addon-verify/index.mjs @@ -12,8 +12,6 @@ import { createLazyGenerator } from '../../utils/generators.mjs'; export default await createLazyGenerator({ name: 'addon-verify', - version: '1.0.0', - description: 'Generates a file list from code blocks extracted from `doc/api/addons.md` to facilitate C++ compilation and JavaScript runtime validations', diff --git a/src/generators/api-links/index.mjs b/src/generators/api-links/index.mjs index dca3f908..58b69fe3 100644 --- a/src/generators/api-links/index.mjs +++ b/src/generators/api-links/index.mjs @@ -16,8 +16,6 @@ import { createLazyGenerator } from '../../utils/generators.mjs'; export default createLazyGenerator({ name: 'api-links', - version: '1.0.0', - description: 'Creates a mapping of publicly accessible functions to their source locations in the Node.js repository.', diff --git a/src/generators/ast-js/index.mjs b/src/generators/ast-js/index.mjs index 06652167..79e3f564 100644 --- a/src/generators/ast-js/index.mjs +++ b/src/generators/ast-js/index.mjs @@ -15,8 +15,6 @@ import { createLazyGenerator } from '../../utils/generators.mjs'; export default createLazyGenerator({ name: 'ast-js', - version: '1.0.0', - description: 'Parses Javascript source files passed into the input.', hasParallelProcessor: true, diff --git a/src/generators/ast/index.mjs b/src/generators/ast/index.mjs index 4c34b637..52297f5e 100644 --- a/src/generators/ast/index.mjs +++ b/src/generators/ast/index.mjs @@ -11,8 +11,6 @@ import { createLazyGenerator } from '../../utils/generators.mjs'; export default createLazyGenerator({ name: 'ast', - version: '1.0.0', - description: 'Parses Markdown API doc files into AST trees', hasParallelProcessor: true, diff --git a/src/generators/json-simple/index.mjs b/src/generators/json-simple/index.mjs index 9cd62537..04bf2bee 100644 --- a/src/generators/json-simple/index.mjs +++ b/src/generators/json-simple/index.mjs @@ -14,8 +14,6 @@ import { createLazyGenerator } from '../../utils/generators.mjs'; export default createLazyGenerator({ name: 'json-simple', - version: '1.0.0', - description: 'Generates the simple JSON version of the API docs, and returns it as a string', diff --git a/src/generators/jsx-ast/index.mjs b/src/generators/jsx-ast/index.mjs index d6711061..f1a982d6 100644 --- a/src/generators/jsx-ast/index.mjs +++ b/src/generators/jsx-ast/index.mjs @@ -10,8 +10,6 @@ import { createLazyGenerator } from '../../utils/generators.mjs'; export default createLazyGenerator({ name: 'jsx-ast', - version: '1.0.0', - description: 'Generates JSX AST from the input MDAST', dependsOn: 'metadata', diff --git a/src/generators/legacy-html-all/index.mjs b/src/generators/legacy-html-all/index.mjs index 2edea628..088a7076 100644 --- a/src/generators/legacy-html-all/index.mjs +++ b/src/generators/legacy-html-all/index.mjs @@ -15,8 +15,6 @@ import legacyHtml from '../legacy-html/index.mjs'; export default createLazyGenerator({ name: 'legacy-html-all', - version: '1.0.0', - description: 'Generates the `all.html` file from the `legacy-html` generator, which includes all the modules in one single file', diff --git a/src/generators/legacy-html/index.mjs b/src/generators/legacy-html/index.mjs index 32003ec1..caf12ee3 100644 --- a/src/generators/legacy-html/index.mjs +++ b/src/generators/legacy-html/index.mjs @@ -18,8 +18,6 @@ import { createLazyGenerator } from '../../utils/generators.mjs'; export default createLazyGenerator({ name: 'legacy-html', - version: '1.0.0', - description: 'Generates the legacy version of the API docs in HTML, with the assets and styles included as files', diff --git a/src/generators/legacy-json-all/index.mjs b/src/generators/legacy-json-all/index.mjs index dcfe0fab..f58812e1 100644 --- a/src/generators/legacy-json-all/index.mjs +++ b/src/generators/legacy-json-all/index.mjs @@ -11,8 +11,6 @@ import { createLazyGenerator } from '../../utils/generators.mjs'; export default createLazyGenerator({ name: 'legacy-json-all', - version: '1.0.0', - description: 'Generates the `all.json` file from the `legacy-json` generator, which includes all the modules in one single file.', diff --git a/src/generators/legacy-json/index.mjs b/src/generators/legacy-json/index.mjs index a2b5f5d9..e3cbab1e 100644 --- a/src/generators/legacy-json/index.mjs +++ b/src/generators/legacy-json/index.mjs @@ -16,8 +16,6 @@ import { createLazyGenerator } from '../../utils/generators.mjs'; export default createLazyGenerator({ name: 'legacy-json', - version: '1.0.0', - description: 'Generates the legacy version of the JSON API docs.', dependsOn: 'metadata', diff --git a/src/generators/llms-txt/index.mjs b/src/generators/llms-txt/index.mjs index 078ec7f1..8c244128 100644 --- a/src/generators/llms-txt/index.mjs +++ b/src/generators/llms-txt/index.mjs @@ -13,8 +13,6 @@ import { createLazyGenerator } from '../../utils/generators.mjs'; export default createLazyGenerator({ name: 'llms-txt', - version: '1.0.0', - description: 'Generates a llms.txt file to provide information to LLMs at inference time', diff --git a/src/generators/man-page/index.mjs b/src/generators/man-page/index.mjs index 1128720e..92e1c41d 100644 --- a/src/generators/man-page/index.mjs +++ b/src/generators/man-page/index.mjs @@ -13,8 +13,6 @@ import { createLazyGenerator } from '../../utils/generators.mjs'; export default createLazyGenerator({ name: 'man-page', - version: '1.0.0', - description: 'Generates the Node.js man-page.', dependsOn: 'metadata', diff --git a/src/generators/metadata/index.mjs b/src/generators/metadata/index.mjs index 53c426d4..c03448d8 100644 --- a/src/generators/metadata/index.mjs +++ b/src/generators/metadata/index.mjs @@ -10,8 +10,6 @@ import { createLazyGenerator } from '../../utils/generators.mjs'; export default createLazyGenerator({ name: 'metadata', - version: '1.0.0', - description: 'generates a flattened list of API doc metadata entries', dependsOn: 'ast', diff --git a/src/generators/orama-db/index.mjs b/src/generators/orama-db/index.mjs index bb6c2755..cb189ad3 100644 --- a/src/generators/orama-db/index.mjs +++ b/src/generators/orama-db/index.mjs @@ -11,8 +11,6 @@ import { createLazyGenerator } from '../../utils/generators.mjs'; export default createLazyGenerator({ name: 'orama-db', - version: '1.0.0', - description: 'Generates the Orama database for the API docs.', dependsOn: 'metadata', diff --git a/src/generators/sitemap/index.mjs b/src/generators/sitemap/index.mjs index 1f983423..d7b0773b 100644 --- a/src/generators/sitemap/index.mjs +++ b/src/generators/sitemap/index.mjs @@ -10,8 +10,6 @@ import { createLazyGenerator } from '../../utils/generators.mjs'; export default createLazyGenerator({ name: 'sitemap', - version: '1.0.0', - description: 'Generates a sitemap.xml file for search engine optimization', dependsOn: 'metadata', diff --git a/src/generators/types.d.ts b/src/generators/types.d.ts index 6374d800..278ada65 100644 --- a/src/generators/types.d.ts +++ b/src/generators/types.d.ts @@ -65,8 +65,6 @@ declare global { // The name of the Generator. Must match the Key in AllGenerators name: keyof AllGenerators; - version: string; - description: string; hasParallelProcessor: boolean; diff --git a/src/generators/web/index.mjs b/src/generators/web/index.mjs index 97d6f3c8..79f0e0a6 100644 --- a/src/generators/web/index.mjs +++ b/src/generators/web/index.mjs @@ -24,8 +24,6 @@ import { createLazyGenerator } from '../../utils/generators.mjs'; export default createLazyGenerator({ name: 'web', - version: '1.0.0', - description: 'Generates HTML/CSS/JS bundles from JSX AST entries', dependsOn: 'jsx-ast', diff --git a/src/utils/__tests__/generators.test.mjs b/src/utils/__tests__/generators.test.mjs index e4c9e1a8..c511b3ec 100644 --- a/src/utils/__tests__/generators.test.mjs +++ b/src/utils/__tests__/generators.test.mjs @@ -129,10 +129,14 @@ describe('createLazyGenerator', () => { afterEach(() => mock.restoreAll()); it('spreads metadata properties onto the returned object', () => { - const metadata = { name: 'ast', version: '1.0.0', dependsOn: undefined }; + const metadata = { + name: 'ast', + description: 'Parses Markdown', + dependsOn: undefined, + }; const gen = createLazyGenerator(metadata); assert.equal(gen.name, 'ast'); - assert.equal(gen.version, '1.0.0'); + assert.equal(gen.description, 'Parses Markdown'); }); it('exposes generate and processChunk functions that delegate to the lazily loaded module', async () => {