diff --git a/.env.example b/.env.example index 33d5331e..02380d65 100644 --- a/.env.example +++ b/.env.example @@ -19,8 +19,8 @@ ADMIN_EMAILS=admin@example.test ABUSE_EMAIL=abuse@example.test # Email-in addresses are pluck+@EMAIL_IN_DOMAIN. SES writes inbound mail to the bucket under inbound/. EMAIL_IN_DOMAIN=in.getpluck.io -# PostHog (optional): the cookie banner, usage after a yes, and error tracking. Unset, nothing is sent anywhere. # The Apple team that signs the iPhone app: serves /.well-known/apple-app-site-association so shared links open the app. # APPLE_TEAM_ID=ABCDE12345 +# PostHog (optional): the cookie banner, usage after a yes, and error tracking. Unset, nothing is sent anywhere. # NEXT_PUBLIC_POSTHOG_KEY=phc_… # POSTHOG_HOST=https://eu.i.posthog.com diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 8dfe8f1f..55b6965d 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -14,4 +14,5 @@ - [ ] Only `packages/db` touches MongoDB, every query is scoped by `userId`, and a new query has a two-user test - [ ] New types start as a Zod schema in `packages/shared-schemas` - [ ] UI copy uses the product words (`GLOSSARY.md`): no "saved", no exclamation marks, no emoji +- [ ] A new string is in all ten languages in `packages/i18n` (CONTRIBUTING.md, "Adding a string") - [ ] A new env var or MCP tool is in `docs/self-host.md` or `docs/mcp.md` in this same PR diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7c61b065..4e26cf46 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,7 +20,7 @@ pnpm stack # MongoDB, Mailpit, MinIO and the fixture pages, on offset pnpm dev # http://127.0.0.1:3000 ``` -Sign in with any address: the link lands in Mailpit at http://127.0.0.1:8035. The extension is in `apps/extension` (`pnpm --filter @pluck/extension dev`), the iPhone app in `apps/ios` (see [docs/ios.md](docs/ios.md)). +Sign in with any address: the email lands in Mailpit at http://127.0.0.1:8035. Run `pnpm --filter @pluck/web worker` in another terminal for imports, files, email-in and the Monday email. The extension is in `apps/extension` (`PLUCK_LOCAL=1 pnpm --filter @pluck/extension dev`, so it talks to your machine), the iPhone app in `apps/ios` (see [docs/ios.md](docs/ios.md)). [docs/architecture.md](docs/architecture.md) is the map of the code. ## The gate @@ -30,7 +30,7 @@ Every pull request passes these, in this order. CI runs them too. pnpm typecheck pnpm lint pnpm test # Vitest; starts the Docker services itself -pnpm e2e # Playwright against a production build +pnpm e2e # Playwright against a production build (once: pnpm exec playwright install chromium) pnpm design # the impeccable detector on every page the e2e run saved ``` @@ -50,6 +50,21 @@ These are the ones a review will ask about. [CLAUDE.md](CLAUDE.md) has the full 8. **Docs move with the code:** a new env var goes in `docs/self-host.md`, a new MCP tool in `docs/mcp.md`, in the same pull request. 9. **No `any`** without a `// why:` comment. +## Words and tone + +Pluck's copy is plain and calm. Use the product words: Pluck (the verb), Plucked (the confirmation), Item, Kind (Read, Watch, PDF, Image, Note, Todo, Thing), Status (Inbox, Later, Archived, Done), Tag, List. Never "saved", "bookmarked", "collection", "smart", "AI-powered" or "magic". No exclamation marks and no emoji, in any language. Say "your AI" or "AI tools", never one vendor as the only option. Copy about expiry says the Item moves "to the Archive" and that "nothing is deleted". + +## Adding a string + +Every string the person sees is in `packages/i18n/messages//.json`, in ten languages, and all ten are complete: `pnpm test` fails if a language is missing a key English has. So a new string goes in all ten files in the same pull request. + +1. Add the English message to `packages/i18n/messages//en.json` (`site`, `app`, `email`, `ios`, `extension` or `share`) and use the key in code. A key English does not have fails `pnpm typecheck`. +2. Add the same key to the other nine files (`es`, `pt-BR`, `fr`, `de`, `ja`, `it`, `nl`, `ko`, `zh-Hans`). Each language's glossary in `docs/i18n/.md` says how the product words are said there. Keep every `{placeholder}` and plural form English has, and only those. +3. For `extension` or `share`, run `node scripts/i18n-sync.mjs` to regenerate the Chrome `_locales` and the iPhone String Catalog. +4. Check it at phone width in German (the longest) and Japanese. + +If you cannot translate, write your best attempt and say so in the pull request; a maintainer checks it. [docs/i18n.md](docs/i18n.md) has the rest. + ## Style - Read the code around your change and write like it: the same comment density, names and idioms. Comments say why, not what. diff --git a/README.md b/README.md index 6c39bc4a..9b901413 100644 --- a/README.md +++ b/README.md @@ -2,33 +2,74 @@ A fast, open-source URL saver with a connector for the AI tool you already use. Pluck anything in one tap, from the iPhone share sheet, the browser, email or a chat with your AI. The page is kept, not just the link. Sort it later, by hand or with your AI. There is no AI inside the app; your AI reads and organises your library through the connector, only when you ask. -- **Web:** `apps/web` (Next.js): the app, the marketing site, the REST API for our own clients, and the MCP connector at `/mcp`. -- **Browser extension:** `apps/extension` (WXT; Chrome, and Firefox builds for self-hosters). -- **iPhone:** `apps/ios` (Expo) with a SwiftUI share extension. -- **Packages:** `packages/db` (the only code that touches MongoDB), `packages/extract` (page, PDF and email reading), `packages/mcp` (the connector's tools, resources and prompts), `packages/mcp-stdio` (`npx @pluck/mcp`), `packages/shared-schemas`, `packages/ui`, `packages/blob`. -- **Infra:** `infra/cdk` (S3 and SES). +Hosted at [getpluck.io](https://getpluck.io), or run your own with `docker compose up` ([docs/self-host.md](docs/self-host.md)). -## Docs +## What is where -- `docs/self-host.md`: run your own with `docker compose up`. -- `docs/mcp.md`: connect an AI tool. -- `docs/ios.md`: the iPhone app and its share extension. -- `docs/deploy.md`: how getpluck.io is deployed. -- `docs/launch-checklist.md`: what is left before launch. -- `docs/design-gaps.md`: screens and copy that still want a designer. +- **Web:** `apps/web` (Next.js 16): the app, the marketing site, the REST API for our own clients, the MCP connector at `/mcp`, and the worker (`apps/web/worker.ts`) that reads pages, sends email and runs the schedule. +- **Browser extension:** `apps/extension` (WXT; Chrome, and Firefox builds for self-hosters). +- **iPhone:** `apps/ios` (Expo) with a SwiftUI share extension. Sign-in is by a 6-digit code; it works offline from the last copy and keeps the newest Items for reading on the go. +- **Packages:** + - `packages/db`: the only code that touches MongoDB. Every query is scoped to one person. + - `packages/extract`: reading pages, PDFs, email and imports. + - `packages/blob`: S3 (MinIO locally). + - `packages/mcp`: the connector's tools, resources and prompts. `packages/mcp-stdio` is `npx @pluck/mcp`. + - `packages/shared-schemas`: every type, as a Zod schema, shared by server and clients. + - `packages/client`: the API client, offline queue and PKCE shared by the iPhone app and the extension. + - `packages/i18n`: the words in ten languages (English, Spanish, Portuguese (Brazil), French, German, Japanese, Italian, Dutch, Korean, Chinese (Simplified)). + - `packages/ui`: design tokens, the logo, the icon and the seven Kind glyphs. +- **Infra:** `infra/cdk` (S3 and SES for getpluck.io). `docker-compose.yml` for self-hosting, `docker-compose.dev.yml` for development. -## Develop +[docs/architecture.md](docs/architecture.md) is the map: how a pluck travels, where the rules live, and where the code could be deeper. -Node 22, pnpm 10, Docker. +## Run it locally + +You need Node 22, pnpm 10 (`corepack enable` picks the pinned version) and Docker. ```sh pnpm install -cp .env.example .env -pnpm stack # MongoDB, Mailpit, MinIO and the fixture pages, on offset ports -pnpm dev # http://127.0.0.1:3000; sign-in links arrive in Mailpit at http://127.0.0.1:8035 +cp .env.example .env # local values only; nothing in it is a real secret +pnpm stack # MongoDB, Mailpit, MinIO and the fixture pages, on offset ports, bound to 127.0.0.1 +pnpm dev # the web app at http://127.0.0.1:3000 ``` -Checks: `pnpm typecheck`, `pnpm lint`, `pnpm test`, `pnpm e2e`, then `pnpm design`. `CLAUDE.md` has the rules of the codebase, and `GLOSSARY.md` the words. +Sign in with any address: the email (a link and a code) lands in Mailpit at http://127.0.0.1:8035. Plucking a single link reads the page at once; imports, uploaded files, email-in and the Monday email need the worker in a second terminal: + +```sh +pnpm --filter @pluck/web worker +``` + +- **Extension:** `PLUCK_LOCAL=1 pnpm --filter @pluck/extension dev` opens Chrome with an extension that talks to your local server. Without `PLUCK_LOCAL=1` it talks to getpluck.io. +- **iPhone:** see [docs/ios.md](docs/ios.md) (needs a Mac with Xcode). +- **AI tools:** connect one to `http://127.0.0.1:3000/mcp`, or try `npx @modelcontextprotocol/inspector`. See [docs/mcp.md](docs/mcp.md). +- `pnpm stack:down` stops the services. Their data stays in Docker volumes. + +## Tests + +The gate, in this order. CI runs the same on every pull request. + +```sh +pnpm typecheck +pnpm lint +pnpm test # Vitest; brings up the Docker services itself +pnpm exec playwright install chromium # once +pnpm e2e # Playwright against a production build on port 3300 +pnpm design # the impeccable design detector on every page the e2e run saved +``` + +Stop `pnpm dev` before `pnpm e2e`: both use `apps/web/.next`. + +## Docs + +- [docs/architecture.md](docs/architecture.md): how the pieces fit, for a newcomer. +- [docs/self-host.md](docs/self-host.md): run your own, and every setting. +- [docs/mcp.md](docs/mcp.md): the connector, its tools and how to connect an AI tool. +- [docs/ios.md](docs/ios.md): the iPhone app, its share extension, offline and TestFlight (`apps/ios/scripts/testflight.sh`). +- [docs/i18n.md](docs/i18n.md): the ten languages and how to add a string. +- [docs/deploy.md](docs/deploy.md): how getpluck.io is deployed (a human step; nothing here deploys itself). +- [docs/design-gaps.md](docs/design-gaps.md): screens and copy that still want a designer. +- [docs/launch-checklist.md](docs/launch-checklist.md): what is left before launch. +- [GLOSSARY.md](GLOSSARY.md): the product words. [CLAUDE.md](CLAUDE.md): the rules of the codebase, for people and coding agents. ## Contributing diff --git a/apps/extension/package.json b/apps/extension/package.json index 0c1ee75e..fce37d86 100644 --- a/apps/extension/package.json +++ b/apps/extension/package.json @@ -1,5 +1,7 @@ { "name": "@pluck/extension", + "description": "The Pluck browser extension: pluck the page you are on, a link, an image or a selection.", + "repository": { "type": "git", "url": "https://github.com/codu-code/pluck.git", "directory": "apps/extension" }, "version": "0.1.0", "private": true, "license": "MIT", diff --git a/apps/ios/package.json b/apps/ios/package.json index 2887cf96..9b187014 100644 --- a/apps/ios/package.json +++ b/apps/ios/package.json @@ -1,5 +1,7 @@ { "name": "@pluck/ios", + "description": "The Pluck iPhone app and its share extension.", + "repository": { "type": "git", "url": "https://github.com/codu-code/pluck.git", "directory": "apps/ios" }, "version": "0.1.0", "private": true, "license": "MIT", diff --git a/apps/web/components/CookieBanner.tsx b/apps/web/components/CookieBanner.tsx index 49406f75..9d566cff 100644 --- a/apps/web/components/CookieBanner.tsx +++ b/apps/web/components/CookieBanner.tsx @@ -3,7 +3,7 @@ import { useTranslations } from "next-intl"; import Link from "next/link"; import { useEffect, useState } from "react"; -import { analyticsOn, CONSENT_EVENT, OPEN_COOKIES_EVENT, readConsent, setConsent, startAnalytics, type Consent } from "@/lib/analytics"; +import { analyticsOn, OPEN_COOKIES_EVENT, readConsent, setConsent, startAnalytics, type Consent } from "@/lib/analytics"; import styles from "./cookie-banner.module.css"; // The Cookies board: asked once a year, two buttons of the same size, nothing pre-ticked. Shown only when this copy @@ -73,18 +73,6 @@ export function CookiesLink({ className, children }: { className?: string; child return ; } -// Reads the answer for screens that show it (Settings), kept current as it changes. -export function useConsent(): Consent | null { - const [c, setC] = useState(null); - useEffect(() => { - const read = () => setC(readConsent()); - read(); - window.addEventListener(CONSENT_EVENT, read); - return () => window.removeEventListener(CONSENT_EVENT, read); - }, []); - return c; -} - // The drawn cookie from the board, with a bite out of it and the logo's three sparks for crumbs. const Cookie = () => (
Five things you plucked and forgot. -Pluck · Monday 06:00 · to niall@codu.co +Pluck · Monday 06:00 · to niall@example.com
diff --git a/docs/handover/design/Extension.dc.html b/docs/handover/design/Extension.dc.html index 7ce858de..10acdcc1 100644 --- a/docs/handover/design/Extension.dc.html +++ b/docs/handover/design/Extension.dc.html @@ -120,7 +120,7 @@
-
Accountniall@codu.coUse an API key instead
+
Accountniall@example.comUse an API key instead
diff --git a/docs/handover/design/IOSSettings.dc.html b/docs/handover/design/IOSSettings.dc.html index e10fd9b3..b3698fc9 100644 --- a/docs/handover/design/IOSSettings.dc.html +++ b/docs/handover/design/IOSSettings.dc.html @@ -23,7 +23,7 @@

