Files
jackwener__opencli/clis/ones/task.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

80 lines
2.6 KiB
TypeScript

import { cli, Strategy } from '@jackwener/opencli/registry';
import { CliError } from '@jackwener/opencli/errors';
import { onesFetchInPage } from './common.js';
import { formatStamp } from './task-helpers.js';
/**
* 工作项详情 — 对应前端路由 …/team/<team>/filter/view/…/task/<uuid>
* API: GET team/:teamUUID/task/:taskUUIDOrNumber/info
* @see https://docs.ones.cn/project/open-api-doc/project/task.html
*/
cli({
site: 'ones',
name: 'task',
description:
'ONES — work item detail (GET team/:team/task/:id/info); id is URL segment after …/task/',
domain: 'ones.cn',
strategy: Strategy.COOKIE,
browser: true,
navigateBefore: false,
args: [
{
name: 'id',
type: 'str',
required: true,
positional: true,
help: 'Work item UUID (often 16 chars) from …/task/<id>',
},
{
name: 'team',
type: 'str',
required: false,
help: 'Team UUID (8 chars from …/team/<team>/…), or set ONES_TEAM_UUID',
},
],
columns: ['uuid', 'summary', 'number', 'status_uuid', 'assign', 'owner', 'project_uuid', 'updated'],
func: async (page, kwargs) => {
const id = String(kwargs.id ?? '').trim();
if (!id) {
throw new CliError('CONFIG', 'task id required', 'Pass the work item uuid from the URL path …/task/<id>');
}
const team =
(kwargs.team as string | undefined)?.trim() ||
process.env.ONES_TEAM_UUID?.trim() ||
process.env.ONES_TEAM_ID?.trim();
if (!team) {
throw new CliError(
'CONFIG',
'team UUID required',
'Use --team <teamUUID> or set ONES_TEAM_UUID (from …/team/<team>/…).',
);
}
const path = `team/${team}/task/${encodeURIComponent(id)}/info`;
const data = (await onesFetchInPage(page, path, { method: 'GET' })) as Record<string, unknown>;
if (typeof data.uuid !== 'string') {
const hint =
typeof data.reason === 'string'
? data.reason
: 'Use -f json to inspect response; check id length (often 16) and team.';
throw new CliError('FETCH_ERROR', `ONES task info: ${hint}`, 'Confirm task uuid and team match the browser URL.');
}
return [
{
uuid: String(data.uuid),
summary: String(data.summary ?? ''),
number: data.number != null ? String(data.number) : '',
status_uuid: String(data.status_uuid ?? ''),
assign: String(data.assign ?? ''),
owner: String(data.owner ?? ''),
project_uuid: String(data.project_uuid ?? ''),
updated: formatStamp(data.server_update_stamp),
},
];
},
});