Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions .changeset/7004-cli-root-path-line.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
---
'@object-ui/cli': patch
---

`objectui validate` now says when a validation issue sits at the document root
(objectui#7004, mechanical half).

The printer guarded its Path line with `issue.path.length > 0`, so an issue at
`path: []` printed no Path line at all — silent in exactly the case a reader
most needs oriented. That case is the common one, not an edge: the CLI validates
against `AnyComponentSchema`, a union over every component arm, so any document
matching no arm reports a single top-level issue (`invalid_union` · `Invalid
input` · root path). Authors saw a bare verdict on a whole document with nothing
saying which node had been judged:

```
1. Invalid input
Code: invalid_union
```

Every reported issue now carries a Path line; a root-level one reads
`Path: (root)`, parenthesised so it cannot be mistaken for a real key named
`root`. Non-root issues print their authored path exactly as before.

Scope: the printer still reads only top-level issues. Whether a failing union
should also surface its per-arm diagnoses — and if so which arm's — is an
author-facing diagnostic contract left open on objectui#7004 for a maintainer
ruling, and is deliberately not decided here.
210 changes: 210 additions & 0 deletions packages/cli/src/__tests__/validate-root-path-line.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,210 @@
/**
* ObjectUI
* Copyright (c) 2024-present ObjectStack Inc.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

/**
* `objectui validate` and the ROOT-LEVEL issue (objectui#7004, mechanical half).
*
* The printer used to guard its Path line with `issue.path.length > 0`, so an
* issue at the document root (`path: []`) printed no Path line at all — silent
* in precisely the case a reader most needs oriented.
*
* That case is the common one, not an edge: `safeValidateSchema` runs
* `AnyComponentSchema`, a `z.union` over every component arm, so any document
* matching no arm yields ONE top-level issue — `invalid_union` · `Invalid
* input` · `path: []`. Measured on the parent commit of this file, a menu
* carrying the retired `{ type: 'separator' }` divider spelling printed:
*
* 1. Invalid input
* Code: invalid_union
*
* — a bare verdict on a whole document, with nothing saying which node had
* been judged.
*
* ⚠️ These cases are written against BOTH sides of the guard on purpose. A fix
* that printed `(root)` unconditionally would satisfy a root-only test while
* destroying the real paths authors depend on, so the non-root control below
* is load-bearing, not decoration.
*
* Harness (fixtures under `os.tmpdir()`, `process.exit` recorded rather than
* taken) follows `validate-widget-namespace.test.ts`; see its header for why
* fixtures never live in the repo tree.
*/

import { describe, it, expect, beforeEach, afterEach, vi } from 'vitest';
import { mkdtempSync, rmSync, writeFileSync } from 'node:fs';
import { join } from 'node:path';
import { tmpdir } from 'node:os';
import { validate } from '../commands/validate.js';

/**
* The CSI sequences chalk may add. The escape byte is built with
* `String.fromCharCode` rather than spelled into the source, so this file holds
* no raw control character and no escape a tooling pass could materialise into
* one (objectui AGENTS.md byte discipline).
*/
const ANSI = new RegExp(`${String.fromCharCode(27)}\\[[0-9;]*m`, 'g');

/**
* A menu whose item uses the divider spelling retired in objectui#6523. This
* is the document the finding was measured on: `MenuItemSchema` is a union, so
* its diagnosis rides the per-arm issues while the top-level issue stays at the
* root.
*/
const MENU_WITH_RETIRED_DIVIDER = {
type: 'dropdown-menu',
items: [{ label: 'New Tab', type: 'separator' }],
};

/** A document from an entirely foreign vocabulary — the other root producer. */
const FOREIGN_DOCUMENT = { type: 'module', main: './index.js' };

/**
* The non-root control, lifted from `validate-widget-namespace.test.ts` so both
* files pin the same observed path for the same input.
*/
const FORM_WITH_UNRESOLVABLE_WIDGET = {
type: 'form',
fields: [{ name: 'pw', widget: 'ui:password' }],
};

let dir: string;
let out: string[];
let exitCodes: number[];
let restore: () => void;

/** Everything the command printed, chalk colour codes stripped. */
function printed(): string {
return out.join('\n').replace(ANSI, '');
}

function writeSchema(name: string, schema: unknown): string {
const file = join(dir, name);
writeFileSync(file, JSON.stringify(schema, null, 2), 'utf-8');
return file;
}

beforeEach(() => {
dir = mkdtempSync(join(tmpdir(), 'objectui-validate-7004-'));
out = [];
exitCodes = [];
const originalLog = console.log;
const originalError = console.error;
const capture = (...args: unknown[]) => {
out.push(args.map(String).join(' '));
};
console.log = capture;
console.error = capture;
const exitSpy = vi.spyOn(process, 'exit').mockImplementation(((code?: number) => {
exitCodes.push(code ?? 0);
return undefined as never;
}) as never);
restore = () => {
console.log = originalLog;
console.error = originalError;
exitSpy.mockRestore();
};
});

afterEach(() => {
restore();
rmSync(dir, { recursive: true, force: true });
});

describe('objectui validate — a root-level issue says it is at the root', () => {
it('prints a Path line for the union failure that used to print none', async () => {
await validate(writeSchema('menu.json', MENU_WITH_RETIRED_DIVIDER));

expect(exitCodes).toEqual([1]);
const text = printed();
// The three fields, in the order the printer emits them. The middle one is
// the whole card: before this change the message and Code lines were
// adjacent, with nothing between them.
expect(text).toContain('1. Invalid input');
expect(text).toContain('Path: (root)');
expect(text).toContain('Code: invalid_union');
});

it('does the same for a document from a foreign vocabulary', async () => {
await validate(writeSchema('package.json', FOREIGN_DOCUMENT));

expect(exitCodes).toEqual([1]);
expect(printed()).toContain('Path: (root)');
});

it('gives EVERY reported issue a Path line, root or not', async () => {
// Structural rather than by-example: the defect was an absence, and the
// repair is "no numbered issue is ever printed without a Path". Asserting
// one example line would not catch a future guard reintroducing the hole
// on some other issue shape.
await validate(writeSchema('menu.json', MENU_WITH_RETIRED_DIVIDER));

const lines = printed().split('\n');
const numbered = lines
.map((line, i) => ({ line, i }))
.filter(({ line }) => /^\d+\. /.test(line.trim()));
expect(numbered.length).toBeGreaterThan(0);
for (const { line, i } of numbered) {
expect(
lines[i + 1]?.trim().startsWith('Path: '),
`issue "${line.trim()}" printed no Path line`,
).toBe(true);
}
});
});

describe('objectui validate — a real path is still a real path', () => {
it('prints the authored path unchanged, and does not call it the root', async () => {
// The guard against the fix that "passes" by printing (root) for
// everything.
await validate(writeSchema('form.json', FORM_WITH_UNRESOLVABLE_WIDGET));

expect(exitCodes).toEqual([1]);
const text = printed();
expect(text).toContain('Path: fields → 0 → widget');
expect(text).not.toContain('(root)');
});

it('still exits 0 and prints no Path line on a document that validates', async () => {
await validate(
writeSchema('ok.json', { type: 'form', fields: [{ name: 'pw', type: 'password' }] }),
);

expect(exitCodes).toEqual([0]);
const text = printed();
expect(text).toContain('Schema is valid!');
expect(text).not.toContain('Path:');
});
});

describe('objectui validate — the arm-selection half is deliberately NOT done here', () => {
/**
* ⚠️ This case pins a BOUNDARY, not a desired end state. objectui#7004 splits
* into the root-path line (done, above) and the question of whether a failing
* union should also surface its per-arm diagnoses — and if so, which arm's.
* The second is an author-facing diagnostic contract and is awaiting a
* maintainer ruling, so this file records that the printer walks only the
* top level today.
*
* When that ruling lands, this case is EXPECTED to change with it. It exists
* so the change is a deliberate edit rather than a silent widening.
*/
it('prints one top-level entry for a union, not the per-arm remediation text', async () => {
await validate(writeSchema('menu.json', MENU_WITH_RETIRED_DIVIDER));

const text = printed();
// The arm issues carry the objectui#6523 tombstone guidance. Nothing here
// reads `issue.errors`, so none of it is printed.
expect(text).not.toContain('RETIRED (objectui#6523)');
expect(text).not.toContain('Path: items');
// Exactly one numbered issue — an arm walk would multiply this.
const numbered = printed()
.split('\n')
.filter((line) => /^\d+\. /.test(line.trim()));
expect(numbered).toHaveLength(1);
});
});
27 changes: 24 additions & 3 deletions packages/cli/src/commands/validate.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -103,11 +103,32 @@ export async function validate(schemaPath: string) {
// undefined and this loop threw a TypeError that the catch below
// reported as "Error reading or parsing schema file", hiding the very
// errors this command exists to print.
// Every issue gets a Path line, INCLUDING a root-level one (objectui#7004).
//
// The guard here used to be `issue.path.length > 0`, which dropped the
// line entirely for `path: []` — silent in exactly the case a reader
// most needs oriented. That case is not rare: `safeValidateSchema` runs
// `AnyComponentSchema`, which is a `z.union` of every component arm, so
// ANY document matching no arm reports one top-level issue at the root
// (`invalid_union` · `Invalid input` · `path: []`). Measured before this
// change, a menu carrying the retired `{ type: 'separator' }` divider
// spelling printed `1. Invalid input` and a Code line, and nothing said
// whether the whole document or some node inside it had been judged.
//
// `(root)` is parenthesised so it cannot be read as a real key literally
// named `root` — a genuine path to one would print as `root`.
//
// ⛔ Scope: this prints the top-level issue's own path and NOTHING more.
// The other half of objectui#7004 — whether a failing union should also
// surface its per-arm diagnoses, and if so which arm's — is an
// author-facing diagnostic contract awaiting a maintainer ruling, so
// `issue.errors` is deliberately NOT walked here.
result.error.issues.forEach((issue, index) => {
console.error(chalk.red(`\n${index + 1}. ${issue.message}`));
if (issue.path && issue.path.length > 0) {
console.error(chalk.gray(` Path: ${issue.path.join(' → ')}`));
}
const path = issue.path ?? [];
console.error(
chalk.gray(` Path: ${path.length > 0 ? path.join(' → ') : '(root)'}`)
);
if (issue.code) {
console.error(chalk.gray(` Code: ${issue.code}`));
}
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions .changeset/7004-cli-root-path-line.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
---
'@object-ui/cli': patch
---

`objectui validate` now says when a validation issue sits at the document root
(objectui#7004, mechanical half).

The printer guarded its Path line with `issue.path.length > 0`, so an issue at
`path: []` printed no Path line at all — silent in exactly the case a reader
most needs oriented. That case is the common one, not an edge: the CLI validates
against `AnyComponentSchema`, a union over every component arm, so any document
matching no arm reports a single top-level issue (`invalid_union` · `Invalid
input` · root path). Authors saw a bare verdict on a whole document with nothing
saying which node had been judged:

```
1. Invalid input
Code: invalid_union
```

Every reported issue now carries a Path line; a root-level one reads
`Path: (root)`, parenthesised so it cannot be mistaken for a real key named
`root`. Non-root issues print their authored path exactly as before.

Scope: the printer still reads only top-level issues. Whether a failing union
should also surface its per-arm diagnoses — and if so which arm's — is an
author-facing diagnostic contract left open on objectui#7004 for a maintainer
ruling, and is deliberately not decided here.
210 changes: 210 additions & 0 deletions packages/cli/src/__tests__/validate-root-path-line.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,210 @@
/**
* ObjectUI
* Copyright (c) 2024-present ObjectStack Inc.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

/**
* `objectui validate` and the ROOT-LEVEL issue (objectui#7004, mechanical half).
*
* The printer used to guard its Path line with `issue.path.length > 0`, so an
* issue at the document root (`path: []`) printed no Path line at all — silent
* in precisely the case a reader most needs oriented.
*
* That case is the common one, not an edge: `safeValidateSchema` runs
* `AnyComponentSchema`, a `z.union` over every component arm, so any document
* matching no arm yields ONE top-level issue — `invalid_union` · `Invalid
* input` · `path: []`. Measured on the parent commit of this file, a menu
* carrying the retired `{ type: 'separator' }` divider spelling printed:
*
* 1. Invalid input
* Code: invalid_union
*
* — a bare verdict on a whole document, with nothing saying which node had
* been judged.
*
* ⚠️ These cases are written against BOTH sides of the guard on purpose. A fix
* that printed `(root)` unconditionally would satisfy a root-only test while
* destroying the real paths authors depend on, so the non-root control below
* is load-bearing, not decoration.
*
* Harness (fixtures under `os.tmpdir()`, `process.exit` recorded rather than
* taken) follows `validate-widget-namespace.test.ts`; see its header for why
* fixtures never live in the repo tree.
*/

import { describe, it, expect, beforeEach, afterEach, vi } from 'vitest';
import { mkdtempSync, rmSync, writeFileSync } from 'node:fs';
import { join } from 'node:path';
import { tmpdir } from 'node:os';
import { validate } from '../commands/validate.js';

/**
* The CSI sequences chalk may add. The escape byte is built with
* `String.fromCharCode` rather than spelled into the source, so this file holds
* no raw control character and no escape a tooling pass could materialise into
* one (objectui AGENTS.md byte discipline).
*/
const ANSI = new RegExp(`${String.fromCharCode(27)}\\[[0-9;]*m`, 'g');

/**
* A menu whose item uses the divider spelling retired in objectui#6523. This
* is the document the finding was measured on: `MenuItemSchema` is a union, so
* its diagnosis rides the per-arm issues while the top-level issue stays at the
* root.
*/
const MENU_WITH_RETIRED_DIVIDER = {
type: 'dropdown-menu',
items: [{ label: 'New Tab', type: 'separator' }],
};

/** A document from an entirely foreign vocabulary — the other root producer. */
const FOREIGN_DOCUMENT = { type: 'module', main: './index.js' };

/**
* The non-root control, lifted from `validate-widget-namespace.test.ts` so both
* files pin the same observed path for the same input.
*/
const FORM_WITH_UNRESOLVABLE_WIDGET = {
type: 'form',
fields: [{ name: 'pw', widget: 'ui:password' }],
};

let dir: string;
let out: string[];
let exitCodes: number[];
let restore: () => void;

/** Everything the command printed, chalk colour codes stripped. */
function printed(): string {
return out.join('\n').replace(ANSI, '');
}

function writeSchema(name: string, schema: unknown): string {
const file = join(dir, name);
writeFileSync(file, JSON.stringify(schema, null, 2), 'utf-8');
return file;
}

beforeEach(() => {
dir = mkdtempSync(join(tmpdir(), 'objectui-validate-7004-'));
out = [];
exitCodes = [];
const originalLog = console.log;
const originalError = console.error;
const capture = (...args: unknown[]) => {
out.push(args.map(String).join(' '));
};
console.log = capture;
console.error = capture;
const exitSpy = vi.spyOn(process, 'exit').mockImplementation(((code?: number) => {
exitCodes.push(code ?? 0);
return undefined as never;
}) as never);
restore = () => {
console.log = originalLog;
console.error = originalError;
exitSpy.mockRestore();
};
});

afterEach(() => {
restore();
rmSync(dir, { recursive: true, force: true });
});

describe('objectui validate — a root-level issue says it is at the root', () => {
it('prints a Path line for the union failure that used to print none', async () => {
await validate(writeSchema('menu.json', MENU_WITH_RETIRED_DIVIDER));

expect(exitCodes).toEqual([1]);
const text = printed();
// The three fields, in the order the printer emits them. The middle one is
// the whole card: before this change the message and Code lines were
// adjacent, with nothing between them.
expect(text).toContain('1. Invalid input');
expect(text).toContain('Path: (root)');
expect(text).toContain('Code: invalid_union');
});

it('does the same for a document from a foreign vocabulary', async () => {
await validate(writeSchema('package.json', FOREIGN_DOCUMENT));

expect(exitCodes).toEqual([1]);
expect(printed()).toContain('Path: (root)');
});

it('gives EVERY reported issue a Path line, root or not', async () => {
// Structural rather than by-example: the defect was an absence, and the
// repair is "no numbered issue is ever printed without a Path". Asserting
// one example line would not catch a future guard reintroducing the hole
// on some other issue shape.
await validate(writeSchema('menu.json', MENU_WITH_RETIRED_DIVIDER));

const lines = printed().split('\n');
const numbered = lines
.map((line, i) => ({ line, i }))
.filter(({ line }) => /^\d+\. /.test(line.trim()));
expect(numbered.length).toBeGreaterThan(0);
for (const { line, i } of numbered) {
expect(
lines[i + 1]?.trim().startsWith('Path: '),
`issue "${line.trim()}" printed no Path line`,
).toBe(true);
}
});
});

describe('objectui validate — a real path is still a real path', () => {
it('prints the authored path unchanged, and does not call it the root', async () => {
// The guard against the fix that "passes" by printing (root) for
// everything.
await validate(writeSchema('form.json', FORM_WITH_UNRESOLVABLE_WIDGET));

expect(exitCodes).toEqual([1]);
const text = printed();
expect(text).toContain('Path: fields → 0 → widget');
expect(text).not.toContain('(root)');
});

it('still exits 0 and prints no Path line on a document that validates', async () => {
await validate(
writeSchema('ok.json', { type: 'form', fields: [{ name: 'pw', type: 'password' }] }),
);

expect(exitCodes).toEqual([0]);
const text = printed();
expect(text).toContain('Schema is valid!');
expect(text).not.toContain('Path:');
});
});

describe('objectui validate — the arm-selection half is deliberately NOT done here', () => {
/**
* ⚠️ This case pins a BOUNDARY, not a desired end state. objectui#7004 splits
* into the root-path line (done, above) and the question of whether a failing
* union should also surface its per-arm diagnoses — and if so, which arm's.
* The second is an author-facing diagnostic contract and is awaiting a
* maintainer ruling, so this file records that the printer walks only the
* top level today.
*
* When that ruling lands, this case is EXPECTED to change with it. It exists
* so the change is a deliberate edit rather than a silent widening.
*/
it('prints one top-level entry for a union, not the per-arm remediation text', async () => {
await validate(writeSchema('menu.json', MENU_WITH_RETIRED_DIVIDER));

const text = printed();
// The arm issues carry the objectui#6523 tombstone guidance. Nothing here
// reads `issue.errors`, so none of it is printed.
expect(text).not.toContain('RETIRED (objectui#6523)');
expect(text).not.toContain('Path: items');
// Exactly one numbered issue — an arm walk would multiply this.
const numbered = printed()
.split('\n')
.filter((line) => /^\d+\. /.test(line.trim()));
expect(numbered).toHaveLength(1);
});
});
27 changes: 24 additions & 3 deletions packages/cli/src/commands/validate.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -103,11 +103,32 @@ export async function validate(schemaPath: string) {
// undefined and this loop threw a TypeError that the catch below
// reported as "Error reading or parsing schema file", hiding the very
// errors this command exists to print.
// Every issue gets a Path line, INCLUDING a root-level one (objectui#7004).
//
// The guard here used to be `issue.path.length > 0`, which dropped the
// line entirely for `path: []` — silent in exactly the case a reader
// most needs oriented. That case is not rare: `safeValidateSchema` runs
// `AnyComponentSchema`, which is a `z.union` of every component arm, so
// ANY document matching no arm reports one top-level issue at the root
// (`invalid_union` · `Invalid input` · `path: []`). Measured before this
// change, a menu carrying the retired `{ type: 'separator' }` divider
// spelling printed `1. Invalid input` and a Code line, and nothing said
// whether the whole document or some node inside it had been judged.
//
// `(root)` is parenthesised so it cannot be read as a real key literally
// named `root` — a genuine path to one would print as `root`.
//
// ⛔ Scope: this prints the top-level issue's own path and NOTHING more.
// The other half of objectui#7004 — whether a failing union should also
// surface its per-arm diagnoses, and if so which arm's — is an
// author-facing diagnostic contract awaiting a maintainer ruling, so
// `issue.errors` is deliberately NOT walked here.
result.error.issues.forEach((issue, index) => {
console.error(chalk.red(`\n${index + 1}. ${issue.message}`));
if (issue.path && issue.path.length > 0) {
console.error(chalk.gray(` Path: ${issue.path.join(' → ')}`));
}
const path = issue.path ?? [];
console.error(
chalk.gray(` Path: ${path.length > 0 ? path.join(' → ') : '(root)'}`)
);
if (issue.code) {
console.error(chalk.gray(` Code: ${issue.code}`));
}
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions .changeset/7004-cli-root-path-line.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
---
'@object-ui/cli': patch
---

`objectui validate` now says when a validation issue sits at the document root
(objectui#7004, mechanical half).

The printer guarded its Path line with `issue.path.length > 0`, so an issue at
`path: []` printed no Path line at all — silent in exactly the case a reader
most needs oriented. That case is the common one, not an edge: the CLI validates
against `AnyComponentSchema`, a union over every component arm, so any document
matching no arm reports a single top-level issue (`invalid_union` · `Invalid
input` · root path). Authors saw a bare verdict on a whole document with nothing
saying which node had been judged:

```
1. Invalid input
Code: invalid_union
```

Every reported issue now carries a Path line; a root-level one reads
`Path: (root)`, parenthesised so it cannot be mistaken for a real key named
`root`. Non-root issues print their authored path exactly as before.

Scope: the printer still reads only top-level issues. Whether a failing union
should also surface its per-arm diagnoses — and if so which arm's — is an
author-facing diagnostic contract left open on objectui#7004 for a maintainer
ruling, and is deliberately not decided here.
210 changes: 210 additions & 0 deletions packages/cli/src/__tests__/validate-root-path-line.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,210 @@
/**
* ObjectUI
* Copyright (c) 2024-present ObjectStack Inc.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

/**
* `objectui validate` and the ROOT-LEVEL issue (objectui#7004, mechanical half).
*
* The printer used to guard its Path line with `issue.path.length > 0`, so an
* issue at the document root (`path: []`) printed no Path line at all — silent
* in precisely the case a reader most needs oriented.
*
* That case is the common one, not an edge: `safeValidateSchema` runs
* `AnyComponentSchema`, a `z.union` over every component arm, so any document
* matching no arm yields ONE top-level issue — `invalid_union` · `Invalid
* input` · `path: []`. Measured on the parent commit of this file, a menu
* carrying the retired `{ type: 'separator' }` divider spelling printed:
*
* 1. Invalid input
* Code: invalid_union
*
* — a bare verdict on a whole document, with nothing saying which node had
* been judged.
*
* ⚠️ These cases are written against BOTH sides of the guard on purpose. A fix
* that printed `(root)` unconditionally would satisfy a root-only test while
* destroying the real paths authors depend on, so the non-root control below
* is load-bearing, not decoration.
*
* Harness (fixtures under `os.tmpdir()`, `process.exit` recorded rather than
* taken) follows `validate-widget-namespace.test.ts`; see its header for why
* fixtures never live in the repo tree.
*/

import { describe, it, expect, beforeEach, afterEach, vi } from 'vitest';
import { mkdtempSync, rmSync, writeFileSync } from 'node:fs';
import { join } from 'node:path';
import { tmpdir } from 'node:os';
import { validate } from '../commands/validate.js';

/**
* The CSI sequences chalk may add. The escape byte is built with
* `String.fromCharCode` rather than spelled into the source, so this file holds
* no raw control character and no escape a tooling pass could materialise into
* one (objectui AGENTS.md byte discipline).
*/
const ANSI = new RegExp(`${String.fromCharCode(27)}\\[[0-9;]*m`, 'g');

/**
* A menu whose item uses the divider spelling retired in objectui#6523. This
* is the document the finding was measured on: `MenuItemSchema` is a union, so
* its diagnosis rides the per-arm issues while the top-level issue stays at the
* root.
*/
const MENU_WITH_RETIRED_DIVIDER = {
type: 'dropdown-menu',
items: [{ label: 'New Tab', type: 'separator' }],
};

/** A document from an entirely foreign vocabulary — the other root producer. */
const FOREIGN_DOCUMENT = { type: 'module', main: './index.js' };

/**
* The non-root control, lifted from `validate-widget-namespace.test.ts` so both
* files pin the same observed path for the same input.
*/
const FORM_WITH_UNRESOLVABLE_WIDGET = {
type: 'form',
fields: [{ name: 'pw', widget: 'ui:password' }],
};

let dir: string;
let out: string[];
let exitCodes: number[];
let restore: () => void;

/** Everything the command printed, chalk colour codes stripped. */
function printed(): string {
return out.join('\n').replace(ANSI, '');
}

function writeSchema(name: string, schema: unknown): string {
const file = join(dir, name);
writeFileSync(file, JSON.stringify(schema, null, 2), 'utf-8');
return file;
}

beforeEach(() => {
dir = mkdtempSync(join(tmpdir(), 'objectui-validate-7004-'));
out = [];
exitCodes = [];
const originalLog = console.log;
const originalError = console.error;
const capture = (...args: unknown[]) => {
out.push(args.map(String).join(' '));
};
console.log = capture;
console.error = capture;
const exitSpy = vi.spyOn(process, 'exit').mockImplementation(((code?: number) => {
exitCodes.push(code ?? 0);
return undefined as never;
}) as never);
restore = () => {
console.log = originalLog;
console.error = originalError;
exitSpy.mockRestore();
};
});

afterEach(() => {
restore();
rmSync(dir, { recursive: true, force: true });
});

describe('objectui validate — a root-level issue says it is at the root', () => {
it('prints a Path line for the union failure that used to print none', async () => {
await validate(writeSchema('menu.json', MENU_WITH_RETIRED_DIVIDER));

expect(exitCodes).toEqual([1]);
const text = printed();
// The three fields, in the order the printer emits them. The middle one is
// the whole card: before this change the message and Code lines were
// adjacent, with nothing between them.
expect(text).toContain('1. Invalid input');
expect(text).toContain('Path: (root)');
expect(text).toContain('Code: invalid_union');
});

it('does the same for a document from a foreign vocabulary', async () => {
await validate(writeSchema('package.json', FOREIGN_DOCUMENT));

expect(exitCodes).toEqual([1]);
expect(printed()).toContain('Path: (root)');
});

it('gives EVERY reported issue a Path line, root or not', async () => {
// Structural rather than by-example: the defect was an absence, and the
// repair is "no numbered issue is ever printed without a Path". Asserting
// one example line would not catch a future guard reintroducing the hole
// on some other issue shape.
await validate(writeSchema('menu.json', MENU_WITH_RETIRED_DIVIDER));

const lines = printed().split('\n');
const numbered = lines
.map((line, i) => ({ line, i }))
.filter(({ line }) => /^\d+\. /.test(line.trim()));
expect(numbered.length).toBeGreaterThan(0);
for (const { line, i } of numbered) {
expect(
lines[i + 1]?.trim().startsWith('Path: '),
`issue "${line.trim()}" printed no Path line`,
).toBe(true);
}
});
});

describe('objectui validate — a real path is still a real path', () => {
it('prints the authored path unchanged, and does not call it the root', async () => {
// The guard against the fix that "passes" by printing (root) for
// everything.
await validate(writeSchema('form.json', FORM_WITH_UNRESOLVABLE_WIDGET));

expect(exitCodes).toEqual([1]);
const text = printed();
expect(text).toContain('Path: fields → 0 → widget');
expect(text).not.toContain('(root)');
});

it('still exits 0 and prints no Path line on a document that validates', async () => {
await validate(
writeSchema('ok.json', { type: 'form', fields: [{ name: 'pw', type: 'password' }] }),
);

expect(exitCodes).toEqual([0]);
const text = printed();
expect(text).toContain('Schema is valid!');
expect(text).not.toContain('Path:');
});
});

describe('objectui validate — the arm-selection half is deliberately NOT done here', () => {
/**
* ⚠️ This case pins a BOUNDARY, not a desired end state. objectui#7004 splits
* into the root-path line (done, above) and the question of whether a failing
* union should also surface its per-arm diagnoses — and if so, which arm's.
* The second is an author-facing diagnostic contract and is awaiting a
* maintainer ruling, so this file records that the printer walks only the
* top level today.
*
* When that ruling lands, this case is EXPECTED to change with it. It exists
* so the change is a deliberate edit rather than a silent widening.
*/
it('prints one top-level entry for a union, not the per-arm remediation text', async () => {
await validate(writeSchema('menu.json', MENU_WITH_RETIRED_DIVIDER));

const text = printed();
// The arm issues carry the objectui#6523 tombstone guidance. Nothing here
// reads `issue.errors`, so none of it is printed.
expect(text).not.toContain('RETIRED (objectui#6523)');
expect(text).not.toContain('Path: items');
// Exactly one numbered issue — an arm walk would multiply this.
const numbered = printed()
.split('\n')
.filter((line) => /^\d+\. /.test(line.trim()));
expect(numbered).toHaveLength(1);
});
});
27 changes: 24 additions & 3 deletions packages/cli/src/commands/validate.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -103,11 +103,32 @@ export async function validate(schemaPath: string) {
// undefined and this loop threw a TypeError that the catch below
// reported as "Error reading or parsing schema file", hiding the very
// errors this command exists to print.
// Every issue gets a Path line, INCLUDING a root-level one (objectui#7004).
//
// The guard here used to be `issue.path.length > 0`, which dropped the
// line entirely for `path: []` — silent in exactly the case a reader
// most needs oriented. That case is not rare: `safeValidateSchema` runs
// `AnyComponentSchema`, which is a `z.union` of every component arm, so
// ANY document matching no arm reports one top-level issue at the root
// (`invalid_union` · `Invalid input` · `path: []`). Measured before this
// change, a menu carrying the retired `{ type: 'separator' }` divider
// spelling printed `1. Invalid input` and a Code line, and nothing said
// whether the whole document or some node inside it had been judged.
//
// `(root)` is parenthesised so it cannot be read as a real key literally
// named `root` — a genuine path to one would print as `root`.
//
// ⛔ Scope: this prints the top-level issue's own path and NOTHING more.
// The other half of objectui#7004 — whether a failing union should also
// surface its per-arm diagnoses, and if so which arm's — is an
// author-facing diagnostic contract awaiting a maintainer ruling, so
// `issue.errors` is deliberately NOT walked here.
result.error.issues.forEach((issue, index) => {
console.error(chalk.red(`\n${index + 1}. ${issue.message}`));
if (issue.path && issue.path.length > 0) {
console.error(chalk.gray(` Path: ${issue.path.join(' → ')}`));
}
const path = issue.path ?? [];
console.error(
chalk.gray(` Path: ${path.length > 0 ? path.join(' → ') : '(root)'}`)
);
if (issue.code) {
console.error(chalk.gray(` Code: ${issue.code}`));
}
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions .changeset/7004-cli-root-path-line.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
---
'@object-ui/cli': patch
---

`objectui validate` now says when a validation issue sits at the document root
(objectui#7004, mechanical half).

The printer guarded its Path line with `issue.path.length > 0`, so an issue at
`path: []` printed no Path line at all — silent in exactly the case a reader
most needs oriented. That case is the common one, not an edge: the CLI validates
against `AnyComponentSchema`, a union over every component arm, so any document
matching no arm reports a single top-level issue (`invalid_union` · `Invalid
input` · root path). Authors saw a bare verdict on a whole document with nothing
saying which node had been judged:

```
1. Invalid input
Code: invalid_union
```

Every reported issue now carries a Path line; a root-level one reads
`Path: (root)`, parenthesised so it cannot be mistaken for a real key named
`root`. Non-root issues print their authored path exactly as before.

Scope: the printer still reads only top-level issues. Whether a failing union
should also surface its per-arm diagnoses — and if so which arm's — is an
author-facing diagnostic contract left open on objectui#7004 for a maintainer
ruling, and is deliberately not decided here.
210 changes: 210 additions & 0 deletions packages/cli/src/__tests__/validate-root-path-line.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,210 @@
/**
* ObjectUI
* Copyright (c) 2024-present ObjectStack Inc.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

/**
* `objectui validate` and the ROOT-LEVEL issue (objectui#7004, mechanical half).
*
* The printer used to guard its Path line with `issue.path.length > 0`, so an
* issue at the document root (`path: []`) printed no Path line at all — silent
* in precisely the case a reader most needs oriented.
*
* That case is the common one, not an edge: `safeValidateSchema` runs
* `AnyComponentSchema`, a `z.union` over every component arm, so any document
* matching no arm yields ONE top-level issue — `invalid_union` · `Invalid
* input` · `path: []`. Measured on the parent commit of this file, a menu
* carrying the retired `{ type: 'separator' }` divider spelling printed:
*
* 1. Invalid input
* Code: invalid_union
*
* — a bare verdict on a whole document, with nothing saying which node had
* been judged.
*
* ⚠️ These cases are written against BOTH sides of the guard on purpose. A fix
* that printed `(root)` unconditionally would satisfy a root-only test while
* destroying the real paths authors depend on, so the non-root control below
* is load-bearing, not decoration.
*
* Harness (fixtures under `os.tmpdir()`, `process.exit` recorded rather than
* taken) follows `validate-widget-namespace.test.ts`; see its header for why
* fixtures never live in the repo tree.
*/

import { describe, it, expect, beforeEach, afterEach, vi } from 'vitest';
import { mkdtempSync, rmSync, writeFileSync } from 'node:fs';
import { join } from 'node:path';
import { tmpdir } from 'node:os';
import { validate } from '../commands/validate.js';

/**
* The CSI sequences chalk may add. The escape byte is built with
* `String.fromCharCode` rather than spelled into the source, so this file holds
* no raw control character and no escape a tooling pass could materialise into
* one (objectui AGENTS.md byte discipline).
*/
const ANSI = new RegExp(`${String.fromCharCode(27)}\\[[0-9;]*m`, 'g');

/**
* A menu whose item uses the divider spelling retired in objectui#6523. This
* is the document the finding was measured on: `MenuItemSchema` is a union, so
* its diagnosis rides the per-arm issues while the top-level issue stays at the
* root.
*/
const MENU_WITH_RETIRED_DIVIDER = {
type: 'dropdown-menu',
items: [{ label: 'New Tab', type: 'separator' }],
};

/** A document from an entirely foreign vocabulary — the other root producer. */
const FOREIGN_DOCUMENT = { type: 'module', main: './index.js' };

/**
* The non-root control, lifted from `validate-widget-namespace.test.ts` so both
* files pin the same observed path for the same input.
*/
const FORM_WITH_UNRESOLVABLE_WIDGET = {
type: 'form',
fields: [{ name: 'pw', widget: 'ui:password' }],
};

let dir: string;
let out: string[];
let exitCodes: number[];
let restore: () => void;

/** Everything the command printed, chalk colour codes stripped. */
function printed(): string {
return out.join('\n').replace(ANSI, '');
}

function writeSchema(name: string, schema: unknown): string {
const file = join(dir, name);
writeFileSync(file, JSON.stringify(schema, null, 2), 'utf-8');
return file;
}

beforeEach(() => {
dir = mkdtempSync(join(tmpdir(), 'objectui-validate-7004-'));
out = [];
exitCodes = [];
const originalLog = console.log;
const originalError = console.error;
const capture = (...args: unknown[]) => {
out.push(args.map(String).join(' '));
};
console.log = capture;
console.error = capture;
const exitSpy = vi.spyOn(process, 'exit').mockImplementation(((code?: number) => {
exitCodes.push(code ?? 0);
return undefined as never;
}) as never);
restore = () => {
console.log = originalLog;
console.error = originalError;
exitSpy.mockRestore();
};
});

afterEach(() => {
restore();
rmSync(dir, { recursive: true, force: true });
});

describe('objectui validate — a root-level issue says it is at the root', () => {
it('prints a Path line for the union failure that used to print none', async () => {
await validate(writeSchema('menu.json', MENU_WITH_RETIRED_DIVIDER));

expect(exitCodes).toEqual([1]);
const text = printed();
// The three fields, in the order the printer emits them. The middle one is
// the whole card: before this change the message and Code lines were
// adjacent, with nothing between them.
expect(text).toContain('1. Invalid input');
expect(text).toContain('Path: (root)');
expect(text).toContain('Code: invalid_union');
});

it('does the same for a document from a foreign vocabulary', async () => {
await validate(writeSchema('package.json', FOREIGN_DOCUMENT));

expect(exitCodes).toEqual([1]);
expect(printed()).toContain('Path: (root)');
});

it('gives EVERY reported issue a Path line, root or not', async () => {
// Structural rather than by-example: the defect was an absence, and the
// repair is "no numbered issue is ever printed without a Path". Asserting
// one example line would not catch a future guard reintroducing the hole
// on some other issue shape.
await validate(writeSchema('menu.json', MENU_WITH_RETIRED_DIVIDER));

const lines = printed().split('\n');
const numbered = lines
.map((line, i) => ({ line, i }))
.filter(({ line }) => /^\d+\. /.test(line.trim()));
expect(numbered.length).toBeGreaterThan(0);
for (const { line, i } of numbered) {
expect(
lines[i + 1]?.trim().startsWith('Path: '),
`issue "${line.trim()}" printed no Path line`,
).toBe(true);
}
});
});

describe('objectui validate — a real path is still a real path', () => {
it('prints the authored path unchanged, and does not call it the root', async () => {
// The guard against the fix that "passes" by printing (root) for
// everything.
await validate(writeSchema('form.json', FORM_WITH_UNRESOLVABLE_WIDGET));

expect(exitCodes).toEqual([1]);
const text = printed();
expect(text).toContain('Path: fields → 0 → widget');
expect(text).not.toContain('(root)');
});

it('still exits 0 and prints no Path line on a document that validates', async () => {
await validate(
writeSchema('ok.json', { type: 'form', fields: [{ name: 'pw', type: 'password' }] }),
);

expect(exitCodes).toEqual([0]);
const text = printed();
expect(text).toContain('Schema is valid!');
expect(text).not.toContain('Path:');
});
});

describe('objectui validate — the arm-selection half is deliberately NOT done here', () => {
/**
* ⚠️ This case pins a BOUNDARY, not a desired end state. objectui#7004 splits
* into the root-path line (done, above) and the question of whether a failing
* union should also surface its per-arm diagnoses — and if so, which arm's.
* The second is an author-facing diagnostic contract and is awaiting a
* maintainer ruling, so this file records that the printer walks only the
* top level today.
*
* When that ruling lands, this case is EXPECTED to change with it. It exists
* so the change is a deliberate edit rather than a silent widening.
*/
it('prints one top-level entry for a union, not the per-arm remediation text', async () => {
await validate(writeSchema('menu.json', MENU_WITH_RETIRED_DIVIDER));

const text = printed();
// The arm issues carry the objectui#6523 tombstone guidance. Nothing here
// reads `issue.errors`, so none of it is printed.
expect(text).not.toContain('RETIRED (objectui#6523)');
expect(text).not.toContain('Path: items');
// Exactly one numbered issue — an arm walk would multiply this.
const numbered = printed()
.split('\n')
.filter((line) => /^\d+\. /.test(line.trim()));
expect(numbered).toHaveLength(1);
});
});
27 changes: 24 additions & 3 deletions packages/cli/src/commands/validate.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -103,11 +103,32 @@ export async function validate(schemaPath: string) {
// undefined and this loop threw a TypeError that the catch below
// reported as "Error reading or parsing schema file", hiding the very
// errors this command exists to print.
// Every issue gets a Path line, INCLUDING a root-level one (objectui#7004).
//
// The guard here used to be `issue.path.length > 0`, which dropped the
// line entirely for `path: []` — silent in exactly the case a reader
// most needs oriented. That case is not rare: `safeValidateSchema` runs
// `AnyComponentSchema`, which is a `z.union` of every component arm, so
// ANY document matching no arm reports one top-level issue at the root
// (`invalid_union` · `Invalid input` · `path: []`). Measured before this
// change, a menu carrying the retired `{ type: 'separator' }` divider
// spelling printed `1. Invalid input` and a Code line, and nothing said
// whether the whole document or some node inside it had been judged.
//
// `(root)` is parenthesised so it cannot be read as a real key literally
// named `root` — a genuine path to one would print as `root`.
//
// ⛔ Scope: this prints the top-level issue's own path and NOTHING more.
// The other half of objectui#7004 — whether a failing union should also
// surface its per-arm diagnoses, and if so which arm's — is an
// author-facing diagnostic contract awaiting a maintainer ruling, so
// `issue.errors` is deliberately NOT walked here.
result.error.issues.forEach((issue, index) => {
console.error(chalk.red(`\n${index + 1}. ${issue.message}`));
if (issue.path && issue.path.length > 0) {
console.error(chalk.gray(` Path: ${issue.path.join(' → ')}`));
}
const path = issue.path ?? [];
console.error(
chalk.gray(` Path: ${path.length > 0 ? path.join(' → ') : '(root)'}`)
);
if (issue.code) {
console.error(chalk.gray(` Code: ${issue.code}`));
}
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions .changeset/7004-cli-root-path-line.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
---
'@object-ui/cli': patch
---

`objectui validate` now says when a validation issue sits at the document root
(objectui#7004, mechanical half).

The printer guarded its Path line with `issue.path.length > 0`, so an issue at
`path: []` printed no Path line at all — silent in exactly the case a reader
most needs oriented. That case is the common one, not an edge: the CLI validates
against `AnyComponentSchema`, a union over every component arm, so any document
matching no arm reports a single top-level issue (`invalid_union` · `Invalid
input` · root path). Authors saw a bare verdict on a whole document with nothing
saying which node had been judged:

```
1. Invalid input
Code: invalid_union
```

Every reported issue now carries a Path line; a root-level one reads
`Path: (root)`, parenthesised so it cannot be mistaken for a real key named
`root`. Non-root issues print their authored path exactly as before.

Scope: the printer still reads only top-level issues. Whether a failing union
should also surface its per-arm diagnoses — and if so which arm's — is an
author-facing diagnostic contract left open on objectui#7004 for a maintainer
ruling, and is deliberately not decided here.
210 changes: 210 additions & 0 deletions packages/cli/src/__tests__/validate-root-path-line.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,210 @@
/**
* ObjectUI
* Copyright (c) 2024-present ObjectStack Inc.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

/**
* `objectui validate` and the ROOT-LEVEL issue (objectui#7004, mechanical half).
*
* The printer used to guard its Path line with `issue.path.length > 0`, so an
* issue at the document root (`path: []`) printed no Path line at all — silent
* in precisely the case a reader most needs oriented.
*
* That case is the common one, not an edge: `safeValidateSchema` runs
* `AnyComponentSchema`, a `z.union` over every component arm, so any document
* matching no arm yields ONE top-level issue — `invalid_union` · `Invalid
* input` · `path: []`. Measured on the parent commit of this file, a menu
* carrying the retired `{ type: 'separator' }` divider spelling printed:
*
* 1. Invalid input
* Code: invalid_union
*
* — a bare verdict on a whole document, with nothing saying which node had
* been judged.
*
* ⚠️ These cases are written against BOTH sides of the guard on purpose. A fix
* that printed `(root)` unconditionally would satisfy a root-only test while
* destroying the real paths authors depend on, so the non-root control below
* is load-bearing, not decoration.
*
* Harness (fixtures under `os.tmpdir()`, `process.exit` recorded rather than
* taken) follows `validate-widget-namespace.test.ts`; see its header for why
* fixtures never live in the repo tree.
*/

import { describe, it, expect, beforeEach, afterEach, vi } from 'vitest';
import { mkdtempSync, rmSync, writeFileSync } from 'node:fs';
import { join } from 'node:path';
import { tmpdir } from 'node:os';
import { validate } from '../commands/validate.js';

/**
* The CSI sequences chalk may add. The escape byte is built with
* `String.fromCharCode` rather than spelled into the source, so this file holds
* no raw control character and no escape a tooling pass could materialise into
* one (objectui AGENTS.md byte discipline).
*/
const ANSI = new RegExp(`${String.fromCharCode(27)}\\[[0-9;]*m`, 'g');

/**
* A menu whose item uses the divider spelling retired in objectui#6523. This
* is the document the finding was measured on: `MenuItemSchema` is a union, so
* its diagnosis rides the per-arm issues while the top-level issue stays at the
* root.
*/
const MENU_WITH_RETIRED_DIVIDER = {
type: 'dropdown-menu',
items: [{ label: 'New Tab', type: 'separator' }],
};

/** A document from an entirely foreign vocabulary — the other root producer. */
const FOREIGN_DOCUMENT = { type: 'module', main: './index.js' };

/**
* The non-root control, lifted from `validate-widget-namespace.test.ts` so both
* files pin the same observed path for the same input.
*/
const FORM_WITH_UNRESOLVABLE_WIDGET = {
type: 'form',
fields: [{ name: 'pw', widget: 'ui:password' }],
};

let dir: string;
let out: string[];
let exitCodes: number[];
let restore: () => void;

/** Everything the command printed, chalk colour codes stripped. */
function printed(): string {
return out.join('\n').replace(ANSI, '');
}

function writeSchema(name: string, schema: unknown): string {
const file = join(dir, name);
writeFileSync(file, JSON.stringify(schema, null, 2), 'utf-8');
return file;
}

beforeEach(() => {
dir = mkdtempSync(join(tmpdir(), 'objectui-validate-7004-'));
out = [];
exitCodes = [];
const originalLog = console.log;
const originalError = console.error;
const capture = (...args: unknown[]) => {
out.push(args.map(String).join(' '));
};
console.log = capture;
console.error = capture;
const exitSpy = vi.spyOn(process, 'exit').mockImplementation(((code?: number) => {
exitCodes.push(code ?? 0);
return undefined as never;
}) as never);
restore = () => {
console.log = originalLog;
console.error = originalError;
exitSpy.mockRestore();
};
});

afterEach(() => {
restore();
rmSync(dir, { recursive: true, force: true });
});

describe('objectui validate — a root-level issue says it is at the root', () => {
it('prints a Path line for the union failure that used to print none', async () => {
await validate(writeSchema('menu.json', MENU_WITH_RETIRED_DIVIDER));

expect(exitCodes).toEqual([1]);
const text = printed();
// The three fields, in the order the printer emits them. The middle one is
// the whole card: before this change the message and Code lines were
// adjacent, with nothing between them.
expect(text).toContain('1. Invalid input');
expect(text).toContain('Path: (root)');
expect(text).toContain('Code: invalid_union');
});

it('does the same for a document from a foreign vocabulary', async () => {
await validate(writeSchema('package.json', FOREIGN_DOCUMENT));

expect(exitCodes).toEqual([1]);
expect(printed()).toContain('Path: (root)');
});

it('gives EVERY reported issue a Path line, root or not', async () => {
// Structural rather than by-example: the defect was an absence, and the
// repair is "no numbered issue is ever printed without a Path". Asserting
// one example line would not catch a future guard reintroducing the hole
// on some other issue shape.
await validate(writeSchema('menu.json', MENU_WITH_RETIRED_DIVIDER));

const lines = printed().split('\n');
const numbered = lines
.map((line, i) => ({ line, i }))
.filter(({ line }) => /^\d+\. /.test(line.trim()));
expect(numbered.length).toBeGreaterThan(0);
for (const { line, i } of numbered) {
expect(
lines[i + 1]?.trim().startsWith('Path: '),
`issue "${line.trim()}" printed no Path line`,
).toBe(true);
}
});
});

describe('objectui validate — a real path is still a real path', () => {
it('prints the authored path unchanged, and does not call it the root', async () => {
// The guard against the fix that "passes" by printing (root) for
// everything.
await validate(writeSchema('form.json', FORM_WITH_UNRESOLVABLE_WIDGET));

expect(exitCodes).toEqual([1]);
const text = printed();
expect(text).toContain('Path: fields → 0 → widget');
expect(text).not.toContain('(root)');
});

it('still exits 0 and prints no Path line on a document that validates', async () => {
await validate(
writeSchema('ok.json', { type: 'form', fields: [{ name: 'pw', type: 'password' }] }),
);

expect(exitCodes).toEqual([0]);
const text = printed();
expect(text).toContain('Schema is valid!');
expect(text).not.toContain('Path:');
});
});

describe('objectui validate — the arm-selection half is deliberately NOT done here', () => {
/**
* ⚠️ This case pins a BOUNDARY, not a desired end state. objectui#7004 splits
* into the root-path line (done, above) and the question of whether a failing
* union should also surface its per-arm diagnoses — and if so, which arm's.
* The second is an author-facing diagnostic contract and is awaiting a
* maintainer ruling, so this file records that the printer walks only the
* top level today.
*
* When that ruling lands, this case is EXPECTED to change with it. It exists
* so the change is a deliberate edit rather than a silent widening.
*/
it('prints one top-level entry for a union, not the per-arm remediation text', async () => {
await validate(writeSchema('menu.json', MENU_WITH_RETIRED_DIVIDER));

const text = printed();
// The arm issues carry the objectui#6523 tombstone guidance. Nothing here
// reads `issue.errors`, so none of it is printed.
expect(text).not.toContain('RETIRED (objectui#6523)');
expect(text).not.toContain('Path: items');
// Exactly one numbered issue — an arm walk would multiply this.
const numbered = printed()
.split('\n')
.filter((line) => /^\d+\. /.test(line.trim()));
expect(numbered).toHaveLength(1);
});
});
27 changes: 24 additions & 3 deletions packages/cli/src/commands/validate.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -103,11 +103,32 @@ export async function validate(schemaPath: string) {
// undefined and this loop threw a TypeError that the catch below
// reported as "Error reading or parsing schema file", hiding the very
// errors this command exists to print.
// Every issue gets a Path line, INCLUDING a root-level one (objectui#7004).
//
// The guard here used to be `issue.path.length > 0`, which dropped the
// line entirely for `path: []` — silent in exactly the case a reader
// most needs oriented. That case is not rare: `safeValidateSchema` runs
// `AnyComponentSchema`, which is a `z.union` of every component arm, so
// ANY document matching no arm reports one top-level issue at the root
// (`invalid_union` · `Invalid input` · `path: []`). Measured before this
// change, a menu carrying the retired `{ type: 'separator' }` divider
// spelling printed `1. Invalid input` and a Code line, and nothing said
// whether the whole document or some node inside it had been judged.
//
// `(root)` is parenthesised so it cannot be read as a real key literally
// named `root` — a genuine path to one would print as `root`.
//
// ⛔ Scope: this prints the top-level issue's own path and NOTHING more.
// The other half of objectui#7004 — whether a failing union should also
// surface its per-arm diagnoses, and if so which arm's — is an
// author-facing diagnostic contract awaiting a maintainer ruling, so
// `issue.errors` is deliberately NOT walked here.
result.error.issues.forEach((issue, index) => {
console.error(chalk.red(`\n${index + 1}. ${issue.message}`));
if (issue.path && issue.path.length > 0) {
console.error(chalk.gray(` Path: ${issue.path.join(' → ')}`));
}
const path = issue.path ?? [];
console.error(
chalk.gray(` Path: ${path.length > 0 ? path.join(' → ') : '(root)'}`)
);
if (issue.code) {
console.error(chalk.gray(` Code: ${issue.code}`));
}
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions .changeset/7004-cli-root-path-line.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
---
'@object-ui/cli': patch
---

`objectui validate` now says when a validation issue sits at the document root
(objectui#7004, mechanical half).

The printer guarded its Path line with `issue.path.length > 0`, so an issue at
`path: []` printed no Path line at all — silent in exactly the case a reader
most needs oriented. That case is the common one, not an edge: the CLI validates
against `AnyComponentSchema`, a union over every component arm, so any document
matching no arm reports a single top-level issue (`invalid_union` · `Invalid
input` · root path). Authors saw a bare verdict on a whole document with nothing
saying which node had been judged:

```
1. Invalid input
Code: invalid_union
```

Every reported issue now carries a Path line; a root-level one reads
`Path: (root)`, parenthesised so it cannot be mistaken for a real key named
`root`. Non-root issues print their authored path exactly as before.

Scope: the printer still reads only top-level issues. Whether a failing union
should also surface its per-arm diagnoses — and if so which arm's — is an
author-facing diagnostic contract left open on objectui#7004 for a maintainer
ruling, and is deliberately not decided here.
210 changes: 210 additions & 0 deletions packages/cli/src/__tests__/validate-root-path-line.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,210 @@
/**
* ObjectUI
* Copyright (c) 2024-present ObjectStack Inc.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

/**
* `objectui validate` and the ROOT-LEVEL issue (objectui#7004, mechanical half).
*
* The printer used to guard its Path line with `issue.path.length > 0`, so an
* issue at the document root (`path: []`) printed no Path line at all — silent
* in precisely the case a reader most needs oriented.
*
* That case is the common one, not an edge: `safeValidateSchema` runs
* `AnyComponentSchema`, a `z.union` over every component arm, so any document
* matching no arm yields ONE top-level issue — `invalid_union` · `Invalid
* input` · `path: []`. Measured on the parent commit of this file, a menu
* carrying the retired `{ type: 'separator' }` divider spelling printed:
*
* 1. Invalid input
* Code: invalid_union
*
* — a bare verdict on a whole document, with nothing saying which node had
* been judged.
*
* ⚠️ These cases are written against BOTH sides of the guard on purpose. A fix
* that printed `(root)` unconditionally would satisfy a root-only test while
* destroying the real paths authors depend on, so the non-root control below
* is load-bearing, not decoration.
*
* Harness (fixtures under `os.tmpdir()`, `process.exit` recorded rather than
* taken) follows `validate-widget-namespace.test.ts`; see its header for why
* fixtures never live in the repo tree.
*/

import { describe, it, expect, beforeEach, afterEach, vi } from 'vitest';
import { mkdtempSync, rmSync, writeFileSync } from 'node:fs';
import { join } from 'node:path';
import { tmpdir } from 'node:os';
import { validate } from '../commands/validate.js';

/**
* The CSI sequences chalk may add. The escape byte is built with
* `String.fromCharCode` rather than spelled into the source, so this file holds
* no raw control character and no escape a tooling pass could materialise into
* one (objectui AGENTS.md byte discipline).
*/
const ANSI = new RegExp(`${String.fromCharCode(27)}\\[[0-9;]*m`, 'g');

/**
* A menu whose item uses the divider spelling retired in objectui#6523. This
* is the document the finding was measured on: `MenuItemSchema` is a union, so
* its diagnosis rides the per-arm issues while the top-level issue stays at the
* root.
*/
const MENU_WITH_RETIRED_DIVIDER = {
type: 'dropdown-menu',
items: [{ label: 'New Tab', type: 'separator' }],
};

/** A document from an entirely foreign vocabulary — the other root producer. */
const FOREIGN_DOCUMENT = { type: 'module', main: './index.js' };

/**
* The non-root control, lifted from `validate-widget-namespace.test.ts` so both
* files pin the same observed path for the same input.
*/
const FORM_WITH_UNRESOLVABLE_WIDGET = {
type: 'form',
fields: [{ name: 'pw', widget: 'ui:password' }],
};

let dir: string;
let out: string[];
let exitCodes: number[];
let restore: () => void;

/** Everything the command printed, chalk colour codes stripped. */
function printed(): string {
return out.join('\n').replace(ANSI, '');
}

function writeSchema(name: string, schema: unknown): string {
const file = join(dir, name);
writeFileSync(file, JSON.stringify(schema, null, 2), 'utf-8');
return file;
}

beforeEach(() => {
dir = mkdtempSync(join(tmpdir(), 'objectui-validate-7004-'));
out = [];
exitCodes = [];
const originalLog = console.log;
const originalError = console.error;
const capture = (...args: unknown[]) => {
out.push(args.map(String).join(' '));
};
console.log = capture;
console.error = capture;
const exitSpy = vi.spyOn(process, 'exit').mockImplementation(((code?: number) => {
exitCodes.push(code ?? 0);
return undefined as never;
}) as never);
restore = () => {
console.log = originalLog;
console.error = originalError;
exitSpy.mockRestore();
};
});

afterEach(() => {
restore();
rmSync(dir, { recursive: true, force: true });
});

describe('objectui validate — a root-level issue says it is at the root', () => {
it('prints a Path line for the union failure that used to print none', async () => {
await validate(writeSchema('menu.json', MENU_WITH_RETIRED_DIVIDER));

expect(exitCodes).toEqual([1]);
const text = printed();
// The three fields, in the order the printer emits them. The middle one is
// the whole card: before this change the message and Code lines were
// adjacent, with nothing between them.
expect(text).toContain('1. Invalid input');
expect(text).toContain('Path: (root)');
expect(text).toContain('Code: invalid_union');
});

it('does the same for a document from a foreign vocabulary', async () => {
await validate(writeSchema('package.json', FOREIGN_DOCUMENT));

expect(exitCodes).toEqual([1]);
expect(printed()).toContain('Path: (root)');
});

it('gives EVERY reported issue a Path line, root or not', async () => {
// Structural rather than by-example: the defect was an absence, and the
// repair is "no numbered issue is ever printed without a Path". Asserting
// one example line would not catch a future guard reintroducing the hole
// on some other issue shape.
await validate(writeSchema('menu.json', MENU_WITH_RETIRED_DIVIDER));

const lines = printed().split('\n');
const numbered = lines
.map((line, i) => ({ line, i }))
.filter(({ line }) => /^\d+\. /.test(line.trim()));
expect(numbered.length).toBeGreaterThan(0);
for (const { line, i } of numbered) {
expect(
lines[i + 1]?.trim().startsWith('Path: '),
`issue "${line.trim()}" printed no Path line`,
).toBe(true);
}
});
});

describe('objectui validate — a real path is still a real path', () => {
it('prints the authored path unchanged, and does not call it the root', async () => {
// The guard against the fix that "passes" by printing (root) for
// everything.
await validate(writeSchema('form.json', FORM_WITH_UNRESOLVABLE_WIDGET));

expect(exitCodes).toEqual([1]);
const text = printed();
expect(text).toContain('Path: fields → 0 → widget');
expect(text).not.toContain('(root)');
});

it('still exits 0 and prints no Path line on a document that validates', async () => {
await validate(
writeSchema('ok.json', { type: 'form', fields: [{ name: 'pw', type: 'password' }] }),
);

expect(exitCodes).toEqual([0]);
const text = printed();
expect(text).toContain('Schema is valid!');
expect(text).not.toContain('Path:');
});
});

describe('objectui validate — the arm-selection half is deliberately NOT done here', () => {
/**
* ⚠️ This case pins a BOUNDARY, not a desired end state. objectui#7004 splits
* into the root-path line (done, above) and the question of whether a failing
* union should also surface its per-arm diagnoses — and if so, which arm's.
* The second is an author-facing diagnostic contract and is awaiting a
* maintainer ruling, so this file records that the printer walks only the
* top level today.
*
* When that ruling lands, this case is EXPECTED to change with it. It exists
* so the change is a deliberate edit rather than a silent widening.
*/
it('prints one top-level entry for a union, not the per-arm remediation text', async () => {
await validate(writeSchema('menu.json', MENU_WITH_RETIRED_DIVIDER));

const text = printed();
// The arm issues carry the objectui#6523 tombstone guidance. Nothing here
// reads `issue.errors`, so none of it is printed.
expect(text).not.toContain('RETIRED (objectui#6523)');
expect(text).not.toContain('Path: items');
// Exactly one numbered issue — an arm walk would multiply this.
const numbered = printed()
.split('\n')
.filter((line) => /^\d+\. /.test(line.trim()));
expect(numbered).toHaveLength(1);
});
});
27 changes: 24 additions & 3 deletions packages/cli/src/commands/validate.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -103,11 +103,32 @@ export async function validate(schemaPath: string) {
// undefined and this loop threw a TypeError that the catch below
// reported as "Error reading or parsing schema file", hiding the very
// errors this command exists to print.
// Every issue gets a Path line, INCLUDING a root-level one (objectui#7004).
//
// The guard here used to be `issue.path.length > 0`, which dropped the
// line entirely for `path: []` — silent in exactly the case a reader
// most needs oriented. That case is not rare: `safeValidateSchema` runs
// `AnyComponentSchema`, which is a `z.union` of every component arm, so
// ANY document matching no arm reports one top-level issue at the root
// (`invalid_union` · `Invalid input` · `path: []`). Measured before this
// change, a menu carrying the retired `{ type: 'separator' }` divider
// spelling printed `1. Invalid input` and a Code line, and nothing said
// whether the whole document or some node inside it had been judged.
//
// `(root)` is parenthesised so it cannot be read as a real key literally
// named `root` — a genuine path to one would print as `root`.
//
// ⛔ Scope: this prints the top-level issue's own path and NOTHING more.
// The other half of objectui#7004 — whether a failing union should also
// surface its per-arm diagnoses, and if so which arm's — is an
// author-facing diagnostic contract awaiting a maintainer ruling, so
// `issue.errors` is deliberately NOT walked here.
result.error.issues.forEach((issue, index) => {
console.error(chalk.red(`\n${index + 1}. ${issue.message}`));
if (issue.path && issue.path.length > 0) {
console.error(chalk.gray(` Path: ${issue.path.join(' → ')}`));
}
const path = issue.path ?? [];
console.error(
chalk.gray(` Path: ${path.length > 0 ? path.join(' → ') : '(root)'}`)
);
if (issue.code) {
console.error(chalk.gray(` Code: ${issue.code}`));
}
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions .changeset/7004-cli-root-path-line.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
---
'@object-ui/cli': patch
---

`objectui validate` now says when a validation issue sits at the document root
(objectui#7004, mechanical half).

The printer guarded its Path line with `issue.path.length > 0`, so an issue at
`path: []` printed no Path line at all — silent in exactly the case a reader
most needs oriented. That case is the common one, not an edge: the CLI validates
against `AnyComponentSchema`, a union over every component arm, so any document
matching no arm reports a single top-level issue (`invalid_union` · `Invalid
input` · root path). Authors saw a bare verdict on a whole document with nothing
saying which node had been judged:

```
1. Invalid input
Code: invalid_union
```

Every reported issue now carries a Path line; a root-level one reads
`Path: (root)`, parenthesised so it cannot be mistaken for a real key named
`root`. Non-root issues print their authored path exactly as before.

Scope: the printer still reads only top-level issues. Whether a failing union
should also surface its per-arm diagnoses — and if so which arm's — is an
author-facing diagnostic contract left open on objectui#7004 for a maintainer
ruling, and is deliberately not decided here.
210 changes: 210 additions & 0 deletions packages/cli/src/__tests__/validate-root-path-line.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,210 @@
/**
* ObjectUI
* Copyright (c) 2024-present ObjectStack Inc.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

/**
* `objectui validate` and the ROOT-LEVEL issue (objectui#7004, mechanical half).
*
* The printer used to guard its Path line with `issue.path.length > 0`, so an
* issue at the document root (`path: []`) printed no Path line at all — silent
* in precisely the case a reader most needs oriented.
*
* That case is the common one, not an edge: `safeValidateSchema` runs
* `AnyComponentSchema`, a `z.union` over every component arm, so any document
* matching no arm yields ONE top-level issue — `invalid_union` · `Invalid
* input` · `path: []`. Measured on the parent commit of this file, a menu
* carrying the retired `{ type: 'separator' }` divider spelling printed:
*
* 1. Invalid input
* Code: invalid_union
*
* — a bare verdict on a whole document, with nothing saying which node had
* been judged.
*
* ⚠️ These cases are written against BOTH sides of the guard on purpose. A fix
* that printed `(root)` unconditionally would satisfy a root-only test while
* destroying the real paths authors depend on, so the non-root control below
* is load-bearing, not decoration.
*
* Harness (fixtures under `os.tmpdir()`, `process.exit` recorded rather than
* taken) follows `validate-widget-namespace.test.ts`; see its header for why
* fixtures never live in the repo tree.
*/

import { describe, it, expect, beforeEach, afterEach, vi } from 'vitest';
import { mkdtempSync, rmSync, writeFileSync } from 'node:fs';
import { join } from 'node:path';
import { tmpdir } from 'node:os';
import { validate } from '../commands/validate.js';

/**
* The CSI sequences chalk may add. The escape byte is built with
* `String.fromCharCode` rather than spelled into the source, so this file holds
* no raw control character and no escape a tooling pass could materialise into
* one (objectui AGENTS.md byte discipline).
*/
const ANSI = new RegExp(`${String.fromCharCode(27)}\\[[0-9;]*m`, 'g');

/**
* A menu whose item uses the divider spelling retired in objectui#6523. This
* is the document the finding was measured on: `MenuItemSchema` is a union, so
* its diagnosis rides the per-arm issues while the top-level issue stays at the
* root.
*/
const MENU_WITH_RETIRED_DIVIDER = {
type: 'dropdown-menu',
items: [{ label: 'New Tab', type: 'separator' }],
};

/** A document from an entirely foreign vocabulary — the other root producer. */
const FOREIGN_DOCUMENT = { type: 'module', main: './index.js' };

/**
* The non-root control, lifted from `validate-widget-namespace.test.ts` so both
* files pin the same observed path for the same input.
*/
const FORM_WITH_UNRESOLVABLE_WIDGET = {
type: 'form',
fields: [{ name: 'pw', widget: 'ui:password' }],
};

let dir: string;
let out: string[];
let exitCodes: number[];
let restore: () => void;

/** Everything the command printed, chalk colour codes stripped. */
function printed(): string {
return out.join('\n').replace(ANSI, '');
}

function writeSchema(name: string, schema: unknown): string {
const file = join(dir, name);
writeFileSync(file, JSON.stringify(schema, null, 2), 'utf-8');
return file;
}

beforeEach(() => {
dir = mkdtempSync(join(tmpdir(), 'objectui-validate-7004-'));
out = [];
exitCodes = [];
const originalLog = console.log;
const originalError = console.error;
const capture = (...args: unknown[]) => {
out.push(args.map(String).join(' '));
};
console.log = capture;
console.error = capture;
const exitSpy = vi.spyOn(process, 'exit').mockImplementation(((code?: number) => {
exitCodes.push(code ?? 0);
return undefined as never;
}) as never);
restore = () => {
console.log = originalLog;
console.error = originalError;
exitSpy.mockRestore();
};
});

afterEach(() => {
restore();
rmSync(dir, { recursive: true, force: true });
});

describe('objectui validate — a root-level issue says it is at the root', () => {
it('prints a Path line for the union failure that used to print none', async () => {
await validate(writeSchema('menu.json', MENU_WITH_RETIRED_DIVIDER));

expect(exitCodes).toEqual([1]);
const text = printed();
// The three fields, in the order the printer emits them. The middle one is
// the whole card: before this change the message and Code lines were
// adjacent, with nothing between them.
expect(text).toContain('1. Invalid input');
expect(text).toContain('Path: (root)');
expect(text).toContain('Code: invalid_union');
});

it('does the same for a document from a foreign vocabulary', async () => {
await validate(writeSchema('package.json', FOREIGN_DOCUMENT));

expect(exitCodes).toEqual([1]);
expect(printed()).toContain('Path: (root)');
});

it('gives EVERY reported issue a Path line, root or not', async () => {
// Structural rather than by-example: the defect was an absence, and the
// repair is "no numbered issue is ever printed without a Path". Asserting
// one example line would not catch a future guard reintroducing the hole
// on some other issue shape.
await validate(writeSchema('menu.json', MENU_WITH_RETIRED_DIVIDER));

const lines = printed().split('\n');
const numbered = lines
.map((line, i) => ({ line, i }))
.filter(({ line }) => /^\d+\. /.test(line.trim()));
expect(numbered.length).toBeGreaterThan(0);
for (const { line, i } of numbered) {
expect(
lines[i + 1]?.trim().startsWith('Path: '),
`issue "${line.trim()}" printed no Path line`,
).toBe(true);
}
});
});

describe('objectui validate — a real path is still a real path', () => {
it('prints the authored path unchanged, and does not call it the root', async () => {
// The guard against the fix that "passes" by printing (root) for
// everything.
await validate(writeSchema('form.json', FORM_WITH_UNRESOLVABLE_WIDGET));

expect(exitCodes).toEqual([1]);
const text = printed();
expect(text).toContain('Path: fields → 0 → widget');
expect(text).not.toContain('(root)');
});

it('still exits 0 and prints no Path line on a document that validates', async () => {
await validate(
writeSchema('ok.json', { type: 'form', fields: [{ name: 'pw', type: 'password' }] }),
);

expect(exitCodes).toEqual([0]);
const text = printed();
expect(text).toContain('Schema is valid!');
expect(text).not.toContain('Path:');
});
});

describe('objectui validate — the arm-selection half is deliberately NOT done here', () => {
/**
* ⚠️ This case pins a BOUNDARY, not a desired end state. objectui#7004 splits
* into the root-path line (done, above) and the question of whether a failing
* union should also surface its per-arm diagnoses — and if so, which arm's.
* The second is an author-facing diagnostic contract and is awaiting a
* maintainer ruling, so this file records that the printer walks only the
* top level today.
*
* When that ruling lands, this case is EXPECTED to change with it. It exists
* so the change is a deliberate edit rather than a silent widening.
*/
it('prints one top-level entry for a union, not the per-arm remediation text', async () => {
await validate(writeSchema('menu.json', MENU_WITH_RETIRED_DIVIDER));

const text = printed();
// The arm issues carry the objectui#6523 tombstone guidance. Nothing here
// reads `issue.errors`, so none of it is printed.
expect(text).not.toContain('RETIRED (objectui#6523)');
expect(text).not.toContain('Path: items');
// Exactly one numbered issue — an arm walk would multiply this.
const numbered = printed()
.split('\n')
.filter((line) => /^\d+\. /.test(line.trim()));
expect(numbered).toHaveLength(1);
});
});
27 changes: 24 additions & 3 deletions packages/cli/src/commands/validate.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -103,11 +103,32 @@ export async function validate(schemaPath: string) {
// undefined and this loop threw a TypeError that the catch below
// reported as "Error reading or parsing schema file", hiding the very
// errors this command exists to print.
// Every issue gets a Path line, INCLUDING a root-level one (objectui#7004).
//
// The guard here used to be `issue.path.length > 0`, which dropped the
// line entirely for `path: []` — silent in exactly the case a reader
// most needs oriented. That case is not rare: `safeValidateSchema` runs
// `AnyComponentSchema`, which is a `z.union` of every component arm, so
// ANY document matching no arm reports one top-level issue at the root
// (`invalid_union` · `Invalid input` · `path: []`). Measured before this
// change, a menu carrying the retired `{ type: 'separator' }` divider
// spelling printed `1. Invalid input` and a Code line, and nothing said
// whether the whole document or some node inside it had been judged.
//
// `(root)` is parenthesised so it cannot be read as a real key literally
// named `root` — a genuine path to one would print as `root`.
//
// ⛔ Scope: this prints the top-level issue's own path and NOTHING more.
// The other half of objectui#7004 — whether a failing union should also
// surface its per-arm diagnoses, and if so which arm's — is an
// author-facing diagnostic contract awaiting a maintainer ruling, so
// `issue.errors` is deliberately NOT walked here.
result.error.issues.forEach((issue, index) => {
console.error(chalk.red(`\n${index + 1}. ${issue.message}`));
if (issue.path && issue.path.length > 0) {
console.error(chalk.gray(` Path: ${issue.path.join(' → ')}`));
}
const path = issue.path ?? [];
console.error(
chalk.gray(` Path: ${path.length > 0 ? path.join(' → ') : '(root)'}`)
);
if (issue.code) {
console.error(chalk.gray(` Code: ${issue.code}`));
}
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions .changeset/7004-cli-root-path-line.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
---
'@object-ui/cli': patch
---

`objectui validate` now says when a validation issue sits at the document root
(objectui#7004, mechanical half).

The printer guarded its Path line with `issue.path.length > 0`, so an issue at
`path: []` printed no Path line at all — silent in exactly the case a reader
most needs oriented. That case is the common one, not an edge: the CLI validates
against `AnyComponentSchema`, a union over every component arm, so any document
matching no arm reports a single top-level issue (`invalid_union` · `Invalid
input` · root path). Authors saw a bare verdict on a whole document with nothing
saying which node had been judged:

```
1. Invalid input
Code: invalid_union
```

Every reported issue now carries a Path line; a root-level one reads
`Path: (root)`, parenthesised so it cannot be mistaken for a real key named
`root`. Non-root issues print their authored path exactly as before.

Scope: the printer still reads only top-level issues. Whether a failing union
should also surface its per-arm diagnoses — and if so which arm's — is an
author-facing diagnostic contract left open on objectui#7004 for a maintainer
ruling, and is deliberately not decided here.
210 changes: 210 additions & 0 deletions packages/cli/src/__tests__/validate-root-path-line.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,210 @@
/**
* ObjectUI
* Copyright (c) 2024-present ObjectStack Inc.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

/**
* `objectui validate` and the ROOT-LEVEL issue (objectui#7004, mechanical half).
*
* The printer used to guard its Path line with `issue.path.length > 0`, so an
* issue at the document root (`path: []`) printed no Path line at all — silent
* in precisely the case a reader most needs oriented.
*
* That case is the common one, not an edge: `safeValidateSchema` runs
* `AnyComponentSchema`, a `z.union` over every component arm, so any document
* matching no arm yields ONE top-level issue — `invalid_union` · `Invalid
* input` · `path: []`. Measured on the parent commit of this file, a menu
* carrying the retired `{ type: 'separator' }` divider spelling printed:
*
* 1. Invalid input
* Code: invalid_union
*
* — a bare verdict on a whole document, with nothing saying which node had
* been judged.
*
* ⚠️ These cases are written against BOTH sides of the guard on purpose. A fix
* that printed `(root)` unconditionally would satisfy a root-only test while
* destroying the real paths authors depend on, so the non-root control below
* is load-bearing, not decoration.
*
* Harness (fixtures under `os.tmpdir()`, `process.exit` recorded rather than
* taken) follows `validate-widget-namespace.test.ts`; see its header for why
* fixtures never live in the repo tree.
*/

import { describe, it, expect, beforeEach, afterEach, vi } from 'vitest';
import { mkdtempSync, rmSync, writeFileSync } from 'node:fs';
import { join } from 'node:path';
import { tmpdir } from 'node:os';
import { validate } from '../commands/validate.js';

/**
* The CSI sequences chalk may add. The escape byte is built with
* `String.fromCharCode` rather than spelled into the source, so this file holds
* no raw control character and no escape a tooling pass could materialise into
* one (objectui AGENTS.md byte discipline).
*/
const ANSI = new RegExp(`${String.fromCharCode(27)}\\[[0-9;]*m`, 'g');

/**
* A menu whose item uses the divider spelling retired in objectui#6523. This
* is the document the finding was measured on: `MenuItemSchema` is a union, so
* its diagnosis rides the per-arm issues while the top-level issue stays at the
* root.
*/
const MENU_WITH_RETIRED_DIVIDER = {
type: 'dropdown-menu',
items: [{ label: 'New Tab', type: 'separator' }],
};

/** A document from an entirely foreign vocabulary — the other root producer. */
const FOREIGN_DOCUMENT = { type: 'module', main: './index.js' };

/**
* The non-root control, lifted from `validate-widget-namespace.test.ts` so both
* files pin the same observed path for the same input.
*/
const FORM_WITH_UNRESOLVABLE_WIDGET = {
type: 'form',
fields: [{ name: 'pw', widget: 'ui:password' }],
};

let dir: string;
let out: string[];
let exitCodes: number[];
let restore: () => void;

/** Everything the command printed, chalk colour codes stripped. */
function printed(): string {
return out.join('\n').replace(ANSI, '');
}

function writeSchema(name: string, schema: unknown): string {
const file = join(dir, name);
writeFileSync(file, JSON.stringify(schema, null, 2), 'utf-8');
return file;
}

beforeEach(() => {
dir = mkdtempSync(join(tmpdir(), 'objectui-validate-7004-'));
out = [];
exitCodes = [];
const originalLog = console.log;
const originalError = console.error;
const capture = (...args: unknown[]) => {
out.push(args.map(String).join(' '));
};
console.log = capture;
console.error = capture;
const exitSpy = vi.spyOn(process, 'exit').mockImplementation(((code?: number) => {
exitCodes.push(code ?? 0);
return undefined as never;
}) as never);
restore = () => {
console.log = originalLog;
console.error = originalError;
exitSpy.mockRestore();
};
});

afterEach(() => {
restore();
rmSync(dir, { recursive: true, force: true });
});

describe('objectui validate — a root-level issue says it is at the root', () => {
it('prints a Path line for the union failure that used to print none', async () => {
await validate(writeSchema('menu.json', MENU_WITH_RETIRED_DIVIDER));

expect(exitCodes).toEqual([1]);
const text = printed();
// The three fields, in the order the printer emits them. The middle one is
// the whole card: before this change the message and Code lines were
// adjacent, with nothing between them.
expect(text).toContain('1. Invalid input');
expect(text).toContain('Path: (root)');
expect(text).toContain('Code: invalid_union');
});

it('does the same for a document from a foreign vocabulary', async () => {
await validate(writeSchema('package.json', FOREIGN_DOCUMENT));

expect(exitCodes).toEqual([1]);
expect(printed()).toContain('Path: (root)');
});

it('gives EVERY reported issue a Path line, root or not', async () => {
// Structural rather than by-example: the defect was an absence, and the
// repair is "no numbered issue is ever printed without a Path". Asserting
// one example line would not catch a future guard reintroducing the hole
// on some other issue shape.
await validate(writeSchema('menu.json', MENU_WITH_RETIRED_DIVIDER));

const lines = printed().split('\n');
const numbered = lines
.map((line, i) => ({ line, i }))
.filter(({ line }) => /^\d+\. /.test(line.trim()));
expect(numbered.length).toBeGreaterThan(0);
for (const { line, i } of numbered) {
expect(
lines[i + 1]?.trim().startsWith('Path: '),
`issue "${line.trim()}" printed no Path line`,
).toBe(true);
}
});
});

describe('objectui validate — a real path is still a real path', () => {
it('prints the authored path unchanged, and does not call it the root', async () => {
// The guard against the fix that "passes" by printing (root) for
// everything.
await validate(writeSchema('form.json', FORM_WITH_UNRESOLVABLE_WIDGET));

expect(exitCodes).toEqual([1]);
const text = printed();
expect(text).toContain('Path: fields → 0 → widget');
expect(text).not.toContain('(root)');
});

it('still exits 0 and prints no Path line on a document that validates', async () => {
await validate(
writeSchema('ok.json', { type: 'form', fields: [{ name: 'pw', type: 'password' }] }),
);

expect(exitCodes).toEqual([0]);
const text = printed();
expect(text).toContain('Schema is valid!');
expect(text).not.toContain('Path:');
});
});

describe('objectui validate — the arm-selection half is deliberately NOT done here', () => {
/**
* ⚠️ This case pins a BOUNDARY, not a desired end state. objectui#7004 splits
* into the root-path line (done, above) and the question of whether a failing
* union should also surface its per-arm diagnoses — and if so, which arm's.
* The second is an author-facing diagnostic contract and is awaiting a
* maintainer ruling, so this file records that the printer walks only the
* top level today.
*
* When that ruling lands, this case is EXPECTED to change with it. It exists
* so the change is a deliberate edit rather than a silent widening.
*/
it('prints one top-level entry for a union, not the per-arm remediation text', async () => {
await validate(writeSchema('menu.json', MENU_WITH_RETIRED_DIVIDER));

const text = printed();
// The arm issues carry the objectui#6523 tombstone guidance. Nothing here
// reads `issue.errors`, so none of it is printed.
expect(text).not.toContain('RETIRED (objectui#6523)');
expect(text).not.toContain('Path: items');
// Exactly one numbered issue — an arm walk would multiply this.
const numbered = printed()
.split('\n')
.filter((line) => /^\d+\. /.test(line.trim()));
expect(numbered).toHaveLength(1);
});
});
27 changes: 24 additions & 3 deletions packages/cli/src/commands/validate.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -103,11 +103,32 @@ export async function validate(schemaPath: string) {
// undefined and this loop threw a TypeError that the catch below
// reported as "Error reading or parsing schema file", hiding the very
// errors this command exists to print.
// Every issue gets a Path line, INCLUDING a root-level one (objectui#7004).
//
// The guard here used to be `issue.path.length > 0`, which dropped the
// line entirely for `path: []` — silent in exactly the case a reader
// most needs oriented. That case is not rare: `safeValidateSchema` runs
// `AnyComponentSchema`, which is a `z.union` of every component arm, so
// ANY document matching no arm reports one top-level issue at the root
// (`invalid_union` · `Invalid input` · `path: []`). Measured before this
// change, a menu carrying the retired `{ type: 'separator' }` divider
// spelling printed `1. Invalid input` and a Code line, and nothing said
// whether the whole document or some node inside it had been judged.
//
// `(root)` is parenthesised so it cannot be read as a real key literally
// named `root` — a genuine path to one would print as `root`.
//
// ⛔ Scope: this prints the top-level issue's own path and NOTHING more.
// The other half of objectui#7004 — whether a failing union should also
// surface its per-arm diagnoses, and if so which arm's — is an
// author-facing diagnostic contract awaiting a maintainer ruling, so
// `issue.errors` is deliberately NOT walked here.
result.error.issues.forEach((issue, index) => {
console.error(chalk.red(`\n${index + 1}. ${issue.message}`));
if (issue.path && issue.path.length > 0) {
console.error(chalk.gray(` Path: ${issue.path.join(' → ')}`));
}
const path = issue.path ?? [];
console.error(
chalk.gray(` Path: ${path.length > 0 ? path.join(' → ') : '(root)'}`)
);
if (issue.code) {
console.error(chalk.gray(` Code: ${issue.code}`));
}
Expand Down
Loading