Skip to content

Commit 2505e72

Browse files
authoredJan 26, 2024
fix: Revert remove final - from addlistener slug (#48)
1 parent cd1a4b5 commit 2505e72

File tree

5 files changed

+5
-12
lines changed

5 files changed

+5
-12
lines changed
 

‎src/formatting.ts

-7
Original file line numberDiff line numberDiff line change
@@ -78,13 +78,6 @@ export function formatMethodSignature(m: DocsInterfaceMethod) {
7878
return `${m.name}(${m.parameters.length > 0 ? '...' : ''})`;
7979
}
8080

81-
export function formatMethodSignatureForSlug(m: DocsInterfaceMethod) {
82-
if (m.name === 'addListener' && m.parameters.length > 0) {
83-
return `addListener(${m.parameters[0].type.replace(/\"/g, `'`)})`;
84-
}
85-
return `${m.name}(${m.parameters.length > 0 ? '...' : ''})`;
86-
}
87-
8881
function linkToken(data: DocsData, token: string) {
8982
const t = token.replace(/`/g, '');
9083
const i = data.interfaces.find((i) => {

‎src/parse.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import type {
1515
} from './types';
1616
import { getTsProgram } from './transpile';
1717
import GithubSlugger from 'github-slugger';
18-
import { formatMethodSignatureForSlug } from './formatting';
18+
import { formatMethodSignature } from './formatting';
1919

2020
/**
2121
* Given either a tsconfig file path, or exact input files, will
@@ -290,7 +290,7 @@ function getInterfaceMethod(typeChecker: ts.TypeChecker, methodSignature: ts.Met
290290
slug: '',
291291
};
292292

293-
m.slug = slugify(formatMethodSignatureForSlug(m));
293+
m.slug = slugify(formatMethodSignature(m));
294294

295295
return m;
296296
}

‎src/test/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Below is an index of all the methods available.
1111
* [`impact(...)`](#impact)
1212
* [`notification(...)`](#notification)
1313
* [`vibrate(...)`](#vibrate)
14-
* [`addListener('vibrate', ...)`](#addlistenervibrate)
14+
* [`addListener('vibrate', ...)`](#addlistenervibrate-)
1515
* [`removeAllListeners()`](#removealllisteners)
1616
* [Interfaces](#interfaces)
1717
* [Type Aliases](#type-aliases)

‎src/test/docs.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@
110110
"complexTypes": [
111111
"VibrateListener"
112112
],
113-
"slug": "addlistenervibrate"
113+
"slug": "addlistenervibrate-"
114114
},
115115
{
116116
"name": "removeAllListeners",

‎src/test/parse.spec.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ describe('parse', () => {
8484

8585
const m3 = api.methods[3];
8686
expect(m3.name).toBe(`addListener`);
87-
expect(m3.slug).toBe(`addlistenervibrate`);
87+
expect(m3.slug).toBe(`addlistenervibrate-`);
8888
expect(m3.docs).toBe(`Add a listener. Callback has VibrateOptions.`);
8989
expect(m3.signature).toBe(`(eventName: 'vibrate', listenerFunc: VibrateListener) => Promise<void>`);
9090
expect(m3.complexTypes).toContain(`VibrateListener`);

0 commit comments

Comments
 (0)
Please sign in to comment.