Files
jackwener__opencli/clis/weread/notes.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

32 lines
1.1 KiB
TypeScript

import { cli, Strategy } from '@jackwener/opencli/registry';
import type { IPage } from '@jackwener/opencli/types';
import { fetchPrivateApi, formatDate } from './utils.js';
cli({
site: 'weread',
name: 'notes',
description: 'List your notes (thoughts) on a book',
domain: 'weread.qq.com',
strategy: Strategy.COOKIE,
args: [
{ name: 'book-id', positional: true, required: true, help: 'Book ID (from shelf or search results)' },
{ name: 'limit', type: 'int', default: 20, help: 'Max results' },
],
columns: ['chapter', 'text', 'review', 'createTime'],
func: async (page: IPage, args) => {
const data = await fetchPrivateApi(page, '/review/list', {
bookId: args['book-id'],
listType: '11',
mine: '1',
synckey: '0',
});
const items: any[] = data?.reviews ?? [];
return items.slice(0, Number(args.limit)).map((item: any) => ({
chapter: item.review?.chapterName ?? '',
text: item.review?.abstract ?? '',
review: item.review?.content ?? '',
createTime: formatDate(item.review?.createTime),
}));
},
});