Files
jackwener__opencli/clis/wikipedia/utils.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

52 lines
1.6 KiB
TypeScript

/**
* Wikipedia adapter utilities.
*
* Uses the public MediaWiki REST API and Action API — no key required.
* REST API: https://en.wikipedia.org/api/rest_v1/
* Action API: https://en.wikipedia.org/w/api.php
*/
import { CliError } from '@jackwener/opencli/errors';
/** Maximum character length for article extract fields. */
export const EXTRACT_MAX_LEN = 300;
/** Maximum character length for short description fields. */
export const DESC_MAX_LEN = 80;
/** Response shape shared by /page/summary and /page/random/summary endpoints. */
export interface WikiSummary {
title?: string;
description?: string;
extract?: string;
content_urls?: { desktop?: { page?: string } };
}
/** Article entry returned by the /feed/featured most-read endpoint. */
export interface WikiMostReadArticle {
title?: string;
description?: string;
views?: number;
}
export async function wikiFetch(lang: string, path: string): Promise<unknown> {
const url = `https://${lang}.wikipedia.org${path}`;
const resp = await fetch(url, {
headers: { 'User-Agent': 'opencli/1.0 (https://github.com/jackwener/opencli)' },
});
if (!resp.ok) {
throw new CliError('FETCH_ERROR', `Wikipedia API HTTP ${resp.status}`, `Check your title or search term`);
}
return resp.json();
}
/** Map a WikiSummary API response to the standard output row. */
export function formatSummaryRow(data: WikiSummary, lang: string) {
return {
title: data.title!,
description: data.description ?? '-',
extract: (data.extract ?? '').slice(0, EXTRACT_MAX_LEN),
url: data.content_urls?.desktop?.page ?? `https://${lang}.wikipedia.org`,
};
}