@nzyme/cli 0.14.0 → 0.15.1

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.
Files changed (137) hide show
  1. package/bin/cli.js +3 -0
  2. package/dist/Command.d.ts +48 -5
  3. package/dist/Command.js +69 -6
  4. package/dist/Command.js.map +1 -1
  5. package/dist/Command.test.d.ts +1 -0
  6. package/dist/Command.test.js +77 -0
  7. package/dist/Command.test.js.map +1 -0
  8. package/dist/cli.d.ts +1 -1
  9. package/dist/cli.js +23 -3
  10. package/dist/cli.js.map +1 -1
  11. package/dist/codeIndex/IndexSettings.d.ts +60 -0
  12. package/dist/codeIndex/IndexSettings.js +59 -0
  13. package/dist/codeIndex/IndexSettings.js.map +1 -0
  14. package/dist/codeIndex/IndexSymbol.d.ts +32 -0
  15. package/dist/codeIndex/IndexSymbol.js +2 -0
  16. package/dist/codeIndex/IndexSymbol.js.map +1 -0
  17. package/dist/codeIndex/NzymeIndexConfig.d.ts +72 -0
  18. package/dist/codeIndex/NzymeIndexConfig.js +101 -0
  19. package/dist/codeIndex/NzymeIndexConfig.js.map +1 -0
  20. package/dist/codeIndex/NzymeIndexConfig.test.d.ts +1 -0
  21. package/dist/codeIndex/NzymeIndexConfig.test.js +56 -0
  22. package/dist/codeIndex/NzymeIndexConfig.test.js.map +1 -0
  23. package/dist/codeIndex/collectIndexSourceFiles.d.ts +8 -0
  24. package/dist/codeIndex/collectIndexSourceFiles.js +57 -0
  25. package/dist/codeIndex/collectIndexSourceFiles.js.map +1 -0
  26. package/dist/codeIndex/collectSymbols.d.ts +27 -0
  27. package/dist/codeIndex/collectSymbols.js +151 -0
  28. package/dist/codeIndex/collectSymbols.js.map +1 -0
  29. package/dist/codeIndex/collectSymbols.test.d.ts +1 -0
  30. package/dist/codeIndex/collectSymbols.test.js +204 -0
  31. package/dist/codeIndex/collectSymbols.test.js.map +1 -0
  32. package/dist/codeIndex/extractComponent.d.ts +25 -0
  33. package/dist/codeIndex/extractComponent.js +38 -0
  34. package/dist/codeIndex/extractComponent.js.map +1 -0
  35. package/dist/codeIndex/extractComponent.test.d.ts +1 -0
  36. package/dist/codeIndex/extractComponent.test.js +65 -0
  37. package/dist/codeIndex/extractComponent.test.js.map +1 -0
  38. package/dist/codeIndex/extractDefineSymbol.d.ts +30 -0
  39. package/dist/codeIndex/extractDefineSymbol.js +86 -0
  40. package/dist/codeIndex/extractDefineSymbol.js.map +1 -0
  41. package/dist/codeIndex/extractDefineSymbol.test.d.ts +1 -0
  42. package/dist/codeIndex/extractDefineSymbol.test.js +142 -0
  43. package/dist/codeIndex/extractDefineSymbol.test.js.map +1 -0
  44. package/dist/codeIndex/extractEntity.d.ts +29 -0
  45. package/dist/codeIndex/extractEntity.js +63 -0
  46. package/dist/codeIndex/extractEntity.js.map +1 -0
  47. package/dist/codeIndex/extractEntity.test.d.ts +1 -0
  48. package/dist/codeIndex/extractEntity.test.js +79 -0
  49. package/dist/codeIndex/extractEntity.test.js.map +1 -0
  50. package/dist/codeIndex/extractUtil.d.ts +27 -0
  51. package/dist/codeIndex/extractUtil.js +98 -0
  52. package/dist/codeIndex/extractUtil.js.map +1 -0
  53. package/dist/codeIndex/extractUtil.test.d.ts +1 -0
  54. package/dist/codeIndex/extractUtil.test.js +111 -0
  55. package/dist/codeIndex/extractUtil.test.js.map +1 -0
  56. package/dist/codeIndex/importPathOf.d.ts +18 -0
  57. package/dist/codeIndex/importPathOf.js +17 -0
  58. package/dist/codeIndex/importPathOf.js.map +1 -0
  59. package/dist/codeIndex/importPathOf.test.d.ts +1 -0
  60. package/dist/codeIndex/importPathOf.test.js +40 -0
  61. package/dist/codeIndex/importPathOf.test.js.map +1 -0
  62. package/dist/codeIndex/jsdocSummary.d.ts +9 -0
  63. package/dist/codeIndex/jsdocSummary.js +18 -0
  64. package/dist/codeIndex/jsdocSummary.js.map +1 -0
  65. package/dist/codeIndex/jsdocSummary.test.d.ts +1 -0
  66. package/dist/codeIndex/jsdocSummary.test.js +33 -0
  67. package/dist/codeIndex/jsdocSummary.test.js.map +1 -0
  68. package/dist/codeIndex/renderMarkdown.d.ts +27 -0
  69. package/dist/codeIndex/renderMarkdown.js +171 -0
  70. package/dist/codeIndex/renderMarkdown.js.map +1 -0
  71. package/dist/codeIndex/renderMarkdown.test.d.ts +1 -0
  72. package/dist/codeIndex/renderMarkdown.test.js +291 -0
  73. package/dist/codeIndex/renderMarkdown.test.js.map +1 -0
  74. package/dist/commands/DepcheckCommand.d.ts +17 -0
  75. package/dist/commands/DepcheckCommand.js +229 -42
  76. package/dist/commands/DepcheckCommand.js.map +1 -1
  77. package/dist/commands/FormatMarkdownCommand.d.ts +22 -0
  78. package/dist/commands/FormatMarkdownCommand.js +256 -0
  79. package/dist/commands/FormatMarkdownCommand.js.map +1 -0
  80. package/dist/commands/FormatMarkdownCommand.test.d.ts +1 -0
  81. package/dist/commands/FormatMarkdownCommand.test.js +82 -0
  82. package/dist/commands/FormatMarkdownCommand.test.js.map +1 -0
  83. package/dist/commands/IndexCommand.d.ts +20 -0
  84. package/dist/commands/IndexCommand.js +81 -0
  85. package/dist/commands/IndexCommand.js.map +1 -0
  86. package/dist/commands/IndexCommand.test.d.ts +1 -0
  87. package/dist/commands/IndexCommand.test.js +126 -0
  88. package/dist/commands/IndexCommand.test.js.map +1 -0
  89. package/dist/commands/LocaliseCommand.d.ts +23 -0
  90. package/dist/commands/LocaliseCommand.js +125 -0
  91. package/dist/commands/LocaliseCommand.js.map +1 -0
  92. package/dist/commands/MonorepoCommand.d.ts +14 -0
  93. package/dist/commands/MonorepoCommand.js +243 -144
  94. package/dist/commands/MonorepoCommand.js.map +1 -1
  95. package/dist/commands/QuietRunCommand.d.ts +27 -0
  96. package/dist/commands/QuietRunCommand.js +140 -0
  97. package/dist/commands/QuietRunCommand.js.map +1 -0
  98. package/dist/commands/QuietRunCommand.test.d.ts +1 -0
  99. package/dist/commands/QuietRunCommand.test.js +48 -0
  100. package/dist/commands/QuietRunCommand.test.js.map +1 -0
  101. package/dist/commands/SubmoduleBumpCommand.d.ts +27 -0
  102. package/dist/commands/SubmoduleBumpCommand.js +77 -0
  103. package/dist/commands/SubmoduleBumpCommand.js.map +1 -0
  104. package/dist/execute.d.ts +7 -2
  105. package/dist/execute.js +4 -2
  106. package/dist/execute.js.map +1 -1
  107. package/dist/index.d.ts +1 -1
  108. package/dist/index.js +1 -1
  109. package/dist/index.js.map +1 -1
  110. package/dist/initialize.d.ts +1 -15
  111. package/dist/initialize.js +4 -8
  112. package/dist/initialize.js.map +1 -1
  113. package/dist/quietRun/quietRunReport.d.ts +70 -0
  114. package/dist/quietRun/quietRunReport.js +128 -0
  115. package/dist/quietRun/quietRunReport.js.map +1 -0
  116. package/dist/quietRun/quietRunReport.test.d.ts +1 -0
  117. package/dist/quietRun/quietRunReport.test.js +87 -0
  118. package/dist/quietRun/quietRunReport.test.js.map +1 -0
  119. package/dist/submodule/GitRepository.d.ts +70 -0
  120. package/dist/submodule/GitRepository.js +129 -0
  121. package/dist/submodule/GitRepository.js.map +1 -0
  122. package/dist/submodule/bumpSubmodule.d.ts +45 -0
  123. package/dist/submodule/bumpSubmodule.js +52 -0
  124. package/dist/submodule/bumpSubmodule.js.map +1 -0
  125. package/dist/submodule/renderBumpSummary.d.ts +12 -0
  126. package/dist/submodule/renderBumpSummary.js +50 -0
  127. package/dist/submodule/renderBumpSummary.js.map +1 -0
  128. package/dist/submodule/renderBumpSummary.test.d.ts +1 -0
  129. package/dist/submodule/renderBumpSummary.test.js +55 -0
  130. package/dist/submodule/renderBumpSummary.test.js.map +1 -0
  131. package/dist/submodule/submodule.test.d.ts +1 -0
  132. package/dist/submodule/submodule.test.js +155 -0
  133. package/dist/submodule/submodule.test.js.map +1 -0
  134. package/package.json +55 -50
  135. package/dist/commands/BuildCommand.d.ts +0 -15
  136. package/dist/commands/BuildCommand.js +0 -49
  137. package/dist/commands/BuildCommand.js.map +0 -1