Account
-
NMNiall Maherniall@codu.co
+
NMNiall Maherniall@example.com
Handle@niall

diff --git a/docs/handover/design/Settings.dc.html b/docs/handover/design/Settings.dc.html index 37a9b9a1..44d8299b 100644 --- a/docs/handover/design/Settings.dc.html +++ b/docs/handover/design/Settings.dc.html @@ -40,7 +40,7 @@

Settings

-niall@codu.co · signed in with GitHub +niall@example.com · signed in with GitHub
diff --git a/docs/i18n.md b/docs/i18n.md index 53ba7ff2..2b3de98d 100644 --- a/docs/i18n.md +++ b/docs/i18n.md @@ -1,6 +1,6 @@ # Languages -Pluck speaks English, Spanish, Portuguese (Brazil), French, German, Japanese, Italian, Dutch, Korean and Chinese (Simplified). English is the source. Every other language falls back to English key by key, so an untranslated string shows in English, never as a key. +Pluck speaks English, Spanish, Portuguese (Brazil), French, German, Japanese, Italian, Dutch, Korean and Chinese (Simplified). English is the source, and all nine other languages are complete. At run time every other language falls back to English key by key, so a string a newer language has not caught up with shows in English, never as a key. ## Where the words live @@ -33,7 +33,7 @@ Portuguese of any region reads Brazilian Portuguese. Chinese reads Simplified on 1. Add the English message to the right catalog in `packages/i18n/messages//en.json`. 2. Use the key in code. -3. Leave the other languages: they show English until translated. Never put a key in another language that English does not have (the test fails). +3. Add the key to the other nine languages in the same change. All nine are in `COMPLETE` (`packages/i18n/src/i18n.test.ts`), so a missing key fails `pnpm test`. Never put a key in another language that English does not have (that fails too). 4. For `extension` or `share`, run `node scripts/i18n-sync.mjs`. ## Translating diff --git a/docs/ios.md b/docs/ios.md index 3ea9c87a..93302690 100644 --- a/docs/ios.md +++ b/docs/ios.md @@ -38,6 +38,7 @@ Never set `EXPO_PUBLIC_DEMO_KEY` for a build that leaves your machine. 3. Open `ios/Pluck.xcworkspace`. For both targets (Pluck and the share extension) check the team under Signing & Capabilities, and check the App Group `group.io.getpluck.app`, the Keychain group and Associated Domains (`applinks:getpluck.io`) are there. Set `APPLE_TEAM_ID` in Vercel (docs/deploy.md) so shared links open the app. 4. Each upload needs a new build number: raise `ios.buildNumber` in `apps/ios/app.config.ts` (a clean prebuild resets anything set in Xcode) and prebuild again. The marketing version is `version` beside it. Then Product, Archive, and Distribute App, App Store Connect, Upload. 5. In App Store Connect, the build appears under TestFlight after processing (about 15 minutes). Answer the export compliance question (no non-exempt encryption; `ITSAppUsesNonExemptEncryption` is false already), add testers. +6. App Privacy (App Store Connect, before external testing or review). The privacy manifests already say the same (`ios.privacyManifests` in `app.config.ts` for the app, `targets/share/PrivacyInfo.xcprivacy` for the share extension), so keep the three in step: Contact info, email (account, linked); User content, photos or videos (images shared to Pluck, linked, app functionality); User content, other (what you pluck, linked, app functionality); Identifiers, user ID (the account, linked, app functionality and analytics, the analytics part only after the in-app yes); Usage data, product interaction (analytics, linked, only after the in-app yes); Diagnostics, crash data (app functionality, not linked). These six are what App Store Connect declares. No tracking in Apple's sense: nothing is shared with data brokers or used across other companies' apps. From the command line instead of steps 2 to 4: create an App Store Connect API key (Users and Access, Integrations, App Store Connect API, a Team key with the App Manager role), keep the `.p8` somewhere outside the repo, raise `ios.buildNumber`, then: @@ -46,8 +47,7 @@ APPLE_TEAM_ID= ASC_KEY_ID= ASC_ISSUER_ID= ASC_KEY_PA apps/ios/scripts/testflight.sh ``` -It prebuilds, archives, signs and uploads with the key, so Xcode needs no account sign-in. Step 5 still applies. -6. App Privacy (App Store Connect, before external testing or review). The privacy manifests already say the same (`ios.privacyManifests` in `app.config.ts` for the app, `targets/share/PrivacyInfo.xcprivacy` for the share extension), so keep the three in step: Contact info, email (account, linked); User content, photos or videos (images shared to Pluck, linked, app functionality); User content, other (what you pluck, linked, app functionality); Identifiers, user ID (the account, linked, app functionality and analytics, the analytics part only after the in-app yes); Usage data, product interaction (analytics, linked, only after the in-app yes); Diagnostics, crash data (app functionality, not linked). These six are what App Store Connect declares. No tracking in Apple's sense: nothing is shared with data brokers or used across other companies' apps. +It prebuilds, archives, signs and uploads with the key, so Xcode needs no account sign-in. Steps 5 and 6 still apply. ## Usage and crash reports @@ -61,7 +61,8 @@ It prebuilds, archives, signs and uploads with the key, so Xcode needs no accoun - **Offline:** the TanStack Query cache is persisted (SQLite key-value), so the app opens on what it last saw; plucks made with no connection queue on the phone. `expo-network` tells TanStack Query when the connection goes, so queries wait instead of failing and pick up when it is back (plucks go up then too). With no connection the tab bar shows a clay "Offline" pill, which takes the waiting count when there is one ("Offline · 2 waiting"). An Item whose text is not on the phone opens to "Not on this iPhone yet.", not an error. - **Keep for offline reading** (Settings, Library; on by default): on Wi-Fi only, when the app opens or comes back, at most every 15 minutes, the app keeps the text of the newest 300 Items across Inbox, Later and Lists (`lib/keep.ts` picks them; images, pages still being plucked and pages that could not be read are left out), and the Lists themselves. Text and highlights only, never pictures. Each Item is one key in SQLite (`kept:`), beside the query cache rather than in it, since the cache is written whole on every change. Only new or changed Items are fetched, one at a time with a pause, well under the API's read limit. Turning it off, "Clear the offline copy" and signing out delete the kept copies. Languages need nothing: every catalog is bundled into the app. - **Files** (images, PDFs) from the share sheet: `POST /api/v1/items/files` makes the item and returns a signed upload URL; a background `URLSession` uploads the bytes after the sheet closes, and the worker reads them once they arrive. -- **Pure modules** (`lib/api.ts`, `lib/queue.ts`, `lib/pkce.ts`, `lib/markdown.ts`, `lib/keep.ts`) have no Expo imports and are tested by the root `pnpm test` (`apps/ios/lib/core.test.ts`, `apps/ios/lib/keep.test.ts`). +- **Shared with the extension:** the API client, the offline queue and PKCE live in `packages/client` (`createClient`, `createQueue`, `pkcePair`), tested by `packages/client/src/client.test.ts`. +- **Pure modules** (`lib/markdown.ts`, `lib/keep.ts`, `lib/format.ts`, `lib/plurals.ts`) have no Expo imports and are tested by the root `pnpm test` (`apps/ios/lib/*.test.ts`). ## Checked automatically diff --git a/docs/self-host.md b/docs/self-host.md index 5b5be164..f96a0ffc 100644 --- a/docs/self-host.md +++ b/docs/self-host.md @@ -5,7 +5,7 @@ Pluck runs as one Docker image (the web app, and the same image again as the wor ## Try it ```sh -git clone pluck && cd pluck +git clone https://github.com/codu-code/pluck && cd pluck docker compose up -d ``` diff --git a/infra/cdk/package.json b/infra/cdk/package.json index 12fa2573..2a96d014 100644 --- a/infra/cdk/package.json +++ b/infra/cdk/package.json @@ -1,5 +1,7 @@ { "name": "@pluck/cdk", + "description": "AWS CDK stacks for getpluck.io: S3, SES and alerts.", + "repository": { "type": "git", "url": "https://github.com/codu-code/pluck.git", "directory": "infra/cdk" }, "version": "0.0.0", "private": true, "license": "AGPL-3.0-only", diff --git a/package.json b/package.json index f972ee6f..ccb5e751 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,8 @@ { "name": "pluck", + "description": "Pluck: a fast, open-source URL saver with an MCP connector for the AI tool you already use.", + "repository": { "type": "git", "url": "https://github.com/codu-code/pluck.git" }, + "license": "AGPL-3.0-only", "private": true, "type": "module", "packageManager": "pnpm@10.34.8", diff --git a/packages/blob/package.json b/packages/blob/package.json index 77a12517..c0fc73ee 100644 --- a/packages/blob/package.json +++ b/packages/blob/package.json @@ -1,5 +1,7 @@ { "name": "@pluck/blob", + "description": "Blob storage for Pluck over the S3 API (S3, or MinIO locally and for self-hosting).", + "repository": { "type": "git", "url": "https://github.com/codu-code/pluck.git", "directory": "packages/blob" }, "version": "0.0.0", "private": true, "license": "AGPL-3.0-only", diff --git a/packages/client/package.json b/packages/client/package.json index 7af126bc..d33a4e2a 100644 --- a/packages/client/package.json +++ b/packages/client/package.json @@ -1,5 +1,7 @@ { "name": "@pluck/client", + "description": "The API client, offline queue and PKCE shared by the Pluck iPhone app and browser extension.", + "repository": { "type": "git", "url": "https://github.com/codu-code/pluck.git", "directory": "packages/client" }, "version": "0.0.0", "private": true, "license": "MIT", diff --git a/packages/db/package.json b/packages/db/package.json index c40c297b..ed96988a 100644 --- a/packages/db/package.json +++ b/packages/db/package.json @@ -1,5 +1,7 @@ { "name": "@pluck/db", + "description": "Every MongoDB collection and query in Pluck, each scoped to one person.", + "repository": { "type": "git", "url": "https://github.com/codu-code/pluck.git", "directory": "packages/db" }, "version": "0.0.0", "private": true, "license": "AGPL-3.0-only", diff --git a/packages/extract/package.json b/packages/extract/package.json index 903b8e8f..b93b3afb 100644 --- a/packages/extract/package.json +++ b/packages/extract/package.json @@ -1,5 +1,7 @@ { "name": "@pluck/extract", + "description": "Reads pages, PDFs, email and imports into the text Pluck keeps.", + "repository": { "type": "git", "url": "https://github.com/codu-code/pluck.git", "directory": "packages/extract" }, "version": "0.0.0", "private": true, "license": "AGPL-3.0-only", diff --git a/packages/i18n/package.json b/packages/i18n/package.json index 66d3a78c..369d2dd0 100644 --- a/packages/i18n/package.json +++ b/packages/i18n/package.json @@ -1,5 +1,7 @@ { "name": "@pluck/i18n", + "description": "Pluck's words in ten languages, one catalog per surface.", + "repository": { "type": "git", "url": "https://github.com/codu-code/pluck.git", "directory": "packages/i18n" }, "version": "0.0.0", "private": true, "license": "MIT", diff --git a/packages/mcp-stdio/package.json b/packages/mcp-stdio/package.json index 6681110e..0d37b34d 100644 --- a/packages/mcp-stdio/package.json +++ b/packages/mcp-stdio/package.json @@ -1,5 +1,6 @@ { "name": "@pluck/mcp", + "repository": { "type": "git", "url": "https://github.com/codu-code/pluck.git", "directory": "packages/mcp-stdio" }, "version": "0.1.0", "description": "Use your Pluck library from any MCP client that speaks stdio, with an API key.", "license": "MIT", diff --git a/packages/mcp/package.json b/packages/mcp/package.json index 4567ce5e..0e2307ad 100644 --- a/packages/mcp/package.json +++ b/packages/mcp/package.json @@ -1,5 +1,7 @@ { "name": "@pluck/mcp-server", + "description": "The Pluck connector: MCP tools, resources and prompts over a person's library.", + "repository": { "type": "git", "url": "https://github.com/codu-code/pluck.git", "directory": "packages/mcp" }, "version": "0.0.0", "private": true, "license": "AGPL-3.0-only", diff --git a/packages/shared-schemas/package.json b/packages/shared-schemas/package.json index 500fea97..9511d448 100644 --- a/packages/shared-schemas/package.json +++ b/packages/shared-schemas/package.json @@ -1,5 +1,7 @@ { "name": "@pluck/shared-schemas", + "description": "Zod schemas for every Pluck type, shared by the server and every client.", + "repository": { "type": "git", "url": "https://github.com/codu-code/pluck.git", "directory": "packages/shared-schemas" }, "version": "0.0.0", "private": true, "license": "MIT", diff --git a/packages/shared-schemas/src/items.ts b/packages/shared-schemas/src/items.ts index 0a156a36..9cfc1a28 100644 --- a/packages/shared-schemas/src/items.ts +++ b/packages/shared-schemas/src/items.ts @@ -72,7 +72,6 @@ export const PluckResponse = z.object({ }); export type PluckResponse = z.infer; -// Tags join in slice 5. export const UpdateItemBody = z .object({ title: z.string().max(500).optional(), // "" goes back to the derived title diff --git a/packages/ui/package.json b/packages/ui/package.json index be076d32..f4e0cb6e 100644 --- a/packages/ui/package.json +++ b/packages/ui/package.json @@ -1,5 +1,7 @@ { "name": "@pluck/ui", + "description": "Pluck's design tokens, logo, icon and Kind glyphs.", + "repository": { "type": "git", "url": "https://github.com/codu-code/pluck.git", "directory": "packages/ui" }, "version": "0.0.0", "private": true, "license": "MIT",