Skip to content

Commit 3a2d4ba

Browse files
committed
chore: format
1 parent fd07553 commit 3a2d4ba

19 files changed

Lines changed: 434 additions & 364 deletions

.eslintrc.cjs

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
module.exports = {
2-
root: true,
3-
parser: "@typescript-eslint/parser",
4-
parserOptions: { ecmaVersion: "latest", sourceType: "module" },
5-
plugins: ["@typescript-eslint"],
6-
extends: ["eslint:recommended", "plugin:@typescript-eslint/recommended", "prettier"],
7-
ignorePatterns: ["dist"]
2+
root: true,
3+
parser: "@typescript-eslint/parser",
4+
parserOptions: { ecmaVersion: "latest", sourceType: "module" },
5+
plugins: ["@typescript-eslint"],
6+
extends: [
7+
"eslint:recommended",
8+
"plugin:@typescript-eslint/recommended",
9+
"prettier",
10+
],
11+
ignorePatterns: ["dist"],
812
};

CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ This project uses **[Conventional Commits](https://www.conventionalcommits.org/e
4141
to automate changelog generation and releases.
4242

4343
Examples:
44+
4445
```
4546
feat: add AES decryption helper
4647
fix: incorrect key mapping for quest parts

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,21 +60,25 @@ See [`etc/everybodycodes-data.api.md`](./etc/everybodycodes-data.api.md) for the
6060
## 🧱 Development
6161

6262
### Prerequisites
63+
6364
- Node.js ≥ 18.17
6465
- npm ≥ 9 or pnpm ≥ 8
6566

6667
### Setup
68+
6769
```bash
6870
npm ci
6971
```
7072

7173
### Run all checks
74+
7275
```bash
7376
npm test
7477
npm run build
7578
```
7679

7780
### Lint & Format
81+
7882
```bash
7983
npm run lint
8084
npm run format
@@ -86,8 +90,8 @@ npm run format
8690

8791
This repository uses [release-please](https://github.com/google-github-actions/release-please-action):
8892

89-
1. Conventional commits (`fix:`, `feat:`) update changelog and version bump via PR.
90-
2. Merge the release PR → Git tag is created.
93+
1. Conventional commits (`fix:`, `feat:`) update changelog and version bump via PR.
94+
2. Merge the release PR → Git tag is created.
9195
3. GitHub Actions publish the package to npm with provenance.
9296

9397
---

SECURITY.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
Only the latest published npm version of `@mrtimeey/everybodycodes-data` receives fixes and updates.
66

77
| Version | Supported |
8-
|----------|------------|
9-
| latest ||
8+
| ------- | --------- |
9+
| latest | |
1010

1111
---
1212

@@ -19,6 +19,7 @@ Instead, contact:
1919
**coding@mrtimeey.com**
2020

2121
Include as much detail as possible:
22+
2223
- Description of the vulnerability
2324
- Steps to reproduce
2425
- A minimal proof-of-concept if applicable

api-extractor.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,7 @@
1212
},
1313
"docModel": { "enabled": false },
1414
"tsdocMetadata": { "enabled": false },
15-
"messages": { "extractorMessageReporting": { "default": { "logLevel": "warning" } } }
15+
"messages": {
16+
"extractorMessageReporting": { "default": { "logLevel": "warning" } }
17+
}
1618
}

examples/basics.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,59 +5,63 @@
55
Handling for yearly events.
66

77
### Complete Data
8+
89
Returns all data for a given quest in a given event. Contains all currently unlocked parts.
910

1011
```ts
1112
import { EverybodyCodesClient } from "@mrtimeey/everybodycodes-data";
1213

13-
const sessionCookie = 'everybody-codes-session-cookie'
14+
const sessionCookie = "everybody-codes-session-cookie";
1415

1516
const client = new EverybodyCodesClient(sessionCookie);
16-
const data = await client.getEventData("2025",1 );
17-
console.log(data);
17+
const data = await client.getEventData("2025", 1);
18+
console.log(data);
1819
```
1920

2021
### Partial Data
22+
2123
Returns data for a given part in a given quest. Undefined if not unlocked.
2224

2325
```ts
2426
import { EverybodyCodesClient } from "@mrtimeey/everybodycodes-data";
2527

26-
const sessionCookie = 'everybody-codes-session-cookie'
28+
const sessionCookie = "everybody-codes-session-cookie";
2729

2830
const client = new EverybodyCodesClient(sessionCookie);
2931

30-
const part1Data = await client.getEventPartData("2024",1,1);
31-
console.log(part1Data);
32+
const part1Data = await client.getEventPartData("2024", 1, 1);
33+
console.log(part1Data);
3234
```
3335

3436
## Stories
3537

3638
Handling for stories.
3739

3840
### Complete Data
41+
3942
Returns all data for a given quest in a given story. Contains all currently unlocked parts.
4043

4144
```ts
4245
import { EverybodyCodesClient } from "@mrtimeey/everybodycodes-data";
4346

44-
const sessionCookie = 'everybody-codes-session-cookie'
47+
const sessionCookie = "everybody-codes-session-cookie";
4548

4649
const client = new EverybodyCodesClient(sessionCookie);
47-
const data = await client.getStoryData("1",1 );
48-
console.log(data);
50+
const data = await client.getStoryData("1", 1);
51+
console.log(data);
4952
```
5053

5154
### Partial Data
55+
5256
Returns data for a given part in a given quest. Undefined if not unlocked.
5357

5458
```ts
5559
import { EverybodyCodesClient } from "@mrtimeey/everybodycodes-data";
5660

57-
const sessionCookie = 'everybody-codes-session-cookie'
61+
const sessionCookie = "everybody-codes-session-cookie";
5862

5963
const client = new EverybodyCodesClient(sessionCookie);
6064

61-
const part1Data = await client.getStoryPartData("1",1,1);
62-
console.log(part1Data);
65+
const part1Data = await client.getStoryPartData("1", 1, 1);
66+
console.log(part1Data);
6367
```

0 commit comments

Comments
 (0)