@@ -0,0 +1,65 @@
1
+ import { describe, expect, it } from 'bun:test';
2
+ import { extractComponent } from './extractComponent.js';
3
+ function extract(fileName, content) {
4
+ return extractComponent({
5
+ packageName: '@acme/ui',
6
+ relPath: `packages/ui/src/${fileName}`,
7
+ importPath: `@acme/ui/${fileName}`,
8
+ fileName,
9
+ content,
10
+ });
11
+ }
12
+ describe('extractComponent', () => {
13
+ it('extracts a component with a leading HTML comment as description', () => {
14
+ const symbols = extract('ExternalLink.vue', [
15
+ '<!--',
16
+ ' This component is used to navigate to external links.',
17
+ ' Allows to preserve scroll position when navigating back.',
18
+ ' -->',
19
+ '<script lang="ts" setup></script>',
20
+ '<template><a /></template>',
21
+ ].join('\n'));
22
+ expect(symbols).toEqual([
23
+ {
24
+ kind: 'component',
25
+ packageName: '@acme/ui',
26
+ exportName: 'ExternalLink',
27
+ importPath: '@acme/ui/ExternalLink.vue',
28
+ internalName: null,
29
+ description: 'This component is used to navigate to external links. Allows to preserve scroll position when navigating back.',
30
+ signature: null,
31
+ relPath: 'packages/ui/src/ExternalLink.vue',
32
+ },
33
+ ]);
34
+ });
35
+ it('extracts a component with null description when it starts directly with a script block', () => {
36
+ const symbols = extract('InfoBox.vue', ['<script lang="ts" setup>', 'defineProps<Props>();', '</script>', '<template><div /></template>'].join('\n'));
37
+ expect(symbols).toEqual([
38
+ {
39
+ kind: 'component',
40
+ packageName: '@acme/ui',
41
+ exportName: 'InfoBox',
42
+ importPath: '@acme/ui/InfoBox.vue',
43
+ internalName: null,
44
+ description: null,
45
+ signature: null,
46
+ relPath: 'packages/ui/src/InfoBox.vue',
47
+ },
48
+ ]);
49
+ });
50
+ it('ignores an HTML comment that appears inside the template (not at the top)', () => {
51
+ const symbols = extract('Widget.vue', [
52
+ '<script setup></script>',
53
+ '<template>',
54
+ ' <!-- a comment inside the template -->',
55
+ ' <div />',
56
+ '</template>',
57
+ ].join('\n'));
58
+ expect(symbols).toMatchObject([{ exportName: 'Widget', description: null }]);
59
+ });
60
+ it('derives the export name from the file name without extension', () => {
61
+ const symbols = extract('SearchDropdown.vue', '<template></template>');
62
+ expect(symbols[0]?.exportName).toBe('SearchDropdown');
63
+ });
64
+ });
65
+ //# sourceMappingURL=extractComponent.test.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"extractComponent.test.js","sourceRoot":"","sources":["../../src/codeIndex/extractComponent.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,UAAU,CAAC;AAEhD,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAGzD,SAAS,OAAO,CAAC,QAAgB,EAAE,OAAe;IAC9C,OAAO,gBAAgB,CAAC;QACpB,WAAW,EAAE,UAAU;QACvB,OAAO,EAAE,mBAAmB,QAAQ,EAAE;QACtC,UAAU,EAAE,YAAY,QAAQ,EAAE;QAClC,QAAQ;QACR,OAAO;KACV,CAAC,CAAC;AACP,CAAC;AAED,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAC9B,EAAE,CAAC,iEAAiE,EAAE,GAAG,EAAE;QACvE,MAAM,OAAO,GAAG,OAAO,CACnB,kBAAkB,EAClB;YACI,MAAM;YACN,2DAA2D;YAC3D,8DAA8D;YAC9D,MAAM;YACN,mCAAmC;YACnC,4BAA4B;SAC/B,CAAC,IAAI,CAAC,IAAI,CAAC,CACf,CAAC;QAEF,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC;YACpB;gBACI,IAAI,EAAE,WAAW;gBACjB,WAAW,EAAE,UAAU;gBACvB,UAAU,EAAE,cAAc;gBAC1B,UAAU,EAAE,2BAA2B;gBACvC,YAAY,EAAE,IAAI;gBAClB,WAAW,EACP,gHAAgH;gBACpH,SAAS,EAAE,IAAI;gBACf,OAAO,EAAE,kCAAkC;aAC9C;SACJ,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wFAAwF,EAAE,GAAG,EAAE;QAC9F,MAAM,OAAO,GAAG,OAAO,CACnB,aAAa,EACb,CAAC,0BAA0B,EAAE,uBAAuB,EAAE,WAAW,EAAE,8BAA8B,CAAC,CAAC,IAAI,CACnG,IAAI,CACP,CACJ,CAAC;QAEF,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC;YACpB;gBACI,IAAI,EAAE,WAAW;gBACjB,WAAW,EAAE,UAAU;gBACvB,UAAU,EAAE,SAAS;gBACrB,UAAU,EAAE,sBAAsB;gBAClC,YAAY,EAAE,IAAI;gBAClB,WAAW,EAAE,IAAI;gBACjB,SAAS,EAAE,IAAI;gBACf,OAAO,EAAE,6BAA6B;aACzC;SACJ,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2EAA2E,EAAE,GAAG,EAAE;QACjF,MAAM,OAAO,GAAG,OAAO,CACnB,YAAY,EACZ;YACI,yBAAyB;YACzB,YAAY;YACZ,0CAA0C;YAC1C,WAAW;YACX,aAAa;SAChB,CAAC,IAAI,CAAC,IAAI,CAAC,CACf,CAAC;QAEF,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC,CAAC,EAAE,UAAU,EAAE,QAAQ,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IACjF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8DAA8D,EAAE,GAAG,EAAE;QACpE,MAAM,OAAO,GAAG,OAAO,CAAC,oBAAoB,EAAE,uBAAuB,CAAC,CAAC;QAEvE,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IAC1D,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}
@@ -0,0 +1,30 @@
1
+ import * as ts from 'typescript';
2
+ import type { DefineSymbolKind } from './IndexSettings.js';
3
+ import type { IndexSymbol } from './IndexSymbol.js';
4
+ /** Inputs for {@link extractDefineSymbol}. */
5
+ export interface ExtractDefineSymbolOptions {
6
+ /** Parsed source file to scan (top-level statements only). */
7
+ sourceFile: ts.SourceFile;
8
+ /** Owning workspace package name, e.g. '@acme/payments'. */
9
+ packageName: string;
10
+ /** Repo-relative declaring file path, for {@link IndexSymbol.relPath}. */
11
+ relPath: string;
12
+ /** Deep import specifier for this file, from `importPathOf`. */
13
+ importPath: string;
14
+ /** Callee identifier text → the `defineX` kind it marks (built in `collectSymbols`). */
15
+ kindsByCallee: ReadonlyMap<string, DefineSymbolKind>;
16
+ }
17
+ /**
18
+ * Extracts every `export const <Ident> = <defineX>({ ... })` DSL symbol from a source file's
19
+ * top-level statements, where `<defineX>` is one of the known callees in `kindsByCallee`
20
+ * (`defineService`/`defineCommand`/`defineFactory`/`defineEndpoint`, plus any configured ones). The
21
+ * internal name is read from the first-argument object literal under the kind's `nameKey` (`name:`
22
+ * unless configured otherwise); the description is the JSDoc summary above the `export const`.
23
+ *
24
+ * Syntax-only — it never type-checks and never throws on unexpected AST: statements that don't
25
+ * match the exact shape (non-exported, non-Identifier callee like `defineEndpoint.output<T>()`
26
+ * or `z.object(...)`, non-object argument, truncated calls) are simply skipped. A file may yield
27
+ * several symbols; all matches are returned.
28
+ * @__NO_SIDE_EFFECTS__
29
+ */
30
+ export declare function extractDefineSymbol(options: ExtractDefineSymbolOptions): IndexSymbol[];
@@ -0,0 +1,86 @@
1
+ import * as ts from 'typescript';
2
+ import { jsdocSummary } from './jsdocSummary.js';
3
+ /**
4
+ * Extracts every `export const <Ident> = <defineX>({ ... })` DSL symbol from a source file's
5
+ * top-level statements, where `<defineX>` is one of the known callees in `kindsByCallee`
6
+ * (`defineService`/`defineCommand`/`defineFactory`/`defineEndpoint`, plus any configured ones). The
7
+ * internal name is read from the first-argument object literal under the kind's `nameKey` (`name:`
8
+ * unless configured otherwise); the description is the JSDoc summary above the `export const`.
9
+ *
10
+ * Syntax-only — it never type-checks and never throws on unexpected AST: statements that don't
11
+ * match the exact shape (non-exported, non-Identifier callee like `defineEndpoint.output<T>()`
12
+ * or `z.object(...)`, non-object argument, truncated calls) are simply skipped. A file may yield
13
+ * several symbols; all matches are returned.
14
+ * @__NO_SIDE_EFFECTS__
15
+ */
16
+ export function extractDefineSymbol(options) {
17
+ const { sourceFile, packageName, relPath, importPath, kindsByCallee } = options;
18
+ const symbols = [];
19
+ for (const statement of sourceFile.statements) {
20
+ const symbol = matchStatement(statement);
21
+ if (symbol) {
22
+ symbols.push(symbol);
23
+ }
24
+ }
25
+ return symbols;
26
+ function matchStatement(statement) {
27
+ if (!ts.isVariableStatement(statement) || !hasExportModifier(statement)) {
28
+ return null;
29
+ }
30
+ // `export const X = ...` — a single declaration with an initializer.
31
+ const declaration = statement.declarationList.declarations[0];
32
+ if (!declaration || !ts.isIdentifier(declaration.name) || !declaration.initializer) {
33
+ return null;
34
+ }
35
+ const call = declaration.initializer;
36
+ if (!ts.isCallExpression(call) || !ts.isIdentifier(call.expression)) {
37
+ return null;
38
+ }
39
+ const kind = kindsByCallee.get(call.expression.text);
40
+ if (!kind) {
41
+ return null;
42
+ }
43
+ return {
44
+ kind: kind.kind,
45
+ packageName,
46
+ exportName: declaration.name.text,
47
+ importPath,
48
+ internalName: readNameLiteral(call.arguments[0], kind.nameKey),
49
+ description: jsdocSummary(statement),
50
+ signature: null,
51
+ relPath,
52
+ };
53
+ }
54
+ }
55
+ /** True when a statement carries the `export` modifier. */
56
+ function hasExportModifier(statement) {
57
+ return statement.modifiers?.some(modifier => modifier.kind === ts.SyntaxKind.ExportKeyword) ?? false;
58
+ }
59
+ /**
60
+ * Reads the string-literal value of property `nameKey` from a call's first argument object
61
+ * literal (e.g. `name: 'PaymentClient'`). Returns null if the argument isn't an object literal,
62
+ * the property is absent, or its value isn't a plain string literal.
63
+ */
64
+ function readNameLiteral(argument, nameKey) {
65
+ if (!argument || !ts.isObjectLiteralExpression(argument)) {
66
+ return null;
67
+ }
68
+ for (const property of argument.properties) {
69
+ if (!ts.isPropertyAssignment(property) || !propertyNameMatches(property.name, nameKey)) {
70
+ continue;
71
+ }
72
+ if (ts.isStringLiteral(property.initializer)) {
73
+ return property.initializer.text;
74
+ }
75
+ return null;
76
+ }
77
+ return null;
78
+ }
79
+ /** Matches an object-literal property key against a plain name, for identifier or string keys. */
80
+ function propertyNameMatches(name, key) {
81
+ if (ts.isIdentifier(name) || ts.isStringLiteral(name)) {
82
+ return name.text === key;
83
+ }
84
+ return false;
85
+ }
86
+ //# sourceMappingURL=extractDefineSymbol.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"extractDefineSymbol.js","sourceRoot":"","sources":["../../src/codeIndex/extractDefineSymbol.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,YAAY,CAAC;AAIjC,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAgBjD;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,mBAAmB,CAAC,OAAmC;IACnE,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC;IAEhF,MAAM,OAAO,GAAkB,EAAE,CAAC;IAClC,KAAK,MAAM,SAAS,IAAI,UAAU,CAAC,UAAU,EAAE,CAAC;QAC5C,MAAM,MAAM,GAAG,cAAc,CAAC,SAAS,CAAC,CAAC;QACzC,IAAI,MAAM,EAAE,CAAC;YACT,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACzB,CAAC;IACL,CAAC;IAED,OAAO,OAAO,CAAC;IAEf,SAAS,cAAc,CAAC,SAAuB;QAC3C,IAAI,CAAC,EAAE,CAAC,mBAAmB,CAAC,SAAS,CAAC,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,EAAE,CAAC;YACtE,OAAO,IAAI,CAAC;QAChB,CAAC;QAED,qEAAqE;QACrE,MAAM,WAAW,GAAG,SAAS,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC9D,IAAI,CAAC,WAAW,IAAI,CAAC,EAAE,CAAC,YAAY,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE,CAAC;YACjF,OAAO,IAAI,CAAC;QAChB,CAAC;QAED,MAAM,IAAI,GAAG,WAAW,CAAC,WAAW,CAAC;QACrC,IAAI,CAAC,EAAE,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;YAClE,OAAO,IAAI,CAAC;QAChB,CAAC;QAED,MAAM,IAAI,GAAG,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QACrD,IAAI,CAAC,IAAI,EAAE,CAAC;YACR,OAAO,IAAI,CAAC;QAChB,CAAC;QAED,OAAO;YACH,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,WAAW;YACX,UAAU,EAAE,WAAW,CAAC,IAAI,CAAC,IAAI;YACjC,UAAU;YACV,YAAY,EAAE,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC;YAC9D,WAAW,EAAE,YAAY,CAAC,SAAS,CAAC;YACpC,SAAS,EAAE,IAAI;YACf,OAAO;SACV,CAAC;IACN,CAAC;AACL,CAAC;AAED,2DAA2D;AAC3D,SAAS,iBAAiB,CAAC,SAA+B;IACtD,OAAO,SAAS,CAAC,SAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC,IAAI,KAAK,CAAC;AACzG,CAAC;AAED;;;;GAIG;AACH,SAAS,eAAe,CAAC,QAAmC,EAAE,OAAe;IACzE,IAAI,CAAC,QAAQ,IAAI,CAAC,EAAE,CAAC,yBAAyB,CAAC,QAAQ,CAAC,EAAE,CAAC;QACvD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,KAAK,MAAM,QAAQ,IAAI,QAAQ,CAAC,UAAU,EAAE,CAAC;QACzC,IAAI,CAAC,EAAE,CAAC,oBAAoB,CAAC,QAAQ,CAAC,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,CAAC;YACrF,SAAS;QACb,CAAC;QACD,IAAI,EAAE,CAAC,eAAe,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;YAC3C,OAAO,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC;QACrC,CAAC;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,kGAAkG;AAClG,SAAS,mBAAmB,CAAC,IAAqB,EAAE,GAAW;IAC3D,IAAI,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC;QACpD,OAAO,IAAI,CAAC,IAAI,KAAK,GAAG,CAAC;IAC7B,CAAC;IACD,OAAO,KAAK,CAAC;AACjB,CAAC"}
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,142 @@
1
+ import { describe, expect, it } from 'bun:test';
2
+ import * as ts from 'typescript';
3
+ import { extractDefineSymbol } from './extractDefineSymbol.js';
4
+ import { getIndexSettings } from './IndexSettings.js';
5
+ /** The built-in kinds plus a configured `defineActor` kind whose internal name lives under `type:`. */
6
+ const settings = getIndexSettings({
7
+ defineKinds: [{ kind: 'actor', section: 'Actors', callee: 'defineActor', nameKey: 'type', order: 40 }],
8
+ });
9
+ const kindsByCallee = new Map(settings.defineKinds.map(kind => [kind.callee, kind]));
10
+ function extract(source) {
11
+ const sourceFile = ts.createSourceFile('x.ts', source, ts.ScriptTarget.Latest, true);
12
+ return extractDefineSymbol({
13
+ sourceFile,
14
+ packageName: '@acme/test',
15
+ relPath: 'packages/test/src/x.ts',
16
+ importPath: '@acme/test/x.js',
17
+ kindsByCallee,
18
+ });
19
+ }
20
+ describe('extractDefineSymbol', () => {
21
+ it('extracts a service with name and description', () => {
22
+ const symbols = extract(`
23
+ /** The payment client. */
24
+ export const PaymentClient = defineService({ name: 'PaymentClient', deps: {} });
25
+ `);
26
+ expect(symbols).toEqual([
27
+ {
28
+ kind: 'service',
29
+ packageName: '@acme/test',
30
+ exportName: 'PaymentClient',
31
+ importPath: '@acme/test/x.js',
32
+ internalName: 'PaymentClient',
33
+ description: 'The payment client.',
34
+ signature: null,
35
+ relPath: 'packages/test/src/x.ts',
36
+ },
37
+ ]);
38
+ });
39
+ it('extracts a command from its name key', () => {
40
+ const symbols = extract(`export const ChatStartCommand = defineCommand({ name: 'ChatStart', deps: {} });`);
41
+ expect(symbols).toMatchObject([{ kind: 'command', exportName: 'ChatStartCommand', internalName: 'ChatStart' }]);
42
+ });
43
+ it('extracts a factory from its name key', () => {
44
+ const symbols = extract(`export const WidgetFactory = defineFactory({ name: 'Widget', setup() {} });`);
45
+ expect(symbols).toMatchObject([{ kind: 'factory', exportName: 'WidgetFactory', internalName: 'Widget' }]);
46
+ });
47
+ it('extracts an endpoint from its name key', () => {
48
+ const symbols = extract(`
49
+ /** Support chat list. */
50
+ export const ChatListEndpoint = defineEndpoint({ name: 'SupportChatList', input, output });
51
+ `);
52
+ expect(symbols).toMatchObject([
53
+ {
54
+ kind: 'endpoint',
55
+ exportName: 'ChatListEndpoint',
56
+ internalName: 'SupportChatList',
57
+ description: 'Support chat list.',
58
+ },
59
+ ]);
60
+ });
61
+ it('extracts a configured kind from its configured name key (not name)', () => {
62
+ const symbols = extract(`export const ChatActor = defineActor({ type: 'chat', parseId: BigInt, users: [], requests: {} });`);
63
+ expect(symbols).toMatchObject([{ kind: 'actor', exportName: 'ChatActor', internalName: 'chat' }]);
64
+ });
65
+ it('ignores a callee that is not configured', () => {
66
+ const symbols = extractDefineSymbol({
67
+ sourceFile: ts.createSourceFile('x.ts', `export const ChatActor = defineActor({ type: 'chat' });`, ts.ScriptTarget.Latest, true),
68
+ packageName: '@acme/test',
69
+ relPath: 'packages/test/src/x.ts',
70
+ importPath: '@acme/test/x.js',
71
+ kindsByCallee: new Map(getIndexSettings({}).defineKinds.map(kind => [kind.callee, kind])),
72
+ });
73
+ expect(symbols).toEqual([]);
74
+ });
75
+ it('emits only the endpoint when a sibling Options z.object export is present', () => {
76
+ const symbols = extract(`
77
+ export const ChatListEndpointOptions = z.object({ chatId: Id });
78
+ export interface ChatListEndpointResult extends BaseResult {}
79
+ /** Support chat list. */
80
+ export const ChatListEndpoint = defineEndpoint({
81
+ name: 'SupportChatList',
82
+ input: ChatListEndpointOptions,
83
+ output,
84
+ });
85
+ `);
86
+ expect(symbols).toMatchObject([
87
+ { kind: 'endpoint', exportName: 'ChatListEndpoint', internalName: 'SupportChatList' },
88
+ ]);
89
+ expect(symbols).toHaveLength(1);
90
+ });
91
+ it('emits an endpoint without options and still reads its name', () => {
92
+ const symbols = extract(`export const PingEndpoint = defineEndpoint({ name: 'Ping', output });`);
93
+ expect(symbols).toMatchObject([{ kind: 'endpoint', exportName: 'PingEndpoint', internalName: 'Ping' }]);
94
+ });
95
+ it('returns null description when a defineService has no JSDoc', () => {
96
+ const symbols = extract(`export const BareService = defineService({ name: 'Bare', deps: {} });`);
97
+ expect(symbols[0]?.description).toBeNull();
98
+ });
99
+ it('extracts multiple symbols from one file', () => {
100
+ const symbols = extract(`
101
+ export const FirstService = defineService({ name: 'First' });
102
+ export const SecondCommand = defineCommand({ name: 'Second' });
103
+ `);
104
+ expect(symbols).toMatchObject([
105
+ { kind: 'service', exportName: 'FirstService', internalName: 'First' },
106
+ { kind: 'command', exportName: 'SecondCommand', internalName: 'Second' },
107
+ ]);
108
+ });
109
+ it('returns [] for a source with no known callee', () => {
110
+ const symbols = extract(`
111
+ export const ChatListEndpointOptions = z.object({ chatId: Id });
112
+ export const helper = defineSomethingElse({ name: 'nope' });
113
+ export function doThing() {}
114
+ `);
115
+ expect(symbols).toEqual([]);
116
+ });
117
+ it('does not match defineEndpoint.output<T>() property-access callee', () => {
118
+ const symbols = extract(`export const output = defineEndpoint.output<Result>();`);
119
+ expect(symbols).toEqual([]);
120
+ });
121
+ it('does not match a non-exported const', () => {
122
+ const symbols = extract(`const InternalService = defineService({ name: 'Internal' });`);
123
+ expect(symbols).toEqual([]);
124
+ });
125
+ it('returns null internalName when the name value is not a string literal', () => {
126
+ const symbols = extract(`export const DynService = defineService({ name: SOME_CONST, deps: {} });`);
127
+ expect(symbols).toMatchObject([{ kind: 'service', exportName: 'DynService', internalName: null }]);
128
+ });
129
+ it('returns null internalName when the name key is absent', () => {
130
+ const symbols = extract(`export const NoNameService = defineService({ deps: {} });`);
131
+ expect(symbols).toMatchObject([{ kind: 'service', exportName: 'NoNameService', internalName: null }]);
132
+ });
133
+ it('does not throw and returns [] on a non-object argument', () => {
134
+ const symbols = extract(`export const X = defineService(someVar);`);
135
+ expect(symbols).toMatchObject([{ kind: 'service', exportName: 'X', internalName: null }]);
136
+ });
137
+ it('does not throw on truncated/malformed source', () => {
138
+ expect(() => extract(`export const X = defineService(`)).not.toThrow();
139
+ expect(() => extract(`export const Y = defineService({ name: `)).not.toThrow();
140
+ });
141
+ });
142
+ //# sourceMappingURL=extractDefineSymbol.test.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"extractDefineSymbol.test.js","sourceRoot":"","sources":["../../src/codeIndex/extractDefineSymbol.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,UAAU,CAAC;AAChD,OAAO,KAAK,EAAE,MAAM,YAAY,CAAC;AAEjC,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAGtD,uGAAuG;AACvG,MAAM,QAAQ,GAAG,gBAAgB,CAAC;IAC9B,WAAW,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC;CACzG,CAAC,CAAC;AACH,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;AAErF,SAAS,OAAO,CAAC,MAAc;IAC3B,MAAM,UAAU,GAAG,EAAE,CAAC,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC,YAAY,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACrF,OAAO,mBAAmB,CAAC;QACvB,UAAU;QACV,WAAW,EAAE,YAAY;QACzB,OAAO,EAAE,wBAAwB;QACjC,UAAU,EAAE,iBAAiB;QAC7B,aAAa;KAChB,CAAC,CAAC;AACP,CAAC;AAED,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;IACjC,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACpD,MAAM,OAAO,GAAG,OAAO,CAAC;;;SAGvB,CAAC,CAAC;QAEH,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC;YACpB;gBACI,IAAI,EAAE,SAAS;gBACf,WAAW,EAAE,YAAY;gBACzB,UAAU,EAAE,eAAe;gBAC3B,UAAU,EAAE,iBAAiB;gBAC7B,YAAY,EAAE,eAAe;gBAC7B,WAAW,EAAE,qBAAqB;gBAClC,SAAS,EAAE,IAAI;gBACf,OAAO,EAAE,wBAAwB;aACpC;SACJ,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;QAC5C,MAAM,OAAO,GAAG,OAAO,CAAC,iFAAiF,CAAC,CAAC;QAE3G,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,UAAU,EAAE,kBAAkB,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC;IACpH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;QAC5C,MAAM,OAAO,GAAG,OAAO,CAAC,6EAA6E,CAAC,CAAC;QAEvG,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,UAAU,EAAE,eAAe,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC;IAC9G,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;QAC9C,MAAM,OAAO,GAAG,OAAO,CAAC;;;SAGvB,CAAC,CAAC;QAEH,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC;YAC1B;gBACI,IAAI,EAAE,UAAU;gBAChB,UAAU,EAAE,kBAAkB;gBAC9B,YAAY,EAAE,iBAAiB;gBAC/B,WAAW,EAAE,oBAAoB;aACpC;SACJ,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oEAAoE,EAAE,GAAG,EAAE;QAC1E,MAAM,OAAO,GAAG,OAAO,CACnB,mGAAmG,CACtG,CAAC;QAEF,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;IACtG,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;QAC/C,MAAM,OAAO,GAAG,mBAAmB,CAAC;YAChC,UAAU,EAAE,EAAE,CAAC,gBAAgB,CAC3B,MAAM,EACN,yDAAyD,EACzD,EAAE,CAAC,YAAY,CAAC,MAAM,EACtB,IAAI,CACP;YACD,WAAW,EAAE,YAAY;YACzB,OAAO,EAAE,wBAAwB;YACjC,UAAU,EAAE,iBAAiB;YAC7B,aAAa,EAAE,IAAI,GAAG,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;SAC5F,CAAC,CAAC;QAEH,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2EAA2E,EAAE,GAAG,EAAE;QACjF,MAAM,OAAO,GAAG,OAAO,CAAC;;;;;;;;;SASvB,CAAC,CAAC;QAEH,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC;YAC1B,EAAE,IAAI,EAAE,UAAU,EAAE,UAAU,EAAE,kBAAkB,EAAE,YAAY,EAAE,iBAAiB,EAAE;SACxF,CAAC,CAAC;QACH,MAAM,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4DAA4D,EAAE,GAAG,EAAE;QAClE,MAAM,OAAO,GAAG,OAAO,CAAC,uEAAuE,CAAC,CAAC;QAEjG,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,UAAU,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;IAC5G,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4DAA4D,EAAE,GAAG,EAAE;QAClE,MAAM,OAAO,GAAG,OAAO,CAAC,uEAAuE,CAAC,CAAC;QAEjG,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,QAAQ,EAAE,CAAC;IAC/C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;QAC/C,MAAM,OAAO,GAAG,OAAO,CAAC;;;SAGvB,CAAC,CAAC;QAEH,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC;YAC1B,EAAE,IAAI,EAAE,SAAS,EAAE,UAAU,EAAE,cAAc,EAAE,YAAY,EAAE,OAAO,EAAE;YACtE,EAAE,IAAI,EAAE,SAAS,EAAE,UAAU,EAAE,eAAe,EAAE,YAAY,EAAE,QAAQ,EAAE;SAC3E,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACpD,MAAM,OAAO,GAAG,OAAO,CAAC;;;;SAIvB,CAAC,CAAC;QAEH,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kEAAkE,EAAE,GAAG,EAAE;QACxE,MAAM,OAAO,GAAG,OAAO,CAAC,wDAAwD,CAAC,CAAC;QAElF,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qCAAqC,EAAE,GAAG,EAAE;QAC3C,MAAM,OAAO,GAAG,OAAO,CAAC,8DAA8D,CAAC,CAAC;QAExF,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uEAAuE,EAAE,GAAG,EAAE;QAC7E,MAAM,OAAO,GAAG,OAAO,CAAC,0EAA0E,CAAC,CAAC;QAEpG,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,UAAU,EAAE,YAAY,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IACvG,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uDAAuD,EAAE,GAAG,EAAE;QAC7D,MAAM,OAAO,GAAG,OAAO,CAAC,2DAA2D,CAAC,CAAC;QAErF,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,UAAU,EAAE,eAAe,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IAC1G,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wDAAwD,EAAE,GAAG,EAAE;QAC9D,MAAM,OAAO,GAAG,OAAO,CAAC,0CAA0C,CAAC,CAAC;QAEpE,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IAC9F,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACpD,MAAM,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,iCAAiC,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;QACvE,MAAM,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,yCAAyC,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;IACnF,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}
@@ -0,0 +1,29 @@
1
+ import * as ts from 'typescript';
2
+ import type { IndexSymbol } from './IndexSymbol.js';
3
+ /** Inputs for {@link extractEntity}. */
4
+ export interface ExtractEntityOptions {
5
+ /** Parsed source file to scan (top-level statements only). */
6
+ sourceFile: ts.SourceFile;
7
+ /** Owning workspace package name — one of the configured entity packages (the caller gates). */
8
+ packageName: string;
9
+ /** Repo-relative declaring file path, for {@link IndexSymbol.relPath}. */
10
+ relPath: string;
11
+ /** Deep import specifier for this file, from `importPathOf`. */
12
+ importPath: string;
13
+ /** Table-builder callees that define an entity, e.g. Drizzle's `pgTable`. */
14
+ tableFunctions: ReadonlySet<string>;
15
+ }
16
+ /**
17
+ * Extracts every table entity — e.g. Drizzle's `export const <Ident> = pgTable('<tableName>', { ... })`
18
+ * — from a source file's top-level statements, for each configured table-builder callee. The export
19
+ * name is the const identifier (e.g. `payment`); the internal name is the first-argument string
20
+ * literal (the physical table name). Only a bare identifier callee matches, so sibling
21
+ * `enumType(...)` / property-access (`schema.pgTable(...)`) calls are skipped. When the first
22
+ * argument is not a string literal the entity is still emitted with a null internal name, mirroring
23
+ * the `defineX` extractor.
24
+ *
25
+ * Gating to the configured entity packages is the caller's responsibility; this extractor only
26
+ * matches the call shape. Syntax-only — it never type-checks and never throws on unexpected AST.
27
+ * @__NO_SIDE_EFFECTS__
28
+ */
29
+ export declare function extractEntity(options: ExtractEntityOptions): IndexSymbol[];
@@ -0,0 +1,63 @@
1
+ import * as ts from 'typescript';
2
+ import { jsdocSummary } from './jsdocSummary.js';
3
+ /**
4
+ * Extracts every table entity — e.g. Drizzle's `export const <Ident> = pgTable('<tableName>', { ... })`
5
+ * — from a source file's top-level statements, for each configured table-builder callee. The export
6
+ * name is the const identifier (e.g. `payment`); the internal name is the first-argument string
7
+ * literal (the physical table name). Only a bare identifier callee matches, so sibling
8
+ * `enumType(...)` / property-access (`schema.pgTable(...)`) calls are skipped. When the first
9
+ * argument is not a string literal the entity is still emitted with a null internal name, mirroring
10
+ * the `defineX` extractor.
11
+ *
12
+ * Gating to the configured entity packages is the caller's responsibility; this extractor only
13
+ * matches the call shape. Syntax-only — it never type-checks and never throws on unexpected AST.
14
+ * @__NO_SIDE_EFFECTS__
15
+ */
16
+ export function extractEntity(options) {
17
+ const { sourceFile, packageName, relPath, importPath, tableFunctions } = options;
18
+ const symbols = [];
19
+ for (const statement of sourceFile.statements) {
20
+ const symbol = matchStatement(statement);
21
+ if (symbol) {
22
+ symbols.push(symbol);
23
+ }
24
+ }
25
+ return symbols;
26
+ function matchStatement(statement) {
27
+ if (!ts.isVariableStatement(statement) || !hasExportModifier(statement)) {
28
+ return null;
29
+ }
30
+ const declaration = statement.declarationList.declarations[0];
31
+ if (!declaration || !ts.isIdentifier(declaration.name) || !declaration.initializer) {
32
+ return null;
33
+ }
34
+ const call = declaration.initializer;
35
+ if (!ts.isCallExpression(call) ||
36
+ !ts.isIdentifier(call.expression) ||
37
+ !tableFunctions.has(call.expression.text)) {
38
+ return null;
39
+ }
40
+ return {
41
+ kind: 'entity',
42
+ packageName,
43
+ exportName: declaration.name.text,
44
+ importPath,
45
+ internalName: readStringLiteral(call.arguments[0]),
46
+ description: jsdocSummary(statement),
47
+ signature: null,
48
+ relPath,
49
+ };
50
+ }
51
+ }
52
+ /** True when a statement carries the `export` modifier. */
53
+ function hasExportModifier(statement) {
54
+ return statement.modifiers?.some(modifier => modifier.kind === ts.SyntaxKind.ExportKeyword) ?? false;
55
+ }
56
+ /** Returns the text of a plain string-literal argument, or null when absent or not a string. */
57
+ function readStringLiteral(argument) {
58
+ if (argument && ts.isStringLiteral(argument)) {
59
+ return argument.text;
60
+ }
61
+ return null;
62
+ }
63
+ //# sourceMappingURL=extractEntity.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"extractEntity.js","sourceRoot":"","sources":["../../src/codeIndex/extractEntity.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,YAAY,CAAC;AAGjC,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAgBjD;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,aAAa,CAAC,OAA6B;IACvD,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC;IAEjF,MAAM,OAAO,GAAkB,EAAE,CAAC;IAClC,KAAK,MAAM,SAAS,IAAI,UAAU,CAAC,UAAU,EAAE,CAAC;QAC5C,MAAM,MAAM,GAAG,cAAc,CAAC,SAAS,CAAC,CAAC;QACzC,IAAI,MAAM,EAAE,CAAC;YACT,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACzB,CAAC;IACL,CAAC;IAED,OAAO,OAAO,CAAC;IAEf,SAAS,cAAc,CAAC,SAAuB;QAC3C,IAAI,CAAC,EAAE,CAAC,mBAAmB,CAAC,SAAS,CAAC,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,EAAE,CAAC;YACtE,OAAO,IAAI,CAAC;QAChB,CAAC;QAED,MAAM,WAAW,GAAG,SAAS,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC9D,IAAI,CAAC,WAAW,IAAI,CAAC,EAAE,CAAC,YAAY,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE,CAAC;YACjF,OAAO,IAAI,CAAC;QAChB,CAAC;QAED,MAAM,IAAI,GAAG,WAAW,CAAC,WAAW,CAAC;QACrC,IACI,CAAC,EAAE,CAAC,gBAAgB,CAAC,IAAI,CAAC;YAC1B,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC;YACjC,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAC3C,CAAC;YACC,OAAO,IAAI,CAAC;QAChB,CAAC;QAED,OAAO;YACH,IAAI,EAAE,QAAQ;YACd,WAAW;YACX,UAAU,EAAE,WAAW,CAAC,IAAI,CAAC,IAAI;YACjC,UAAU;YACV,YAAY,EAAE,iBAAiB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YAClD,WAAW,EAAE,YAAY,CAAC,SAAS,CAAC;YACpC,SAAS,EAAE,IAAI;YACf,OAAO;SACV,CAAC;IACN,CAAC;AACL,CAAC;AAED,2DAA2D;AAC3D,SAAS,iBAAiB,CAAC,SAA+B;IACtD,OAAO,SAAS,CAAC,SAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC,IAAI,KAAK,CAAC;AACzG,CAAC;AAED,gGAAgG;AAChG,SAAS,iBAAiB,CAAC,QAAmC;IAC1D,IAAI,QAAQ,IAAI,EAAE,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC3C,OAAO,QAAQ,CAAC,IAAI,CAAC;IACzB,CAAC;IACD,OAAO,IAAI,CAAC;AAChB,CAAC"}
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,79 @@
1
+ import { describe, expect, it } from 'bun:test';
2
+ import * as ts from 'typescript';
3
+ import { extractEntity } from './extractEntity.js';
4
+ function extract(source) {
5
+ const sourceFile = ts.createSourceFile('x.ts', source, ts.ScriptTarget.Latest, true);
6
+ return extractEntity({
7
+ sourceFile,
8
+ packageName: '@acme/database',
9
+ relPath: 'packages/database/src/schema/payment.ts',
10
+ importPath: '@acme/database/schema/payment.js',
11
+ tableFunctions: new Set(['pgTable', 'mysqlTable']),
12
+ });
13
+ }
14
+ describe('extractEntity', () => {
15
+ it('extracts a pgTable entity with the table name as internalName', () => {
16
+ const symbols = extract(`
17
+ /** Payment records. */
18
+ export const payment = pgTable('payment', {
19
+ id: bigintStrict('id').primaryKey(),
20
+ status: paymentStatus('status').notNull(),
21
+ });
22
+ `);
23
+ expect(symbols).toEqual([
24
+ {
25
+ kind: 'entity',
26
+ packageName: '@acme/database',
27
+ exportName: 'payment',
28
+ importPath: '@acme/database/schema/payment.js',
29
+ internalName: 'payment',
30
+ description: 'Payment records.',
31
+ signature: null,
32
+ relPath: 'packages/database/src/schema/payment.ts',
33
+ },
34
+ ]);
35
+ });
36
+ it('extracts a pgTable entity with a trailing table-config argument', () => {
37
+ const symbols = extract(`
38
+ export const payment = pgTable(
39
+ 'payment',
40
+ { id: bigintStrict('id').primaryKey() },
41
+ table => [index('payment_id_idx').on(table.id)],
42
+ );
43
+ `);
44
+ expect(symbols).toMatchObject([{ kind: 'entity', exportName: 'payment', internalName: 'payment' }]);
45
+ });
46
+ it('does not match a sibling enumType call in the same source', () => {
47
+ const symbols = extract(`
48
+ export const paymentStatus = enumType('payment_status', PaymentStatus.options);
49
+ export const payment = pgTable('payment', { id: bigintStrict('id') });
50
+ `);
51
+ expect(symbols).toMatchObject([{ kind: 'entity', exportName: 'payment', internalName: 'payment' }]);
52
+ expect(symbols).toHaveLength(1);
53
+ });
54
+ it('matches every configured table function', () => {
55
+ const symbols = extract(`export const order = mysqlTable('orders', {});`);
56
+ expect(symbols).toMatchObject([{ kind: 'entity', exportName: 'order', internalName: 'orders' }]);
57
+ });
58
+ it('does not match a table function that is not configured', () => {
59
+ const symbols = extract(`export const order = sqliteTable('orders', {});`);
60
+ expect(symbols).toEqual([]);
61
+ });
62
+ it('does not match a non-exported pgTable const', () => {
63
+ const symbols = extract(`const internal = pgTable('internal', {});`);
64
+ expect(symbols).toEqual([]);
65
+ });
66
+ it('does not match a property-access callee like schema.pgTable(...)', () => {
67
+ const symbols = extract(`export const x = schema.pgTable('x', {});`);
68
+ expect(symbols).toEqual([]);
69
+ });
70
+ it('emits an entity with null internalName when the first argument is not a string literal', () => {
71
+ const symbols = extract(`export const dyn = pgTable(TABLE_NAME, { id: bigintStrict('id') });`);
72
+ expect(symbols).toMatchObject([{ kind: 'entity', exportName: 'dyn', internalName: null }]);
73
+ });
74
+ it('does not throw on truncated/malformed source', () => {
75
+ expect(() => extract(`export const x = pgTable(`)).not.toThrow();
76
+ expect(() => extract(`export const x = pgTable('t',`)).not.toThrow();
77
+ });
78
+ });
79
+ //# sourceMappingURL=extractEntity.test.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"extractEntity.test.js","sourceRoot":"","sources":["../../src/codeIndex/extractEntity.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,UAAU,CAAC;AAChD,OAAO,KAAK,EAAE,MAAM,YAAY,CAAC;AAEjC,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAGnD,SAAS,OAAO,CAAC,MAAc;IAC3B,MAAM,UAAU,GAAG,EAAE,CAAC,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC,YAAY,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACrF,OAAO,aAAa,CAAC;QACjB,UAAU;QACV,WAAW,EAAE,gBAAgB;QAC7B,OAAO,EAAE,yCAAyC;QAClD,UAAU,EAAE,kCAAkC;QAC9C,cAAc,EAAE,IAAI,GAAG,CAAC,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;KACrD,CAAC,CAAC;AACP,CAAC;AAED,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;IAC3B,EAAE,CAAC,+DAA+D,EAAE,GAAG,EAAE;QACrE,MAAM,OAAO,GAAG,OAAO,CAAC;;;;;;SAMvB,CAAC,CAAC;QAEH,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC;YACpB;gBACI,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,gBAAgB;gBAC7B,UAAU,EAAE,SAAS;gBACrB,UAAU,EAAE,kCAAkC;gBAC9C,YAAY,EAAE,SAAS;gBACvB,WAAW,EAAE,kBAAkB;gBAC/B,SAAS,EAAE,IAAI;gBACf,OAAO,EAAE,yCAAyC;aACrD;SACJ,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iEAAiE,EAAE,GAAG,EAAE;QACvE,MAAM,OAAO,GAAG,OAAO,CAAC;;;;;;SAMvB,CAAC,CAAC;QAEH,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,SAAS,EAAE,YAAY,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;IACxG,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;QACjE,MAAM,OAAO,GAAG,OAAO,CAAC;;;SAGvB,CAAC,CAAC;QAEH,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,SAAS,EAAE,YAAY,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;QACpG,MAAM,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;QAC/C,MAAM,OAAO,GAAG,OAAO,CAAC,gDAAgD,CAAC,CAAC;QAE1E,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC;IACrG,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wDAAwD,EAAE,GAAG,EAAE;QAC9D,MAAM,OAAO,GAAG,OAAO,CAAC,iDAAiD,CAAC,CAAC;QAE3E,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;QACnD,MAAM,OAAO,GAAG,OAAO,CAAC,2CAA2C,CAAC,CAAC;QAErE,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kEAAkE,EAAE,GAAG,EAAE;QACxE,MAAM,OAAO,GAAG,OAAO,CAAC,2CAA2C,CAAC,CAAC;QAErE,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wFAAwF,EAAE,GAAG,EAAE;QAC9F,MAAM,OAAO,GAAG,OAAO,CAAC,qEAAqE,CAAC,CAAC;QAE/F,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,KAAK,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IAC/F,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACpD,MAAM,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,2BAA2B,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;QACjE,MAAM,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,+BAA+B,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;IACzE,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}
@@ -0,0 +1,27 @@
1
+ import * as ts from 'typescript';
2
+ import type { IndexSymbol } from './IndexSymbol.js';
3
+ /** Inputs for {@link extractUtil}. */
4
+ export interface ExtractUtilOptions {
5
+ /** Parsed source file to scan (top-level statements only). */
6
+ sourceFile: ts.SourceFile;
7
+ /** Owning workspace package name, e.g. '@acme/utils'. */
8
+ packageName: string;
9
+ /** Repo-relative declaring file path, for {@link IndexSymbol.relPath}. */
10
+ relPath: string;
11
+ /** Deep import specifier for this file, from `importPathOf`. */
12
+ importPath: string;
13
+ }
14
+ /**
15
+ * Extracts every exported helper function tagged with a `@util` JSDoc tag from a source file's
16
+ * top-level statements. Two forms are recognized: an `export function foo(...)` declaration (the
17
+ * dominant form) and an `export const foo = (...) => ...` / `= function (...)` whose initializer
18
+ * is an arrow function or function expression. The `@util` tag is detected structurally via
19
+ * `ts.getJSDocTags` — a bare `@util` appearing in prose (not as a tag) does not qualify.
20
+ *
21
+ * The rendered `signature` is reconstructed from source text as `name(paramText, ...): returnText`
22
+ * (each parameter's and the return type's `.getText`), with the return part omitted when there is
23
+ * no explicit return type; the body and JSDoc are never included. Syntax-only — it never
24
+ * type-checks and never throws on unexpected AST: non-matching statements are simply skipped.
25
+ * @__NO_SIDE_EFFECTS__
26
+ */
27
+ export declare function extractUtil(options: ExtractUtilOptions): IndexSymbol[];