协作头脑风暴
brainstorming
在实现前澄清需求、探索设计选择,并形成清晰的开发方向。
intercom-local-dev-loop【开发与工程】Configure Intercom local development with testing, mocking, and hot reload. Use when setting up a development environment, writing tests against the Intercom API, or establishing a fast iteration cycle against a dev workspace. Trigger with phrases like "intercom dev setup", "intercom local development", "intercom dev environment", "develop with inter…
独立 GitHub 快照 · 自动分类 · 以原作者文档为准
name: intercom-local-dev-loop description: | Configure Intercom local development with testing, mocking, and hot reload. Use when setting up a development environment, writing tests against the Intercom API, or establishing a fast iteration cycle against a dev workspace. Trigger with phrases like "intercom dev setup", "intercom local development", "intercom dev environment", "develop with intercom", "test intercom locally". allowed-tools: Read, Write, Edit, Bash(npm:), Bash(npx:) version: 1.6.0 license: MIT author: Jeremy Longshore jeremy@intentsolutions.io tags:
Set up a fast local development workflow for Intercom integrations with proper test isolation, mocking strategies, and webhook tunneling. The loop has two lanes: a mocked unit lane that runs offline with no token, and an integration lane that talks to a real dev workspace and is skipped automatically when no token is present.
intercom-install-auth setupThe client authenticates with a single Intercom bearer access token, issued per
workspace by the intercom-install-auth step. Read it from
process.env.INTERCOM_ACCESS_TOKEN (loaded from git-ignored .env.development);
never hardcode it. The mocked unit lane needs no token at all — pointing the loop
at a different dev workspace is only a matter of swapping the .env.development
value.
Work through these steps to stand up the loop. The full, copy-paste-ready code for every step lives in the implementation walkthrough.
Scaffold the project structure — an src/intercom/ module (singleton
client.ts, plus contacts.ts / conversations.ts / types.ts), a tests/
tree with a mocks/ factory, and three env files (.env.example committed,
.env.development and .env.test git-ignored). Use Write to create each
file. See implementation.md.
Configure environments — commit .env.example as the template and keep
real tokens in the git-ignored .env.development. See
implementation.md.
Write an environment-aware client singleton that reads the token, throws a
clear error when it is missing, and exposes a resetClient() for tests. The
skeleton:
// src/intercom/client.ts
import { IntercomClient } from "intercom-client";
let instance: IntercomClient | null = null;
export function getClient(): IntercomClient {
if (!instance) {
const token = process.env.INTERCOM_ACCESS_TOKEN;
if (!token) {
throw new Error(
"INTERCOM_ACCESS_TOKEN not set. Copy .env.example to .env.development"
);
}
instance = new IntercomClient({ token });
}
return instance;
}
export function resetClient(): void {
instance = null;
}
Build a mock client factory (tests/mocks/intercom.ts) covering contacts,
conversations, messages, admins, and tags with vi.fn() resolved values, so
the unit lane never touches the network. Full factory in
implementation.md.
Write mocked unit tests against the factory, asserting call arguments and returned shapes. See implementation.md.
Tunnel webhooks with ngrok — run the local server, ngrok http 3000, and
register the HTTPS URL in Intercom Developer Hub. Use Bash(npx:*) for
ngrok. See implementation.md.
Wire package scripts (dev, test, test:watch, test:integration,
typecheck) — use Edit to add them to package.json, then drive the loop
with Bash(npm:*). See implementation.md.
Following this skill produces a working local Intercom development loop:
src/intercom/ client module and tests/ tree with a reusable
mock factory..env.example template plus git-ignored
.env.development / .env.test.npm run test / test:watch) that runs with
no token and no network.npm run test:integration) that is skipped
automatically when INTERCOM_ACCESS_TOKEN is absent.| Error | Cause | Solution |
|---|---|---|
INTERCOM_ACCESS_TOKEN not set | Missing .env file | Copy .env.example to .env.development |
| Port 3000 in use | Another process | lsof -i :3000 and kill, or change port |
| ngrok tunnel expired | Free tier 2h limit | Restart ngrok or use paid plan |
| Mock type mismatch | SDK updated | Regenerate mocks from SDK types |
rate_limit_exceeded in dev | Dev workspace limits | Add delays between integration tests |
A minimal mocked unit test (from implementation.md):
it("should create a user contact", async () => {
const contact = await mockClient.contacts.create({
role: "user",
externalId: "user-123",
email: "test@example.com",
});
expect(contact.id).toBe("mock-contact-id");
expect(mockClient.contacts.create).toHaveBeenCalledOnce();
});
For the token-gated integration test pattern (describe.skipIf, live create +
cleanup) and the commands that drive each lane, see
the examples reference.
intercom-sdk-patterns for production-ready code patterns.