Skip to content

Commit

Permalink
chore: release 2.0.0
Browse files Browse the repository at this point in the history
* perf: replace enum endpoints with consts

* refactor: replace params enums with types

* refactor: replace enums with types

* fix: simplify types

* feat: add random client

* fix: remove banner from build output

* style: update biome config

* perf: remove type boilerplate

* feat: add random to jikan client

* perf: remove unnecesary type assertion

* feat: add some missing anime and manga endpoints

* perf: remove boilerplate

* perf: rename identifiers to pathParams

* test: update tests

* docs: update README.md

* feat: add getTopCharacters to topClient

* fix: character model

* chore: add bun.lockb to npmignore

* chore: bump to v2.0.0
  • Loading branch information
tutkli authored May 14, 2024
2 parents b692f5a + 8289575 commit 10cd9fe
Show file tree
Hide file tree
Showing 77 changed files with 1,643 additions and 3,718 deletions.
1 change: 1 addition & 0 deletions .npmignore
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,4 @@ biome.json
.githooks
tsup.config.ts
vitest.config.ts
bun.lockb
38 changes: 37 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,54 @@ All notable changes to this project will be documented in this file. Dates are d

Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).

#### [1.2.1](https://github.com/tutkli/jikan-ts/compare/1.2.0...1.2.1)
#### [v2.0.0](https://github.com/tutkli/jikan-ts/compare/v1.2.2...v2.0.0)

