Skip to content

Commit a920e20

Browse files
committed
refactor(plugins): simplify injected-script exports and drop the connect wrapper
Rename the browser/injected surface for clarity, per review: - a11y: the injected browser script is now ./client-script (src/client-script/index.ts, no page-script subfolder); drop the confusing 'page script' term. Keep a11yClientScriptBundlePath (deprecated aliases for the old names). - data-inspector: the node --import module is now ./inject (src/inject/, restored name), since it runs in the user's Node process, not the browser. - inspect/og/assets/code-server: the connectX wrapper was only used by each plugin's own SPA, so move it into app/connect.ts and drop the ./client-script export; these plugins now build only their node side with tsdown. Trim the barrel to the types the app actually uses. - reconcile alias.ts, tsconfig.base.json paths, knip entries, and API snapshots
1 parent 189b200 commit a920e20

90 files changed

Lines changed: 142 additions & 531 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎alias.ts‎

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,6 @@ export const alias = {
7878
'@devframes/json-render-ui/spa': r('json-render-ui/src/spa.ts'),
7979
'@devframes/json-render-ui': r('json-render-ui/src/index.ts'),
8080
'json-render/dashboard': fileURLToPath(new URL('./examples/json-render/src/dashboard.ts', import.meta.url)),
81-
'@devframes/plugin-code-server/client-script': p('code-server/src/client-script/client/index.ts'),
8281
'@devframes/plugin-code-server/node': p('code-server/src/node/setup.ts'),
8382
'@devframes/plugin-code-server/constants': p('code-server/src/node/constants.ts'),
8483
'@devframes/plugin-code-server/types': p('code-server/src/node/types.ts'),
@@ -98,24 +97,20 @@ export const alias = {
9897
'devframe/recipes/common-rpc-functions': r('devframe/src/recipes/common-rpc-functions.ts'),
9998
'devframe/client': r('devframe/src/client/index.ts'),
10099
'devframe': r('devframe/src'),
101-
'@devframes/plugin-data-inspector/client-script/page-script': p('data-inspector/src/client-script/page-script/index.ts'),
102-
'@devframes/plugin-data-inspector/client-script': p('data-inspector/src/client-script/client/index.ts'),
100+
'@devframes/plugin-data-inspector/inject': p('data-inspector/src/inject/index.ts'),
103101
'@devframes/plugin-data-inspector/node': p('data-inspector/src/node/setup.ts'),
104102
'@devframes/plugin-data-inspector/registry': p('data-inspector/src/node/registry/index.ts'),
105103
'@devframes/plugin-data-inspector/engine': p('data-inspector/src/node/engine/index.ts'),
106104
'@devframes/plugin-data-inspector/cli': p('data-inspector/src/node/cli.ts'),
107105
'@devframes/plugin-data-inspector': p('data-inspector/src/node/index.ts'),
108-
'@devframes/plugin-inspect/client-script': p('inspect/src/client-script/client/index.ts'),
109106
'@devframes/plugin-inspect/node': p('inspect/src/node/setup.ts'),
110107
'@devframes/plugin-inspect/cli': p('inspect/src/node/cli.ts'),
111108
'@devframes/plugin-inspect': p('inspect/src/node/index.ts'),
112-
'@devframes/plugin-og/client-script': p('og/src/client-script/client/index.ts'),
113109
'@devframes/plugin-og/node': p('og/src/node/setup.ts'),
114110
'@devframes/plugin-og/rpc': p('og/src/node/rpc/index.ts'),
115111
'@devframes/plugin-og/cli': p('og/src/node/cli.ts'),
116112
'@devframes/plugin-og': p('og/src/node/index.ts'),
117-
'@devframes/plugin-a11y/client-script/page-script': p('a11y/src/client-script/page-script/index.ts'),
118-
'@devframes/plugin-a11y/client-script': p('a11y/src/client-script/client/index.ts'),
113+
'@devframes/plugin-a11y/client-script': p('a11y/src/client-script/index.ts'),
119114
'@devframes/plugin-a11y/node': p('a11y/src/node/setup.ts'),
120115
'@devframes/plugin-a11y/cli': p('a11y/src/node/cli.ts'),
121116
'@devframes/plugin-a11y': p('a11y/src/node/index.ts'),
@@ -125,7 +120,6 @@ export const alias = {
125120
'@devframes/plugin-messages/rpc': p('messages/src/node/rpc/index.ts'),
126121
'@devframes/plugin-messages/cli': p('messages/src/node/cli.ts'),
127122
'@devframes/plugin-messages': p('messages/src/node/index.ts'),
128-
'@devframes/plugin-assets/client-script': p('assets/src/client-script/client/index.ts'),
129123
'@devframes/plugin-assets/node': p('assets/src/node/setup.ts'),
130124
'@devframes/plugin-assets/rpc': p('assets/src/node/rpc/index.ts'),
131125
'@devframes/plugin-assets/cli': p('assets/src/node/cli.ts'),

‎knip.jsonc‎

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
// renames left `createDevframeClientHost` → `createDevframeClientRuntime`
2828
// and `AGENT_DISCOVERY_FILE` → `DISCOVERY_FILE` aliases behind.
2929
"packages/hub/src/client/host.ts": ["duplicates"],
30-
"plugins/data-inspector/src/client-script/page-script/index.ts": ["duplicates"]
30+
"plugins/data-inspector/src/inject/index.ts": ["duplicates"]
3131
},
3232
"workspaces": {
3333
".": {
@@ -212,7 +212,6 @@
212212
"entry": [
213213
"src/node/{index,setup,cli}.ts",
214214
"src/node/rpc/index.ts",
215-
"src/client-script/client/index.ts",
216215
"app/**/*.stories.@(ts|tsx)"
217216
],
218217
"ignoreDependencies": ["@devframes/plugin-inspect--assets", "@devframes/vite"]
@@ -231,7 +230,6 @@
231230
"entry": [
232231
"src/node/{index,setup,cli}.ts",
233232
"src/node/rpc/index.ts",
234-
"src/client-script/client/index.ts",
235233
"app/**/*.stories.@(ts|tsx)"
236234
],
237235
"ignoreDependencies": ["@devframes/plugin-og--assets", "@devframes/vite"]
@@ -242,8 +240,7 @@
242240
"src/node/{index,setup,cli}.ts",
243241
"src/node/rpc/index.ts",
244242
"src/node/{engine,registry}/index.ts",
245-
"src/client-script/client/index.ts",
246-
"src/client-script/page-script/index.ts",
243+
"src/inject/index.ts",
247244
"app/**/*.stories.@(ts|tsx)"
248245
],
249246
"ignoreDependencies": ["@devframes/plugin-data-inspector--assets", "@devframes/vite"]
@@ -253,7 +250,6 @@
253250
"entry": [
254251
"src/node/{index,setup,cli,constants,types,vite}.ts",
255252
"src/node/rpc/index.ts",
256-
"src/client-script/client/index.ts",
257253
"app/**/*.stories.@(ts|tsx)"
258254
],
259255
"ignoreDependencies": ["@devframes/plugin-code-server--assets"]
@@ -263,7 +259,6 @@
263259
"entry": [
264260
"src/node/{index,setup,cli,constants,types}.ts",
265261
"src/node/rpc/index.ts",
266-
"src/client-script/client/index.ts",
267262
"app/**/*.stories.@(ts|tsx)"
268263
],
269264
"ignoreDependencies": ["@devframes/plugin-assets--assets", "@devframes/vite"]
@@ -306,7 +301,7 @@
306301
"entry": [
307302
"src/node/{index,setup,cli}.ts",
308303
"src/node/rpc/index.ts",
309-
"src/client-script/{client,page-script}/index.ts",
304+
"src/client-script/index.ts",
310305
"app/**/*.stories.tsx"
311306
],
312307
"ignoreDependencies": ["@devframes/plugin-a11y--assets", "@devframes/vite"]

‎plugins/a11y/package.json‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,7 @@
2323
"sideEffects": false,
2424
"exports": {
2525
".": "./dist/node/index.mjs",
26-
"./client-script": "./dist/client-script/client/index.mjs",
27-
"./client-script/page-script": "./dist/client-script/page-script/index.mjs",
26+
"./client-script": "./dist/client-script/index.mjs",
2827
"./cli": "./dist/node/cli.mjs",
2928
"./node": "./dist/node/setup.mjs",
3029
"./package.json": "./package.json"

‎plugins/a11y/playgrounds/server.mjs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ const ROOT = resolve(HERE, '..')
3535
const devframe = createA11yDevframe()
3636
const mode = process.argv[2] === 'build' ? 'build' : 'dev'
3737
const basePath = devframe.basePath
38-
const injectDir = resolve(ROOT, 'dist/client-script/page-script')
38+
const injectDir = resolve(ROOT, 'dist/client-script')
3939
const panelDir = mode === 'build' ? resolve(ROOT, 'dist/static') : resolve(ROOT, 'assets-pkg/dist')
4040

4141
function requireBuilt(file, hint) {

‎plugins/a11y/src/client-script/client/index.ts‎

Lines changed: 0 additions & 16 deletions
This file was deleted.

‎plugins/a11y/src/client-script/client/shims.d.ts‎

Lines changed: 0 additions & 3 deletions
This file was deleted.

plugins/a11y/src/client-script/page-script/index.ts renamed to plugins/a11y/src/client-script/index.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
* export receives the hub's client-script context and additionally mirrors
1616
* each scan into the hub's messages feed.
1717
*/
18-
import type { A11yChannelProtocol, PageScriptConfig, PinTarget, ScanReport } from '../../shared/protocol.ts'
18+
import type { A11yChannelProtocol, PageScriptConfig, PinTarget, ScanReport } from '../shared/protocol.ts'
1919
import type { A11yPageScriptContext } from './messages.ts'
2020
import type { PinInfo } from './overlay.ts'
2121
import { createPageScriptChannel } from 'devframe/in-page-channel'
@@ -24,7 +24,7 @@ import {
2424
A11Y_DEFAULT_DOCK_ID,
2525
A11Y_NODE_ATTR,
2626
A11Y_STORAGE_KEY,
27-
} from '../../shared/protocol.ts'
27+
} from '../shared/protocol.ts'
2828
import { createMessagesReporter } from './messages.ts'
2929
import { createOverlay } from './overlay.ts'
3030
import { resolveElement, scan } from './scanner.ts'

plugins/a11y/src/client-script/page-script/messages.ts renamed to plugins/a11y/src/client-script/messages.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99
* simply has no messages client and skips the feed. Mirrors the pattern used
1010
* by the terminals and code-server plugins for `ctx.terminals`.
1111
*/
12-
import type { Impact, ScanReport } from '../../shared/protocol.ts'
13-
import { A11Y_DEFAULT_DOCK_ID } from '../../shared/protocol.ts'
12+
import type { Impact, ScanReport } from '../shared/protocol.ts'
13+
import { A11Y_DEFAULT_DOCK_ID } from '../shared/protocol.ts'
1414

1515
/**
1616
* Structural slice of the hub's `DevframeMessageAction` the page script emits: a

plugins/a11y/src/client-script/page-script/overlay.ts renamed to plugins/a11y/src/client-script/overlay.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
import type { Impact } from '../../shared/protocol.ts'
2-
import { IMPACT_COLOR } from '../../shared/protocol.ts'
1+
import type { Impact } from '../shared/protocol.ts'
2+
import { IMPACT_COLOR } from '../shared/protocol.ts'
33

44
const PREFERS_REDUCED_MOTION
55
= typeof matchMedia === 'function' && matchMedia('(prefers-reduced-motion: reduce)').matches

plugins/a11y/src/client-script/page-script/scanner.ts renamed to plugins/a11y/src/client-script/scanner.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
import type { ScanReport, Violation, ViolationNode } from '../../shared/protocol.ts'
1+
import type { ScanReport, Violation, ViolationNode } from '../shared/protocol.ts'
22
import axe from 'axe-core'
3-
import { A11Y_NODE_ATTR, DEFAULT_AXE_TAGS, emptyCounts, IMPACT_ORDER } from '../../shared/protocol.ts'
3+
import { A11Y_NODE_ATTR, DEFAULT_AXE_TAGS, emptyCounts, IMPACT_ORDER } from '../shared/protocol.ts'
44

55
const IMPACTS = new Set<string>(IMPACT_ORDER)
66
let counter = 0

0 commit comments

Comments
 (0)