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

56 lines
1.5 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: 'read',
description: 'Read full post by URL or ID',
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',
},
],
columns: ['title', 'author', 'karma', 'comments', 'tags', 'content', 'url'],
func: async (_page, kwargs) => {
const postId = parsePostId(String(kwargs['url-or-id']));
const query = `query PostsSingle {
post(input: {selector: {documentId: "${gqlEscape(postId)}"}}) {
result { _id title user { displayName } baseScore commentCount htmlBody slug postedAt tags { name } }
}
}`;
const data = await gqlRequest(query);
const post = data?.post?.result;
if (!post?._id) {
throw new EmptyResultError('lesswrong read', `Post "${postId}" not found`);
}
return [
{
title: post.title ?? '',
author: post.user?.displayName ?? 'Unknown',
karma: post.baseScore ?? 0,
comments: post.commentCount ?? 0,
tags: (post.tags ?? []).map((tag: { name?: string }) => tag.name ?? '').filter(Boolean).join(', '),
content: stripHtml(post.htmlBody ?? ''),
url: `https://${DOMAIN}/posts/${post._id}/${post.slug}`,
},
];
},
});