Skip to content

Commit f8b4598

Browse files
velutvelut
committedApr 14, 2025
refactor: use return await
1 parent 89bc8d1 commit f8b4598

13 files changed

+37
-36
lines changed
 

‎src/extract-class.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ export const extractClass = async (
8383

8484
const classSignature = async (declaration: ClassDeclaration): Promise<string> => {
8585
const signature = headText(declaration);
86-
return formatSignature("class", signature);
86+
return await formatSignature("class", signature);
8787
};
8888

8989
const extractClassConstructors = async (
@@ -136,7 +136,7 @@ const classConstructorSignature = async (declaration: ConstructorDeclaration): P
136136
})
137137
.join(",");
138138
const signature = `${modifiers} constructor(${params});`;
139-
return formatSignature("class-constructor", signature);
139+
return await formatSignature("class-constructor", signature);
140140
};
141141

142142
const extractClassProperties = async (
@@ -188,7 +188,7 @@ const classPropertySignature = async (
188188
const staticKeyword = declaration.isStatic() ? "static" : "";
189189
const readonlyKeyword = declaration.getSetAccessor() === undefined ? "readonly" : "";
190190
const signature = `${staticKeyword} ${readonlyKeyword} ${name}: ${type}`;
191-
return formatSignature("class-property", signature);
191+
return await formatSignature("class-property", signature);
192192
};
193193

194194
const extractClassMethods = async (
@@ -230,5 +230,5 @@ const classMethodSignature = async (
230230
): Promise<string> => {
231231
const modifiers = modifiersText(declaration);
232232
const type = typeCheckerType(declaration);
233-
return formatSignature("class-method", `${modifiers} ${name}: ${type}`);
233+
return await formatSignature("class-method", `${modifiers} ${name}: ${type}`);
234234
};

‎src/extract-declarations.ts

+11-11
Original file line numberDiff line numberDiff line change
@@ -142,13 +142,13 @@ const extractDeclaration = async ({
142142
seenNamespaces,
143143
}: ExtractDeclarationOptions): Promise<ExtractedDeclaration | undefined> => {
144144
if (isVariable(declaration)) {
145-
return extractVariable(containerName, exportName, declaration);
145+
return await extractVariable(containerName, exportName, declaration);
146146
}
147147
if (isVariableAssignmentExpression(declaration)) {
148-
return extractVariableAssignmentExpression(containerName, exportName, declaration);
148+
return await extractVariableAssignmentExpression(containerName, exportName, declaration);
149149
}
150150
if (isExpression(declaration)) {
151-
return extractExpression(containerName, exportName, declaration);
151+
return await extractExpression(containerName, exportName, declaration);
152152
}
153153
if (isFunction(declaration)) {
154154
if (seenFunctions.has(exportName)) {
@@ -157,22 +157,22 @@ const extractDeclaration = async ({
157157
return undefined;
158158
}
159159
seenFunctions.add(exportName);
160-
return extractFunction(containerName, exportName, declaration);
160+
return await extractFunction(containerName, exportName, declaration);
161161
}
162162
if (isFunctionExpression(declaration)) {
163-
return extractFunctionExpression(containerName, exportName, declaration);
163+
return await extractFunctionExpression(containerName, exportName, declaration);
164164
}
165165
if (isClass(declaration)) {
166-
return extractClass(containerName, exportName, declaration);
166+
return await extractClass(containerName, exportName, declaration);
167167
}
168168
if (isInterface(declaration)) {
169-
return extractInterface(containerName, exportName, declaration);
169+
return await extractInterface(containerName, exportName, declaration);
170170
}
171171
if (isEnum(declaration)) {
172-
return extractEnum(containerName, exportName, declaration);
172+
return await extractEnum(containerName, exportName, declaration);
173173
}
174174
if (isTypeAlias(declaration)) {
175-
return extractTypeAlias(containerName, exportName, declaration);
175+
return await extractTypeAlias(containerName, exportName, declaration);
176176
}
177177
if (isNamespace(declaration) && maxDepth > 0) {
178178
if (seenNamespaces.has(exportName)) {
@@ -186,7 +186,7 @@ const extractDeclaration = async ({
186186
container: declaration,
187187
maxDepth: maxDepth - 1,
188188
});
189-
return extractNamespace(containerName, exportName, declaration, innerDeclarations);
189+
return await extractNamespace(containerName, exportName, declaration, innerDeclarations);
190190
}
191191
if (isFileModule(declaration) && maxDepth > 0) {
192192
// A file module declaration happens with the following export forms:
@@ -197,7 +197,7 @@ const extractDeclaration = async ({
197197
container: declaration,
198198
maxDepth: maxDepth - 1,
199199
});
200-
return extractFileModule(containerName, exportName, declaration, innerDeclarations);
200+
return await extractFileModule(containerName, exportName, declaration, innerDeclarations);
201201
}
202202
return undefined;
203203
};

‎src/extract-enum.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ export const extractEnum = async (
4747

4848
const enumSignature = async (declaration: EnumDeclaration): Promise<string> => {
4949
const signature = headText(declaration);
50-
return formatSignature("enum", signature);
50+
return await formatSignature("enum", signature);
5151
};
5252

5353
const extractEnumMembers = async (
@@ -75,5 +75,5 @@ const extractEnumMembers = async (
7575

7676
const enumMemberSignature = async (declaration: EnumMember): Promise<string> => {
7777
const signature = declaration.getText();
78-
return formatSignature("enum-member", signature);
78+
return await formatSignature("enum-member", signature);
7979
};

‎src/extract-expression.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,5 +23,5 @@ export const extractExpression = async (
2323
const expressionSignature = async (name: string, declaration: Expression): Promise<string> => {
2424
const kind = "const";
2525
const type = apparentType(declaration);
26-
return formatSignature("variable", `${kind} ${name}: ${type}`);
26+
return await formatSignature("variable", `${kind} ${name}: ${type}`);
2727
};

‎src/extract-file-module.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,5 +31,5 @@ const fileModuleDocs = (declaration: SourceFile): string[] => {
3131

3232
const fileModuleSignature = async (declaration: SourceFile): Promise<string> => {
3333
const filename = declaration.getSourceFile().getBaseName();
34-
return formatSignature("namespace", `module "${filename}" {}`);
34+
return await formatSignature("namespace", `module "${filename}" {}`);
3535
};

‎src/extract-function-expression.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,5 +25,5 @@ const functionExpressionSignature = async (
2525
declaration: VariableDeclaration,
2626
): Promise<string> => {
2727
const type = typeCheckerType(declaration);
28-
return formatSignature("function", `${name}: ${type}`);
28+
return await formatSignature("function", `${name}: ${type}`);
2929
};

‎src/extract-function.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,5 +34,5 @@ const functionSignature = async (
3434
declaration: FunctionDeclaration | ArrowFunction,
3535
): Promise<string> => {
3636
const type = typeCheckerType(declaration);
37-
return formatSignature("function", `${name}: ${type}`);
37+
return await formatSignature("function", `${name}: ${type}`);
3838
};

‎src/extract-interface.ts

+8-8
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ export const extractInterface = async (
130130

131131
const interfaceSignature = async (declaration: InterfaceDeclaration): Promise<string> => {
132132
const signature = headText(declaration);
133-
return formatSignature("interface", signature);
133+
return await formatSignature("interface", signature);
134134
};
135135

136136
const extractInterfaceProperties = async (
@@ -158,7 +158,7 @@ const extractInterfaceProperties = async (
158158

159159
const interfacePropertySignature = async (declaration: PropertySignature): Promise<string> => {
160160
const signature = declaration.getText();
161-
return formatSignature("interface-property", signature);
161+
return await formatSignature("interface-property", signature);
162162
};
163163

164164
const extractInterfaceMethods = async (
@@ -195,7 +195,7 @@ const interfaceMethodSignature = async (
195195
declaration: MethodSignature,
196196
): Promise<string> => {
197197
const type = typeCheckerType(declaration);
198-
return formatSignature("interface-method", `${name}: ${type}`);
198+
return await formatSignature("interface-method", `${name}: ${type}`);
199199
};
200200

201201
const extractInterfaceConstructSignatures = async (
@@ -224,7 +224,7 @@ const interfaceConstructSignatureSignature = async (
224224
declaration: ConstructSignatureDeclaration,
225225
): Promise<string> => {
226226
const signature = declaration.getText();
227-
return formatSignature("interface-construct-signature", signature);
227+
return await formatSignature("interface-construct-signature", signature);
228228
};
229229

230230
const extractInterfaceCallSignatures = async (
@@ -253,7 +253,7 @@ const interfaceCallSignatureSignature = async (
253253
declaration: CallSignatureDeclaration,
254254
): Promise<string> => {
255255
const signature = declaration.getText();
256-
return formatSignature("interface-call-signature", signature);
256+
return await formatSignature("interface-call-signature", signature);
257257
};
258258

259259
const extractInterfaceIndexSignatures = async (
@@ -282,7 +282,7 @@ const interfaceIndexSignatureSignature = async (
282282
declaration: IndexSignatureDeclaration,
283283
): Promise<string> => {
284284
const signature = declaration.getText();
285-
return formatSignature("interface-index-signature", signature);
285+
return await formatSignature("interface-index-signature", signature);
286286
};
287287

288288
const extractInterfaceGetAccessors = async (
@@ -312,7 +312,7 @@ const interfaceGetAccessorSignature = async (
312312
declaration: GetAccessorDeclaration,
313313
): Promise<string> => {
314314
const signature = declaration.getText();
315-
return formatSignature("interface-get-accessor", signature);
315+
return await formatSignature("interface-get-accessor", signature);
316316
};
317317

318318
const extractInterfaceSetAccessors = async (
@@ -342,5 +342,5 @@ const interfaceSetAccessorSignature = async (
342342
declaration: SetAccessorDeclaration,
343343
): Promise<string> => {
344344
const signature = declaration.getText();
345-
return formatSignature("interface-get-accessor", signature);
345+
return await formatSignature("interface-get-accessor", signature);
346346
};

‎src/extract-namespace.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,5 +36,5 @@ const namespaceSignature = async (exportName: string): Promise<string> => {
3636
const containerKeyword =
3737
exportName.startsWith('"') || exportName.startsWith("'") ? "module" : "namespace";
3838
const signature = `${containerKeyword} ${exportName} {}`;
39-
return formatSignature("namespace", signature);
39+
return await formatSignature("namespace", signature);
4040
};

‎src/extract-package-api.ts

+4-3
Original file line numberDiff line numberDiff line change
@@ -125,14 +125,15 @@ console.log(JSON.stringify(packageApi, null, 2));
125125
126126
@returns A {@link PackageApi} object
127127
*/
128-
export const extractPackageApi = ({
128+
export const extractPackageApi = async ({
129129
pkg,
130130
subpath = ".",
131131
maxDepth = 5,
132132
bunPath = "bun",
133-
}: ExtractPackageApiOptions): Promise<PackageApi> =>
134-
extractPackageApiEffect({ pkg, subpath, maxDepth }).pipe(
133+
}: ExtractPackageApiOptions): Promise<PackageApi> => {
134+
return await extractPackageApiEffect({ pkg, subpath, maxDepth }).pipe(
135135
Effect.scoped,
136136
Effect.provideService(PackageManager, bunPackageManager(bunPath)),
137137
Effect.runPromise,
138138
);
139+
};

‎src/extract-type-alias.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,5 +40,5 @@ const typeAliasSignature = async (declaration: TypeAliasDeclaration): Promise<st
4040
// - https://github.com/dsherret/ts-morph/issues/453#issuecomment-427405736
4141
// - https://twitter.com/drosenwasser/status/1289640180035403776
4242
const signature = declaration.getText();
43-
return formatSignature("type", signature);
43+
return await formatSignature("type", signature);
4444
};

‎src/extract-variable-assignment-expression.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,5 +39,5 @@ const variableAssignmentExpressionSignature = async (
3939
const variableType = apparentType(variableDeclaration);
4040
const expressionType = apparentType(declaration);
4141
const type = variableType !== "any" ? variableType : expressionType;
42-
return formatSignature("variable", `${kind} ${name}: ${type}`);
42+
return await formatSignature("variable", `${kind} ${name}: ${type}`);
4343
};

‎src/extract-variable.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,5 +35,5 @@ const variableSignature = async (
3535
): Promise<string> => {
3636
const kind = declaration.getVariableStatementOrThrow().getDeclarationKind().toString();
3737
const type = apparentType(declaration);
38-
return formatSignature("variable", `${kind} ${name}: ${type}`);
38+
return await formatSignature("variable", `${kind} ${name}: ${type}`);
3939
};

0 commit comments

Comments
 (0)