From d343e1f649551cbc905e9249124ed6c1e3f8cdaa Mon Sep 17 00:00:00 2001 From: Dominik Biedebach Date: Sat, 30 Nov 2024 06:45:10 +0100 Subject: [PATCH 1/4] chore: add nano-staged for linting and formatting on commits --- package.json | 44 ++++++++++++++++++++++++-------------------- pnpm-lock.yaml | 12 ++++++++++++ 2 files changed, 36 insertions(+), 20 deletions(-) diff --git a/package.json b/package.json index ef1add3..d647086 100644 --- a/package.json +++ b/package.json @@ -1,20 +1,24 @@ -{ - "name": "tsky-workspace", - "type": "module", - "version": "0.1.0", - "packageManager": "pnpm@9.14.2", - "license": "MIT", - "homepage": "https://tsky.dev/", - "repository": { - "type": "git", - "url": "git+https://github.com/tsky-dev/tsky.git" - }, - "scripts": { - "format": "biome check --write .", - "lint": "pnpm --filter tsky run lint", - "lint:fix": "pnpm --filter tsky run lint:fix" - }, - "devDependencies": { - "@biomejs/biome": "^1.9.4" - } -} +{ + "name": "tsky-workspace", + "type": "module", + "version": "0.1.0", + "packageManager": "pnpm@9.14.2", + "license": "MIT", + "homepage": "https://tsky.dev/", + "repository": { + "type": "git", + "url": "git+https://github.com/tsky-dev/tsky.git" + }, + "scripts": { + "format": "biome check --write .", + "lint": "pnpm --filter tsky run lint", + "lint:fix": "pnpm --filter tsky run lint:fix" + }, + "devDependencies": { + "@biomejs/biome": "^1.9.4", + "nano-staged": "^0.8.0" + }, + "nano-staged": { + "*.{js,ts,cjs,mjs}": "pnpm run format && pnpm run lint:fix" + } +} diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 49ef604..bd03169 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -11,6 +11,9 @@ importers: '@biomejs/biome': specifier: ^1.9.4 version: 1.9.4 + nano-staged: + specifier: ^0.8.0 + version: 0.8.0 docs: devDependencies: @@ -2071,6 +2074,11 @@ packages: multiformats@9.9.0: resolution: {integrity: sha512-HoMUjhH9T8DDBNT+6xzkrd9ga/XiBI4xLr58LJACwK6G3HTOPeMz4nB4KJs33L2BelrIJa7P0VuNaVF3hMYfjg==} + nano-staged@0.8.0: + resolution: {integrity: sha512-QSEqPGTCJbkHU2yLvfY6huqYPjdBrOaTMKatO1F8nCSrkQGXeKwtCiCnsdxnuMhbg3DTVywKaeWLGCE5oJpq0g==} + engines: {node: ^12.20.0 || ^14.13.1 || >=16.0.0} + hasBin: true + nanoid@3.3.8: resolution: {integrity: sha512-WNLf5Sd8oZxOm+TzppcYk8gVOgP+l58xNy58D0nbUnOxOWRWvlcCV4kUF7ltmI6PsrLl/BgKEyS4mqsGChFN0w==} engines: {node: ^10 || ^12 || ^13.7 || ^14 || >=15.0.1} @@ -5024,6 +5032,10 @@ snapshots: multiformats@9.9.0: {} + nano-staged@0.8.0: + dependencies: + picocolors: 1.1.1 + nanoid@3.3.8: {} natural-compare@1.4.0: {} From d69134010c66959968d199ef8b7b4ae31dc3235a Mon Sep 17 00:00:00 2001 From: Dominik Biedebach Date: Sat, 30 Nov 2024 07:00:16 +0100 Subject: [PATCH 2/4] chore: added linting on root level & added nano-staged for staged file linting --- .eslintignore | 5 ++ docs/api.md | 8 +-- docs/examples.md | 2 +- docs/getting-started.md | 10 ++-- docs/index.md | 1 - .../eslint.config.mjs => eslint.config.mjs | 0 package.json | 55 +++++++++++-------- packages/core/package.json | 9 +-- packages/core/src/post.ts | 38 ++++++------- pnpm-lock.yaml | 42 +++++++------- pnpm-workspace.yaml | 1 - 11 files changed, 86 insertions(+), 85 deletions(-) create mode 100644 .eslintignore rename packages/core/eslint.config.mjs => eslint.config.mjs (100%) diff --git a/.eslintignore b/.eslintignore new file mode 100644 index 0000000..97178c3 --- /dev/null +++ b/.eslintignore @@ -0,0 +1,5 @@ +node_modules +dist + +**/node_modules +**/dist \ No newline at end of file diff --git a/docs/api.md b/docs/api.md index b4fb290..0262c15 100644 --- a/docs/api.md +++ b/docs/api.md @@ -13,8 +13,8 @@ Create a new Tsky instance. ```ts import { Tsky } from 'tsky' -const app = new AppBskyNS(); // TODO -const tsky = new Tsky(app); +const app = new AppBskyNS() // TODO +const tsky = new Tsky(app) ``` ### `tsky.profile(did: string): Promise` @@ -22,7 +22,7 @@ const tsky = new Tsky(app); Get a profile by DID. ```ts -const profile = await tsky.profile('did:plc:giohuovwawlijq7jkuysq5dd'); +const profile = await tsky.profile('did:plc:giohuovwawlijq7jkuysq5dd') -console.log(profile.handle); +console.log(profile.handle) ``` diff --git a/docs/examples.md b/docs/examples.md index 02ea2e7..7045f03 100644 --- a/docs/examples.md +++ b/docs/examples.md @@ -4,4 +4,4 @@ outline: deep # Examples -TODO: Add examples here \ No newline at end of file +TODO: Add examples here diff --git a/docs/getting-started.md b/docs/getting-started.md index 06a291a..e8c59a7 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -26,17 +26,15 @@ $ bun add -D tsky ::: - ## Usage ```ts import { Tsky } from 'tsky' +const app = new AppBskyNS() // TODO +const tsky = new Tsky(app) -const app = new AppBskyNS(); // TODO -const tsky = new Tsky(app); - -const profile = await tsky.profile('did:plc:giohuovwawlijq7jkuysq5dd'); +const profile = await tsky.profile('did:plc:giohuovwawlijq7jkuysq5dd') -console.log(profile.handle); +console.log(profile.handle) ``` diff --git a/docs/index.md b/docs/index.md index 6e37cf5..bcbaa07 100644 --- a/docs/index.md +++ b/docs/index.md @@ -28,4 +28,3 @@ features: icon: ☁️ details: Like a walk on the clouds --- - diff --git a/packages/core/eslint.config.mjs b/eslint.config.mjs similarity index 100% rename from packages/core/eslint.config.mjs rename to eslint.config.mjs diff --git a/package.json b/package.json index d647086..e36e6f8 100644 --- a/package.json +++ b/package.json @@ -1,24 +1,31 @@ -{ - "name": "tsky-workspace", - "type": "module", - "version": "0.1.0", - "packageManager": "pnpm@9.14.2", - "license": "MIT", - "homepage": "https://tsky.dev/", - "repository": { - "type": "git", - "url": "git+https://github.com/tsky-dev/tsky.git" - }, - "scripts": { - "format": "biome check --write .", - "lint": "pnpm --filter tsky run lint", - "lint:fix": "pnpm --filter tsky run lint:fix" - }, - "devDependencies": { - "@biomejs/biome": "^1.9.4", - "nano-staged": "^0.8.0" - }, - "nano-staged": { - "*.{js,ts,cjs,mjs}": "pnpm run format && pnpm run lint:fix" - } -} +{ + "name": "tsky-workspace", + "type": "module", + "version": "0.1.0", + "packageManager": "pnpm@9.14.2", + "license": "MIT", + "homepage": "https://tsky.dev/", + "repository": { + "type": "git", + "url": "git+https://github.com/tsky-dev/tsky.git" + }, + "scripts": { + "format": "biome check --write .", + "lint": "eslint ./packages ./docs", + "lint:fix": "eslint . --fix" + }, + "devDependencies": { + "@antfu/eslint-config": "^3.11.2", + "@biomejs/biome": "^1.9.4", + "@eslint/js": "^9.15.0", + "eslint": "^8.57.1", + "eslint-plugin-import": "^2.25.2", + "eslint-plugin-n": "^15.0.0 || ^16.0.0 ", + "eslint-plugin-promise": "^6.0.0", + "nano-staged": "^0.8.0", + "typescript-eslint": "^8.16.0" + }, + "nano-staged": { + "*.{js,ts,cjs,mjs}": ["biome check --write --", "eslint --fix --"] + } +} diff --git a/packages/core/package.json b/packages/core/package.json index 5b43f9a..932cb1b 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -7,16 +7,9 @@ "lint:fix": "eslint ./src --fix" }, "devDependencies": { - "@antfu/eslint-config": "^3.11.2", "@atproto/api": "^0.13.18", - "@eslint/js": "^9.15.0", - "eslint": "^8.57.1", - "eslint-plugin-import": "^2.25.2", - "eslint-plugin-n": "^15.0.0 || ^16.0.0 ", - "eslint-plugin-promise": "^6.0.0", "globals": "^15.12.0", "tsx": "^4.19.2", - "typescript": "^5.7.2", - "typescript-eslint": "^8.16.0" + "typescript": "^5.7.2" } } diff --git a/packages/core/src/post.ts b/packages/core/src/post.ts index ac510c9..bbbd66c 100644 --- a/packages/core/src/post.ts +++ b/packages/core/src/post.ts @@ -1,13 +1,13 @@ import type { AppBskyFeedGetLikes, - AppBskyFeedGetPosts, AppBskyFeedGetPostThread, + AppBskyFeedGetPosts, AppBskyFeedGetQuotes, AppBskyFeedGetRepostedBy, AppBskyFeedSearchPosts, AppBskyNS, -} from '@atproto/api' -import { Paginator } from './paginate' +} from '@atproto/api'; +import { Paginator } from './paginate'; export class Post { constructor(private instance: AppBskyNS) {} @@ -19,9 +19,9 @@ export class Post { params: AppBskyFeedGetPostThread.QueryParams, options?: AppBskyFeedGetPostThread.CallOptions, ) { - const res = await this.instance.feed.getPostThread(params, options) + const res = await this.instance.feed.getPostThread(params, options); - return res.data + return res.data; } /** @@ -35,10 +35,10 @@ export class Post { const res = await this.instance.feed.getLikes( { cursor, ...params }, options, - ) + ); - return res.data - }) + return res.data; + }); } /** @@ -52,10 +52,10 @@ export class Post { const res = await this.instance.feed.getQuotes( { cursor, ...params }, options, - ) + ); - return res.data - }) + return res.data; + }); } /** @@ -69,10 +69,10 @@ export class Post { const res = await this.instance.feed.getRepostedBy( { cursor, ...params }, options, - ) + ); - return res.data - }) + return res.data; + }); } /** @@ -87,10 +87,10 @@ export class Post { const res = await instance.feed.searchPosts( { cursor, ...params }, options, - ) + ); - return res.data - }) + return res.data; + }); } /** @@ -101,8 +101,8 @@ export class Post { posts: string[], options?: AppBskyFeedGetPosts.CallOptions, ) { - const res = await instance.feed.getPosts({ uris: posts }, options) + const res = await instance.feed.getPosts({ uris: posts }, options); - return res.data.posts + return res.data.posts; } } diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index bd03169..3155e3e 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -7,28 +7,13 @@ settings: importers: .: - devDependencies: - '@biomejs/biome': - specifier: ^1.9.4 - version: 1.9.4 - nano-staged: - specifier: ^0.8.0 - version: 0.8.0 - - docs: - devDependencies: - vitepress: - specifier: ^1.5.0 - version: 1.5.0(@algolia/client-search@5.15.0)(postcss@8.4.49)(search-insights@2.17.3)(typescript@5.7.2) - - packages/core: devDependencies: '@antfu/eslint-config': specifier: ^3.11.2 version: 3.11.2(@typescript-eslint/utils@8.16.0(eslint@8.57.1)(typescript@5.7.2))(@vue/compiler-sfc@3.5.13)(eslint@8.57.1)(typescript@5.7.2) - '@atproto/api': - specifier: ^0.13.18 - version: 0.13.18 + '@biomejs/biome': + specifier: ^1.9.4 + version: 1.9.4 '@eslint/js': specifier: ^9.15.0 version: 9.15.0 @@ -44,6 +29,24 @@ importers: eslint-plugin-promise: specifier: ^6.0.0 version: 6.6.0(eslint@8.57.1) + nano-staged: + specifier: ^0.8.0 + version: 0.8.0 + typescript-eslint: + specifier: ^8.16.0 + version: 8.16.0(eslint@8.57.1)(typescript@5.7.2) + + docs: + devDependencies: + vitepress: + specifier: ^1.5.0 + version: 1.5.0(@algolia/client-search@5.15.0)(postcss@8.4.49)(search-insights@2.17.3)(typescript@5.7.2) + + packages/core: + devDependencies: + '@atproto/api': + specifier: ^0.13.18 + version: 0.13.18 globals: specifier: ^15.12.0 version: 15.12.0 @@ -53,9 +56,6 @@ importers: typescript: specifier: ^5.7.2 version: 5.7.2 - typescript-eslint: - specifier: ^8.16.0 - version: 8.16.0(eslint@8.57.1)(typescript@5.7.2) packages: diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml index 4667dcd..94ac265 100644 --- a/pnpm-workspace.yaml +++ b/pnpm-workspace.yaml @@ -1,4 +1,3 @@ packages: - packages/* - docs/ - From 114ef9e53fcd72b348fb1665ef8d103dbcbf3b0a Mon Sep 17 00:00:00 2001 From: Dominik Biedebach Date: Sat, 30 Nov 2024 07:03:59 +0100 Subject: [PATCH 3/4] chore: remove eslint for now --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index e36e6f8..2af9284 100644 --- a/package.json +++ b/package.json @@ -26,6 +26,6 @@ "typescript-eslint": "^8.16.0" }, "nano-staged": { - "*.{js,ts,cjs,mjs}": ["biome check --write --", "eslint --fix --"] + "*.{js,ts,cjs,mjs}": ["biome check --write --"] } } From db17accfbc6b9bc6ee9420a1a3741a55ea6ef3e0 Mon Sep 17 00:00:00 2001 From: Dominik Biedebach Date: Sat, 30 Nov 2024 07:05:57 +0100 Subject: [PATCH 4/4] chore: add biome check task --- package.json | 1 + 1 file changed, 1 insertion(+) diff --git a/package.json b/package.json index 2af9284..7a73bf3 100644 --- a/package.json +++ b/package.json @@ -10,6 +10,7 @@ "url": "git+https://github.com/tsky-dev/tsky.git" }, "scripts": { + "check": "biome check", "format": "biome check --write .", "lint": "eslint ./packages ./docs", "lint:fix": "eslint . --fix"