- style: update biome config [`3308c4f`](https://github.com/tutkli/jikan-ts/commit/3308c4f42dcff101abc581d18fa5e79c1b51ebd7)
- fix: remove banner from build output [`ba11de2`](https://github.com/tutkli/jikan-ts/commit/ba11de294e7d8126181e6a283c6646a12942489f)
- perf: remove boilerplate [`6a60194`](https://github.com/tutkli/jikan-ts/commit/6a60194b244325f8660d6254a6f9d4f71fbdb9dd)
- fix: simplify types [`2fba166`](https://github.com/tutkli/jikan-ts/commit/2fba16686f1c8a2f10386357ae5b2b979105ef68)
- perf: replace enum endpoints with consts [`f268a9a`](https://github.com/tutkli/jikan-ts/commit/f268a9a0e9d0bc8678117e899e0b98b89df52983)
- refactor: replace params enums with types [`a1a0be8`](https://github.com/tutkli/jikan-ts/commit/a1a0be896d27977105efef940f9420e15e5dac90)
- perf: remove type boilerplate [`f5fd9d3`](https://github.com/tutkli/jikan-ts/commit/f5fd9d32ff0ba50a4fed0489144fc28d9b2263c3)
- feat: add some missing anime and manga endpoints [`b98dcb8`](https://github.com/tutkli/jikan-ts/commit/b98dcb814374de4080f1b54d3faeb6b951941481)
- refactor: replace enums with types [`697432d`](https://github.com/tutkli/jikan-ts/commit/697432d7114332b97752044f07e4e05fe9ec42f4)
- feat: add random client [`2e034d1`](https://github.com/tutkli/jikan-ts/commit/2e034d1c8a5832edbd48dc111df6b8df1dd2146d)
- fix: character model [`4f9f76a`](https://github.com/tutkli/jikan-ts/commit/4f9f76a47693c7b0daac2adf220158284d81e300)
- feat: add getTopCharacters to topClient [`258c928`](https://github.com/tutkli/jikan-ts/commit/258c92859748c15436fc115fc2062faa1dddee36)
- test: update tests [`4b62c5c`](https://github.com/tutkli/jikan-ts/commit/4b62c5cb6432777a58b3ebf36e9b5f607ec19d9a)
- docs: update README.md [`7f93a95`](https://github.com/tutkli/jikan-ts/commit/7f93a958dadd80993833e7c91fd11d5ea22f3f69)
- perf: rename identifiers to pathParams [`932fac1`](https://github.com/tutkli/jikan-ts/commit/932fac1bc07f912b86e1aeb0ca35ab83aab13f3c)
- feat: add random to jikan client [`5a4a03d`](https://github.com/tutkli/jikan-ts/commit/5a4a03d1329ec6b9842571611aaf07181db44b5b)
- perf: remove unnecesary type assertion [`db2bfb0`](https://github.com/tutkli/jikan-ts/commit/db2bfb06327aab0d520d2a4a1b20af40196390d5)
- chore: add bun.lockb to npmignore [`0fa01be`](https://github.com/tutkli/jikan-ts/commit/0fa01be49727278f6ecde167de88ce1f3ae7833a)

#### [v1.2.2](https://github.com/tutkli/jikan-ts/compare/v1.2.1...v1.2.2)

> 6 May 2024
- fix: interface JikanResourcePeriod [`#7`](https://github.com/tutkli/jikan-ts/pull/7)
- lint: run biome linter [`e9f2a64`](https://github.com/tutkli/jikan-ts/commit/e9f2a644cb75dc71d174088dc28e4b9a7da8c633)
- docs: update README.md [`2f0d5b7`](https://github.com/tutkli/jikan-ts/commit/2f0d5b7531b63fd966d28d3ba98635ad46a3623e)
- chore: bump to v1.2.2 [`b692f5a`](https://github.com/tutkli/jikan-ts/commit/b692f5a06be5e231503133b6c2656e7d7f3cf228)
- fix: lintstaged biome command [`d97e0d1`](https://github.com/tutkli/jikan-ts/commit/d97e0d19d9eee09cba8b98dd4e3671609df92181)

#### [v1.2.1](https://github.com/tutkli/jikan-ts/compare/1.2.0...v1.2.1)

> 7 February 2024
- build: replace jest with vitest [`b4344b4`](https://github.com/tutkli/jikan-ts/commit/b4344b44acaf2c2f8ef56cced4928f239dd2a7d5)
- build: replace esbuild and dts bundle generator with tsup [`3e751f5`](https://github.com/tutkli/jikan-ts/commit/3e751f52b0af36629d206ed6db3100d7a512d254)
- chore: remove eslint and prettier [`56aaf46`](https://github.com/tutkli/jikan-ts/commit/56aaf46a3ef7e36fc76907a4ced2e499106d4e6a)
- chore: run biome formatter [`8089432`](https://github.com/tutkli/jikan-ts/commit/8089432fd414cb82f6361ac332f290b0921520e0)
- test: add missing anime client tests, fix errors [`2588723`](https://github.com/tutkli/jikan-ts/commit/258872377531383fac1b161d815198c7ac8524c8)
- chore: add biomejs [`f98c0b1`](https://github.com/tutkli/jikan-ts/commit/f98c0b1ca9bb536ac2cb6b147e5ed55a64e6541f)
- chore: bump to v1.2.1 [`68bb105`](https://github.com/tutkli/jikan-ts/commit/68bb105911e205f65492a78e866fabc1d69c759a)
- fix: remove jest config [`80d031c`](https://github.com/tutkli/jikan-ts/commit/80d031c9e2975deee03ef2a1c5bea45b41bc09e3)
- fix: replaceIdentifiers match function [`abaf4a1`](https://github.com/tutkli/jikan-ts/commit/abaf4a102797b56fdb7ea62e37b879ab4b6f9e9d)
- docs: update README.md [`6728967`](https://github.com/tutkli/jikan-ts/commit/6728967fa78570b934696b50a562617d4051b95d)
- fix: linting errors [`d61544c`](https://github.com/tutkli/jikan-ts/commit/d61544c6a24006c270ae40b4633f5daba5dce0b3)
- fix: tsconfig [`9a9183d`](https://github.com/tutkli/jikan-ts/commit/9a9183dbc96f32b1f3373ccd11078c982c73826d)
- fix: add vitest.config.ts to .npmignore [`64d2b8f`](https://github.com/tutkli/jikan-ts/commit/64d2b8f8d8e38e23a01857521bb2e08816b4ff0c)

#### [1.2.0](https://github.com/tutkli/jikan-ts/compare/v1.0.0...1.2.0)

Expand Down
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

</p>

> Jikan API wrapper for Typescript and NodeJS with build in typings.
> Jikan API wrapper for Typescript and Node.js with built-in typings.
## Features

Expand Down Expand Up @@ -40,10 +40,9 @@ const animeClient = new AnimeClient();

animeClient
.getAnimeById(1)
.then((jikanResponse: JikanResponse<Anime>) => {
.then((response: JikanResponse<Anime>) => {
/* ... */
})
.catch(error => console.error(error));
```

Or, using the **JikanClient**:
Expand All @@ -55,10 +54,9 @@ const jikanClient = new JikanClient();

jikanClient.anime
.getAnimeById(1)
.then((jikanResponse: JikanResponse<Anime>) => {
.then((response: JikanResponse<Anime>) => {
/* ... */
})
.catch(error => console.error(error));
```

## Client configuration
Expand Down Expand Up @@ -100,6 +98,7 @@ const animeClient = new AnimeClient({
- TopClient
- SchedulesClient
- SeasonsClient
- RandomClient
- JikanClient (Main client)

## Leave you feedback
Expand Down
54 changes: 28 additions & 26 deletions biome.json
Original file line number Diff line number Diff line change
@@ -1,28 +1,30 @@
{
"$schema": "https://biomejs.dev/schemas/1.0.0/schema.json",
"organizeImports": {
"enabled": true
},
"linter": {
"enabled": true,
"rules": {
"recommended": true
},
"ignore": ["lib"]
},
"formatter": {
"enabled": true,
"formatWithErrors": true,
"indentStyle": "space",
"indentWidth": 2,
"lineWidth": 80,
"lineEnding": "crlf"
},
"javascript": {
"formatter": {
"quoteStyle": "single",
"bracketSameLine": true,
"bracketSpacing": true
}
}
"$schema": "https://biomejs.dev/schemas/1.7.3/schema.json",
"organizeImports": {
"enabled": true
},
"linter": {
"enabled": true,
"rules": {
"recommended": true
},
"ignore": ["lib"]
},
"formatter": {
"enabled": true,
"formatWithErrors": true,
"indentStyle": "tab",
"indentWidth": 2,
"lineWidth": 80,
"lineEnding": "crlf"
},
"javascript": {
"formatter": {
"quoteStyle": "single",
"semicolons": "asNeeded",
"bracketSpacing": true,
"trailingComma": "none",
"arrowParentheses": "asNeeded"
}
}
}
Binary file added bun.lockb
Binary file not shown.
111 changes: 53 additions & 58 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,60 +1,55 @@
{
"name": "@tutkli/jikan-ts",
"version": "1.2.2",
"description": "Node.js wrapper for the Jikan API with built-in typings.",
"source": "src/index.ts",
"main": "dist/index.js",
"types": "dist/index.d.ts",
"type": "module",
"scripts": {
"prepare": "git config core.hookspath .githooks",
"build": "tsup --config tsup.config.ts",
"prepublishOnly": "yarn run build",
"test:ci": "vitest --silent --run",
"test:coverage": "vitest run --coverage",
"test:dev": "vitest",
"test:ui": "vitest --ui --coverage",
"version": "auto-changelog -p -l false && git add CHANGELOG.md",
"format": "biome format ./src",
"format:fix": "biome format --write ./src",
"lint": "biome check src",
"lint:ci": "biome ci src",
"lint:fix": "biome check --apply-unsafe ./src"
},
"repository": {
"type": "git",
"url": "https://github.com/tutkli/jikan-ts.git"
},
"keywords": [
"jikan",
"jikan-api",
"jikanAPI",
"MyAnimeList"
],
"author": {
"name": "Clara Castillo",
"url": "https://github.com/tutkli"
},
"license": "MIT",
"bugs": {
"url": "https://github.com/tutkli/jikan-ts/issues"
},
"homepage": "https://github.com/tutkli/jikan-ts#readme",
"peerDependencies": {
"axios": "^1.6.7",
"axios-cache-interceptor": "^1.5.1"
},
"devDependencies": {
"@biomejs/biome": "1.5.3",
"@types/node": "20.11.16",
"@vitest/coverage-v8": "^1.2.2",
"@vitest/ui": "^1.2.2",
"auto-changelog": "^2.4.0",
"axios": "^1.6.7",
"axios-cache-interceptor": "^1.5.1",
"lint-staged": "^15.2.2",
"tsup": "^8.0.1",
"typescript": "5.3.3",
"vitest": "^1.2.2"
}
"name": "@tutkli/jikan-ts",
"version": "2.0.0",
"description": "Node.js wrapper for the Jikan API with built-in typings.",
"source": "src/index.ts",
"main": "dist/index.js",
"types": "dist/index.d.ts",
"type": "module",
"scripts": {
"prepare": "git config core.hookspath .githooks",
"build": "tsup --config tsup.config.ts",
"prepublishOnly": "yarn run build",
"test:ci": "vitest --silent --run",
"test:coverage": "vitest run --coverage",
"test:dev": "vitest",
"test:ui": "vitest --ui --coverage",
"version": "auto-changelog -p -l false && git add CHANGELOG.md",
"format": "biome format ./src",
"format:fix": "biome format --write ./src",
"lint": "biome check src",
"lint:ci": "biome ci src",
"lint:fix": "biome check --apply-unsafe ./src"
},
"repository": {
"type": "git",
"url": "https://github.com/tutkli/jikan-ts.git"
},
"keywords": ["jikan", "jikan-api", "jikanAPI", "MyAnimeList"],
"author": {
"name": "Clara Castillo",
"url": "https://github.com/tutkli"
},
"license": "MIT",
"bugs": {
"url": "https://github.com/tutkli/jikan-ts/issues"
},
"homepage": "https://github.com/tutkli/jikan-ts#readme",
"peerDependencies": {
"axios": "^1.6.8",
"axios-cache-interceptor": "^1.5.2"
},
"devDependencies": {
"@biomejs/biome": "1.7.3",
"@types/node": "20.12.10",
"@vitest/coverage-v8": "^1.6.0",
"@vitest/ui": "^1.6.0",
"auto-changelog": "^2.4.0",
"axios": "^1.6.8",
"axios-cache-interceptor": "^1.5.2",
"lint-staged": "^15.2.2",
"tsup": "^8.0.2",
"typescript": "5.4.5",
"vitest": "^1.6.0"
}
}
Loading

0 comments on commit 10cd9fe

Please sign in to comment.