Files
jackwener__opencli/clis/lesswrong/_helpers.ts
jakevin 4fe9a73ebc refactor: migrate adapter imports to package exports (#795)
* refactor: migrate adapter imports to package exports

Replace all relative imports (../../src/registry.js, ../../browser/cdp.js, etc.)
with package exports (@jackwener/opencli/registry, @jackwener/opencli/errors, etc.)
across all 484 adapter files.

This decouples adapter import resolution from directory structure:
- User CLIs in ~/.opencli/clis/ resolve via node_modules symlink
- Internal adapters resolve via Node.js self-referencing
- No more shim files needed for import resolution

Changes:
- package.json: add sub-path exports for all public modules
- clis/**: replace relative imports with @jackwener/opencli/...
- discovery.ts: simplify ensureUserCliCompatShims to symlink-only
- registry-api.ts: export CommandArgs type
- Remove root-level shim directories (browser/, download/, pipeline/)
- Remove shim entries from tsconfig.json include and package.json files

* test: add regression tests for package exports

Prevents regressions like #788/#791 by:
1. Scanning all adapter files for forbidden relative imports
   (../../src/, ../../browser/, etc.) — fails if any remain
2. Verifying every package.json export maps to an existing source file

18 new test cases.

* fix: use junction on Windows + broaden test patterns

- discovery.ts: use 'junction' symlink type on Windows (no admin required)
- package-exports.test.ts: generalize forbidden patterns to catch any
  depth of ../ traversal (not just ../../ and ../../../)

* fix: update stale vi.mock/importActual paths in adapter tests

Test files still used old relative paths for vi.mock() and
vi.importActual() calls. Updated 5 test files to use package exports.
Also broadened regression test patterns to catch mock/importActual paths.

* fix: use rm instead of unlink for symlink cleanup, add warn on failure

Addresses review feedback from Astro-Han:
- rm() handles both symlinks and stale directories (unlink fails on dirs)
- Log a warning when symlink creation fails instead of silent catch

* docs: update import examples to use package exports

Update all documentation, contributing guides, and skills to use
@jackwener/opencli/registry instead of ../../src/registry.js.

Without this, users following the docs would write adapters with
broken imports since the old shim files are no longer created.
2026-04-05 16:02:17 +08:00

99 lines
2.8 KiB
TypeScript

import { CommandExecutionError, EmptyResultError } from '@jackwener/opencli/errors';
export const SITE = 'lesswrong';
export const DOMAIN = 'www.lesswrong.com';
const GRAPHQL_URL = `https://${DOMAIN}/graphql`;
interface GqlResponse {
data?: Record<string, unknown>;
errors?: Array<{ message?: string }>;
}
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- GraphQL responses vary per query
export async function gqlRequest(query: string): Promise<any> {
const resp = await fetch(GRAPHQL_URL, {
method: 'POST',
headers: {
'Content-Type': 'application/json',
Accept: 'application/json',
},
body: JSON.stringify({ query }),
signal: AbortSignal.timeout(15000),
});
if (!resp.ok) {
throw new CommandExecutionError(`LessWrong API returned HTTP ${resp.status}`);
}
const json = (await resp.json()) as GqlResponse;
if (json.errors?.length) {
throw new CommandExecutionError(
json.errors[0]?.message ?? 'Unknown GraphQL error',
);
}
return json.data;
}
export function gqlEscape(str: string): string {
return str.replace(/\\/g, '\\\\').replace(/"/g, '\\"');
}
export function stripHtml(html: string): string {
if (!html) return '';
return html
.replace(/<script[^>]*>.*?<\/script>/gis, ' ')
.replace(/<style[^>]*>.*?<\/style>/gis, ' ')
.replace(/<[^>]+>/g, ' ')
.replace(/\s+/g, ' ')
.trim();
}
export function daysAgo(n: number): string {
const d = new Date();
d.setDate(d.getDate() - n);
return d.toISOString();
}
export async function resolveTagId(
slug: string,
): Promise<{ _id: string; name: string } | null> {
const normalized = gqlEscape(slug.toLowerCase().trim().replace(/\s+/g, '-'));
const query = `query TagBySlug {
tags(input: {terms: {view: "tagBySlug", slug: "${normalized}"}}) {
results { _id name slug }
}
}`;
const data = await gqlRequest(query);
const tag = data?.tags?.results?.[0];
if (!tag?._id || !tag?.name) return null;
return { _id: tag._id as string, name: tag.name as string };
}
export function resolveUserId(slug: string): Promise<{ _id: string; displayName: string }> {
const normalized = gqlEscape(slug.toLowerCase());
const query = `query UserProfile {
user(input: {selector: {slug: "${normalized}"}}) {
result { _id displayName slug }
}
}`;
return gqlRequest(query).then((data) => {
const user = data?.user?.result;
if (!user?._id) {
throw new EmptyResultError(
`lesswrong user ${slug}`,
'Check the username — LessWrong slugs are lowercase (e.g. "zvi", "eliezer-yudkowsky")',
);
}
return { _id: user._id as string, displayName: (user.displayName ?? '') as string };
});
}
export function parsePostId(urlOrId: string): string {
const trimmed = urlOrId.trim();
const match = trimmed.match(/posts\/([a-zA-Z0-9]+)/);
return match ? match[1] : trimmed;
}