Skip to content

Commit 96a763d

Browse files
author
Michael Hladky
committed
refactor: rename
1 parent 33971a7 commit 96a763d

File tree

10 files changed

+10
-10
lines changed

10 files changed

+10
-10
lines changed
File renamed without changes.
File renamed without changes.
File renamed without changes.

tools/jsdoc-annotation-transformer/project.json renamed to tools/zod2md-jsdocs/project.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
{
2-
"name": "jsdoc-annotation-transformer",
2+
"name": "zod2md-jsdocs",
33
"$schema": "../../node_modules/nx/schemas/project-schema.json",
4-
"sourceRoot": "tools/jsdoc-annotation-transformer/src",
4+
"sourceRoot": "tools/zod2md-jsdocs/src",
55
"projectType": "library",
66
"targets": {
77
"build": {
88
"executor": "@nx/js:tsc",
99
"outputs": ["{options.outputPath}"],
1010
"dependsOn": ["pre-build"],
1111
"options": {
12-
"outputPath": "tools/jsdoc-annotation-transformer/dist",
13-
"main": "tools/jsdoc-annotation-transformer/src/index.ts",
14-
"tsConfig": "tools/jsdoc-annotation-transformer/tsconfig.lib.json"
12+
"outputPath": "tools/zod2md-jsdocs/dist",
13+
"main": "tools/zod2md-jsdocs/src/index.ts",
14+
"tsConfig": "tools/zod2md-jsdocs/tsconfig.lib.json"
1515
}
1616
},
1717
"pre-build": {
File renamed without changes.

tools/jsdoc-annotation-transformer/src/lib/transformers.ts renamed to tools/zod2md-jsdocs/src/lib/transformers.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ function generateJSDocComment(typeName: string, baseUrl: string): string {
77
const markdownLink = `${baseUrl}#${typeName.toLowerCase()}`;
88
return `*
99
* Type Definition: \`${typeName}\`
10-
*
11-
* This type is derived from a Zod schema and represents
10+
*
11+
* This type is derived from a Zod schema and represents
1212
* the validated structure of \`${typeName}\` used within the application.
13-
*
13+
*
1414
* @see {@link ${markdownLink}}
1515
`;
1616
}
@@ -24,7 +24,7 @@ function annotateTypeDefinitions(
2424

2525
if (!baseUrl) {
2626
throw new Error(
27-
'jsdoc-annotation-transformer: "baseUrl" option is required. ' +
27+
'zod2md-jsdocs: "baseUrl" option is required. ' +
2828
'Please configure it in your tsconfig.json plugins section.',
2929
);
3030
}
File renamed without changes.
File renamed without changes.
File renamed without changes.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
import { createUnitTestConfig } from '../../testing/test-setup-config/src/index.js';
22

3-
export default createUnitTestConfig('jsdoc-annotation-transformer');
3+
export default createUnitTestConfig('zod2md-jsdocs');

0 commit comments

Comments
 (0)