Files
jackwener__opencli/clis/lesswrong/comments.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

79 lines
2.2 KiB
TypeScript

import { cli, Strategy } from '@jackwener/opencli/registry';
import { EmptyResultError } from '@jackwener/opencli/errors';
import {
DOMAIN,
SITE,
gqlEscape,
gqlRequest,
parsePostId,
stripHtml,
} from './_helpers.js';
cli({
site: SITE,
name: 'comments',
description: 'Top comments on a post',
domain: DOMAIN,
strategy: Strategy.PUBLIC,
browser: false,
args: [
{
name: 'url-or-id',
type: 'string',
required: true,
positional: true,
help: 'Post URL or LessWrong post ID',
},
{ name: 'limit', type: 'int', default: 5, help: 'Number of comments' },
],
columns: ['rank', 'score', 'author', 'text'],
func: async (_page, kwargs) => {
const postId = gqlEscape(parsePostId(String(kwargs['url-or-id'])));
const limit = Number(kwargs.limit ?? 5);
// Fetch post title and comments in parallel
const [postData, commentsData] = await Promise.all([
gqlRequest(`query PostTitle {
post(input: {selector: {documentId: "${postId}"}}) {
result { _id title slug }
}
}`),
gqlRequest(`query Comments {
comments(input: {terms: {view: "postCommentsTop", postId: "${postId}", limit: ${limit}}}) {
results { _id user { displayName } baseScore htmlBody postedAt }
}
}`),
]);
const post = postData?.post?.result;
if (!post?._id) {
throw new EmptyResultError('lesswrong comments', `Post "${postId}" not found`);
}
const comments = (commentsData?.comments?.results ?? []) as Array<Record<string, unknown>>;
const rows: Array<Record<string, unknown>> = [];
// First row: post context
rows.push({
rank: '',
score: '',
author: '',
text: `Comments on: ${post.title ?? 'Untitled'} (https://${DOMAIN}/posts/${post._id}/${post.slug})`,
});
for (let i = 0; i < comments.length; i++) {
const item = comments[i];
const user = item.user as { displayName?: string } | undefined;
const raw = stripHtml((item.htmlBody as string) ?? '');
rows.push({
rank: i + 1,
score: (item.baseScore as number) ?? 0,
author: user?.displayName ?? 'Unknown',
text: raw.length > 500 ? `${raw.slice(0, 500)}...` : raw,
});
}
return rows;
},
});