Skip to content

Commit c8d8e91

Browse files
chenrui333chenrui333
authored
chore: add prettier config (#633)
Signed-off-by: Rui Chen <[email protected]>
1 parent 605f567 commit c8d8e91

File tree

7 files changed

+275
-357
lines changed

7 files changed

+275
-357
lines changed

‎.prettierignore‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Build outputs
2+
dist/
3+
lib/
4+
coverage/
5+
6+
# Dependencies
7+
node_modules/
8+
9+
# Misc
10+
.github/
11+
*.log
12+
.DS_Store
13+
__tests__/release.txt
14+
15+
# Package files
16+
package-lock.json

‎.prettierrc.js‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
/**
2+
* @type {import('prettier').Config}
3+
*/
4+
module.exports = {
5+
trailingComma: 'all',
6+
tabWidth: 2,
7+
semi: true,
8+
singleQuote: true,
9+
printWidth: 100,
10+
bracketSpacing: true,
11+
};

‎__tests__/github.test.ts‎

Lines changed: 51 additions & 97 deletions
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,56 @@
1-
import {
2-
asset,
3-
findTagFromReleases,
4-
mimeOrDefault,
5-
Release,
6-
Releaser,
7-
} from "../src/github";
8-
9-
import { assert, describe, it } from "vitest";
10-
11-
describe("github", () => {
12-
describe("mimeOrDefault", () => {
13-
it("returns a specific mime for common path", async () => {
14-
assert.equal(mimeOrDefault("foo.tar.gz"), "application/gzip");
1+
import { asset, findTagFromReleases, mimeOrDefault, Release, Releaser } from '../src/github';
2+
3+
import { assert, describe, it } from 'vitest';
4+
5+
describe('github', () => {
6+
describe('mimeOrDefault', () => {
7+
it('returns a specific mime for common path', async () => {
8+
assert.equal(mimeOrDefault('foo.tar.gz'), 'application/gzip');
159
});
16-
it("returns default mime for uncommon path", async () => {
17-
assert.equal(mimeOrDefault("foo.uncommon"), "application/octet-stream");
10+
it('returns default mime for uncommon path', async () => {
11+
assert.equal(mimeOrDefault('foo.uncommon'), 'application/octet-stream');
1812
});
1913
});
2014

21-
describe("asset", () => {
22-
it("derives asset info from a path", async () => {
23-
const { name, mime, size } = asset("tests/data/foo/bar.txt");
24-
assert.equal(name, "bar.txt");
25-
assert.equal(mime, "text/plain");
15+
describe('asset', () => {
16+
it('derives asset info from a path', async () => {
17+
const { name, mime, size } = asset('tests/data/foo/bar.txt');
18+
assert.equal(name, 'bar.txt');
19+
assert.equal(mime, 'text/plain');
2620
assert.equal(size, 10);
2721
});
2822
});
2923

30-
describe("findTagFromReleases", () => {
31-
const owner = "owner";
32-
const repo = "repo";
24+
describe('findTagFromReleases', () => {
25+
const owner = 'owner';
26+
const repo = 'repo';
3327

3428
const mockRelease: Release = {
3529
id: 1,
3630
upload_url: `https://api.github.com/repos/${owner}/${repo}/releases/1/assets`,
3731
html_url: `https://github.com/${owner}/${repo}/releases/tag/v1.0.0`,
38-
tag_name: "v1.0.0",
39-
name: "Test Release",
40-
body: "Test body",
41-
target_commitish: "main",
32+
tag_name: 'v1.0.0',
33+
name: 'Test Release',
34+
body: 'Test body',
35+
target_commitish: 'main',
4236
draft: false,
4337
prerelease: false,
4438
assets: [],
4539
} as const;
4640

4741
const mockReleaser: Releaser = {
48-
getReleaseByTag: () => Promise.reject("Not implemented"),
49-
createRelease: () => Promise.reject("Not implemented"),
50-
updateRelease: () => Promise.reject("Not implemented"),
42+
getReleaseByTag: () => Promise.reject('Not implemented'),
43+
createRelease: () => Promise.reject('Not implemented'),
44+
updateRelease: () => Promise.reject('Not implemented'),
5145
allReleases: async function* () {
5246
yield { data: [mockRelease] };
5347
},
5448
} as const;
5549

56-
describe("when the tag_name is not an empty string", () => {
57-
const targetTag = "v1.0.0";
50+
describe('when the tag_name is not an empty string', () => {
51+
const targetTag = 'v1.0.0';
5852

59-
it("finds a matching release in first batch of results", async () => {
53+
it('finds a matching release in first batch of results', async () => {
6054
const targetRelease = {
6155
...mockRelease,
6256
owner,
@@ -67,7 +61,7 @@ describe("github", () => {
6761
...mockRelease,
6862
owner,
6963
repo,
70-
tag_name: "v1.0.1",
64+
tag_name: 'v1.0.1',
7165
};
7266

7367
const releaser = {
@@ -78,17 +72,12 @@ describe("github", () => {
7872
},
7973
};
8074

81-
const result = await findTagFromReleases(
82-
releaser,
83-
owner,
84-
repo,
85-
targetTag,
86-
);
75+
const result = await findTagFromReleases(releaser, owner, repo, targetTag);
8776

8877
assert.deepStrictEqual(result, targetRelease);
8978
});
9079

91-
it("finds a matching release in second batch of results", async () => {
80+
it('finds a matching release in second batch of results', async () => {
9281
const targetRelease = {
9382
...mockRelease,
9483
owner,
@@ -99,7 +88,7 @@ describe("github", () => {
9988
...mockRelease,
10089
owner,
10190
repo,
102-
tag_name: "v1.0.1",
91+
tag_name: 'v1.0.1',
10392
};
10493

10594
const releaser = {
@@ -110,21 +99,16 @@ describe("github", () => {
11099
},
111100
};
112101

113-
const result = await findTagFromReleases(
114-
releaser,
115-
owner,
116-
repo,
117-
targetTag,
118-
);
102+
const result = await findTagFromReleases(releaser, owner, repo, targetTag);
119103
assert.deepStrictEqual(result, targetRelease);
120104
});
121105

122-
it("returns undefined when a release is not found in any batch", async () => {
106+
it('returns undefined when a release is not found in any batch', async () => {
123107
const otherRelease = {
124108
...mockRelease,
125109
owner,
126110
repo,
127-
tag_name: "v1.0.1",
111+
tag_name: 'v1.0.1',
128112
};
129113
const releaser = {
130114
...mockReleaser,
@@ -134,39 +118,29 @@ describe("github", () => {
134118
},
135119
};
136120

137-
const result = await findTagFromReleases(
138-
releaser,
139-
owner,
140-
repo,
141-
targetTag,
142-
);
121+
const result = await findTagFromReleases(releaser, owner, repo, targetTag);
143122

144123
assert.strictEqual(result, undefined);
145124
});
146125

147-
it("returns undefined when no releases are returned", async () => {
126+
it('returns undefined when no releases are returned', async () => {
148127
const releaser = {
149128
...mockReleaser,
150129
allReleases: async function* () {
151130
yield { data: [] };
152131
},
153132
};
154133

155-
const result = await findTagFromReleases(
156-
releaser,
157-
owner,
158-
repo,
159-
targetTag,
160-
);
134+
const result = await findTagFromReleases(releaser, owner, repo, targetTag);
161135

162136
assert.strictEqual(result, undefined);
163137
});
164138
});
165139

166-
describe("when the tag_name is an empty string", () => {
167-
const emptyTag = "";
140+
describe('when the tag_name is an empty string', () => {
141+
const emptyTag = '';
168142

169-
it("finds a matching release in first batch of results", async () => {
143+
it('finds a matching release in first batch of results', async () => {
170144
const targetRelease = {
171145
...mockRelease,
172146
owner,
@@ -177,7 +151,7 @@ describe("github", () => {
177151
...mockRelease,
178152
owner,
179153
repo,
180-
tag_name: "v1.0.1",
154+
tag_name: 'v1.0.1',
181155
};
182156

183157
const releaser = {
@@ -188,17 +162,12 @@ describe("github", () => {
188162
},
189163
};
190164

191-
const result = await findTagFromReleases(
192-
releaser,
193-
owner,
194-
repo,
195-
emptyTag,
196-
);
165+
const result = await findTagFromReleases(releaser, owner, repo, emptyTag);
197166

198167
assert.deepStrictEqual(result, targetRelease);
199168
});
200169

201-
it("finds a matching release in second batch of results", async () => {
170+
it('finds a matching release in second batch of results', async () => {
202171
const targetRelease = {
203172
...mockRelease,
204173
owner,
@@ -209,7 +178,7 @@ describe("github", () => {
209178
...mockRelease,
210179
owner,
211180
repo,
212-
tag_name: "v1.0.1",
181+
tag_name: 'v1.0.1',
213182
};
214183

215184
const releaser = {
@@ -220,21 +189,16 @@ describe("github", () => {
220189
},
221190
};
222191

223-
const result = await findTagFromReleases(
224-
releaser,
225-
owner,
226-
repo,
227-
emptyTag,
228-
);
192+
const result = await findTagFromReleases(releaser, owner, repo, emptyTag);
229193
assert.deepStrictEqual(result, targetRelease);
230194
});
231195

232-
it("returns undefined when a release is not found in any batch", async () => {
196+
it('returns undefined when a release is not found in any batch', async () => {
233197
const otherRelease = {
234198
...mockRelease,
235199
owner,
236200
repo,
237-
tag_name: "v1.0.1",
201+
tag_name: 'v1.0.1',
238202
};
239203
const releaser = {
240204
...mockReleaser,
@@ -244,30 +208,20 @@ describe("github", () => {
244208
},
245209
};
246210

247-
const result = await findTagFromReleases(
248-
releaser,
249-
owner,
250-
repo,
251-
emptyTag,
252-
);
211+
const result = await findTagFromReleases(releaser, owner, repo, emptyTag);
253212

254213
assert.strictEqual(result, undefined);
255214
});
256215

257-
it("returns undefined when no releases are returned", async () => {
216+
it('returns undefined when no releases are returned', async () => {
258217
const releaser = {
259218
...mockReleaser,
260219
allReleases: async function* () {
261220
yield { data: [] };
262221
},
263222
};
264223

265-
const result = await findTagFromReleases(
266-
releaser,
267-
owner,
268-
repo,
269-
emptyTag,
270-
);
224+
const result = await findTagFromReleases(releaser, owner, repo, emptyTag);
271225

272226
assert.strictEqual(result, undefined);
273227
});

0 commit comments

Comments
 (0)