Refactor project name from "Open Claude Design" to "Open Design" (#1)
* Refactor project name from "Open Claude Design" to "Open Design" - Updated project name in package.json, package-lock.json, and README files. - Changed CLI commands and references from "ocd" to "od". - Adjusted file structure references in documentation and code to reflect new naming conventions. - Enhanced .gitignore to include new runtime data files. - Updated metadata in LICENSE file to match new project name. * Add contributing guidelines in English and Chinese - Introduced CONTRIBUTING.md and CONTRIBUTING.zh-CN.md to provide clear instructions for contributors. - Outlined contribution types, local setup instructions, and merging criteria for skills and design systems. - Enhanced README files to reference the new contributing guidelines.
This commit is contained in:
Tom Huang
+3
-3
@@ -2,7 +2,7 @@
|
||||
import { startServer } from './server.js';
|
||||
|
||||
const args = process.argv.slice(2);
|
||||
let port = Number(process.env.OCD_PORT) || 7456;
|
||||
let port = Number(process.env.OD_PORT) || 7456;
|
||||
let open = true;
|
||||
|
||||
for (let i = 0; i < args.length; i++) {
|
||||
@@ -12,7 +12,7 @@ for (let i = 0; i < args.length; i++) {
|
||||
} else if (a === '--no-open') {
|
||||
open = false;
|
||||
} else if (a === '-h' || a === '--help') {
|
||||
console.log(`Usage: ocd [--port <n>] [--no-open]
|
||||
console.log(`Usage: od [--port <n>] [--no-open]
|
||||
|
||||
Starts a local daemon that:
|
||||
* scans PATH for installed code-agent CLIs (claude, codex, gemini, opencode, cursor-agent, ...)
|
||||
@@ -24,7 +24,7 @@ Starts a local daemon that:
|
||||
}
|
||||
|
||||
startServer({ port }).then(url => {
|
||||
console.log(`[ocd] listening on ${url}`);
|
||||
console.log(`[od] listening on ${url}`);
|
||||
if (open) {
|
||||
const opener = process.platform === 'darwin' ? 'open'
|
||||
: process.platform === 'win32' ? 'start'
|
||||
|
||||
+2
-2
@@ -1,6 +1,6 @@
|
||||
// SQLite-backed persistence for projects, conversations, messages, and the
|
||||
// per-project set of open file tabs. The on-disk project folder under
|
||||
// .ocd/projects/<id>/ is still the single owner of the user's actual files
|
||||
// .od/projects/<id>/ is still the single owner of the user's actual files
|
||||
// (HTML artifacts, sketches, uploads); this database tracks the metadata
|
||||
// that used to live in localStorage.
|
||||
|
||||
@@ -12,7 +12,7 @@ let dbInstance = null;
|
||||
|
||||
export function openDatabase(projectRoot) {
|
||||
if (dbInstance) return dbInstance;
|
||||
const dir = path.join(projectRoot, '.ocd');
|
||||
const dir = path.join(projectRoot, '.od');
|
||||
fs.mkdirSync(dir, { recursive: true });
|
||||
const file = path.join(dir, 'app.sqlite');
|
||||
const db = new Database(file);
|
||||
|
||||
@@ -143,7 +143,7 @@ export function lintArtifact(rawHtml) {
|
||||
severity: 'P0',
|
||||
id: 'left-accent-card',
|
||||
message: 'Rounded card with a coloured left border — the canonical AI-slop card pattern.',
|
||||
fix: 'Drop either the border-radius (set 0px) or the border-left. Cards in the OCD seed use hairline borders all-round, no left accent.',
|
||||
fix: 'Drop either the border-radius (set 0px) or the border-left. Cards in the OD seed use hairline borders all-round, no left accent.',
|
||||
snippet: clip(lam[0]),
|
||||
});
|
||||
}
|
||||
@@ -262,19 +262,19 @@ export function lintArtifact(rawHtml) {
|
||||
}
|
||||
|
||||
// ── P2-1: missing comment-mode anchor on <section> ────────────────
|
||||
// Either `data-ocd-id` (web/mobile prototypes) or `data-screen-label`
|
||||
// Either `data-od-id` (web/mobile prototypes) or `data-screen-label`
|
||||
// (decks) counts. Whichever the artifact uses, every <section> should
|
||||
// carry one so the chat layer can target it.
|
||||
const sections = html.match(/<section\b[^>]*>/gi) ?? [];
|
||||
const tagged = sections.filter(
|
||||
(s) => /data-ocd-id\s*=/.test(s) || /data-screen-label\s*=/.test(s),
|
||||
(s) => /data-od-id\s*=/.test(s) || /data-screen-label\s*=/.test(s),
|
||||
).length;
|
||||
if (sections.length > 0 && tagged < sections.length) {
|
||||
out.push({
|
||||
severity: 'P2',
|
||||
id: 'missing-section-anchor',
|
||||
message: `${sections.length - tagged} of ${sections.length} <section>s lack data-ocd-id (or data-screen-label).`,
|
||||
fix: 'Add data-ocd-id="kebab-slug" (or data-screen-label="01 Cover" for slides) to every top-level <section> so comment mode can target it.',
|
||||
message: `${sections.length - tagged} of ${sections.length} <section>s lack data-od-id (or data-screen-label).`,
|
||||
fix: 'Add data-od-id="kebab-slug" (or data-screen-label="01 Cover" for slides) to every top-level <section> so comment mode can target it.',
|
||||
});
|
||||
}
|
||||
|
||||
|
||||
+1
-1
@@ -1,5 +1,5 @@
|
||||
// Project files registry. Each project is a folder under
|
||||
// <projectRoot>/.ocd/projects/<projectId>/. The frontend's project list
|
||||
// <projectRoot>/.od/projects/<projectId>/. The frontend's project list
|
||||
// (localStorage) carries metadata; this module is the single owner of the
|
||||
// on-disk content (HTML artifacts, sketches, uploaded images, pasted text).
|
||||
//
|
||||
|
||||
+4
-4
@@ -50,11 +50,11 @@ const PROJECT_ROOT = path.resolve(__dirname, '..');
|
||||
const STATIC_DIR = path.join(PROJECT_ROOT, 'dist');
|
||||
const SKILLS_DIR = path.join(PROJECT_ROOT, 'skills');
|
||||
const DESIGN_SYSTEMS_DIR = path.join(PROJECT_ROOT, 'design-systems');
|
||||
const ARTIFACTS_DIR = path.join(PROJECT_ROOT, '.ocd', 'artifacts');
|
||||
const PROJECTS_DIR = path.join(PROJECT_ROOT, '.ocd', 'projects');
|
||||
const ARTIFACTS_DIR = path.join(PROJECT_ROOT, '.od', 'artifacts');
|
||||
const PROJECTS_DIR = path.join(PROJECT_ROOT, '.od', 'projects');
|
||||
fs.mkdirSync(PROJECTS_DIR, { recursive: true });
|
||||
|
||||
const UPLOAD_DIR = path.join(os.tmpdir(), 'ocd-uploads');
|
||||
const UPLOAD_DIR = path.join(os.tmpdir(), 'od-uploads');
|
||||
fs.mkdirSync(UPLOAD_DIR, { recursive: true });
|
||||
fs.mkdirSync(ARTIFACTS_DIR, { recursive: true });
|
||||
|
||||
@@ -580,7 +580,7 @@ export async function startServer({ port = 7456 } = {}) {
|
||||
// No mtime-based caching — frames are static and small.
|
||||
app.use('/frames', express.static(path.join(PROJECT_ROOT, 'assets', 'frames')));
|
||||
|
||||
// Project files. Each project owns a flat folder under .ocd/projects/<id>/
|
||||
// Project files. Each project owns a flat folder under .od/projects/<id>/
|
||||
// containing every file the user has uploaded, pasted, sketched, or that
|
||||
// the agent has generated. Names are sanitized; paths are confined to the
|
||||
// project's own folder (see daemon/projects.js).
|
||||
|
||||
+39
-11
@@ -24,20 +24,27 @@ export async function listSkills(skillsRoot) {
|
||||
const raw = await readFile(skillPath, 'utf8');
|
||||
const { data, body } = parseFrontmatter(raw);
|
||||
const hasAttachments = await dirHasAttachments(dir);
|
||||
const mode = data.ocd?.mode || inferMode(body, data.description);
|
||||
const mode = data.od?.mode || inferMode(body, data.description);
|
||||
out.push({
|
||||
id: data.name || entry.name,
|
||||
name: data.name || entry.name,
|
||||
description: data.description || '',
|
||||
triggers: Array.isArray(data.triggers) ? data.triggers : [],
|
||||
mode,
|
||||
platform: normalizePlatform(data.ocd?.platform, mode, body, data.description),
|
||||
scenario: normalizeScenario(data.ocd?.scenario, body, data.description),
|
||||
previewType: data.ocd?.preview?.type || 'html',
|
||||
designSystemRequired: data.ocd?.design_system?.requires ?? true,
|
||||
defaultFor: normalizeDefaultFor(data.ocd?.default_for),
|
||||
upstream: typeof data.ocd?.upstream === 'string' ? data.ocd.upstream : null,
|
||||
featured: normalizeFeatured(data.ocd?.featured),
|
||||
platform: normalizePlatform(data.od?.platform, mode, body, data.description),
|
||||
scenario: normalizeScenario(data.od?.scenario, body, data.description),
|
||||
previewType: data.od?.preview?.type || 'html',
|
||||
designSystemRequired: data.od?.design_system?.requires ?? true,
|
||||
defaultFor: normalizeDefaultFor(data.od?.default_for),
|
||||
upstream: typeof data.od?.upstream === 'string' ? data.od.upstream : null,
|
||||
featured: normalizeFeatured(data.od?.featured),
|
||||
// Optional metadata hints used by 'Use this prompt' fast-create so
|
||||
// the resulting project mirrors the shipped example.html. Each hint
|
||||
// is only consumed when its kind matches the skill mode; missing
|
||||
// hints fall back to the same defaults the new-project form uses.
|
||||
fidelity: normalizeFidelity(data.od?.fidelity),
|
||||
speakerNotes: normalizeBoolHint(data.od?.speaker_notes),
|
||||
animations: normalizeBoolHint(data.od?.animations),
|
||||
examplePrompt: derivePrompt(data),
|
||||
body: hasAttachments ? withSkillRootPreamble(body, dir) : body,
|
||||
dir,
|
||||
@@ -85,7 +92,28 @@ function normalizeDefaultFor(value) {
|
||||
return [String(value)];
|
||||
}
|
||||
|
||||
// Coerce `ocd.featured` into a numeric priority. Lower numbers float to the
|
||||
// Optional `od.fidelity` hint for prototype skills. Only 'wireframe' and
|
||||
// 'high-fidelity' are meaningful — anything else collapses to null so the
|
||||
// caller falls back to the form default ('high-fidelity').
|
||||
function normalizeFidelity(value) {
|
||||
if (value === 'wireframe' || value === 'high-fidelity') return value;
|
||||
return null;
|
||||
}
|
||||
|
||||
// Coerce truthy / falsy strings ("true", "yes", "false", "no") and booleans
|
||||
// to a real boolean. Returns null for anything we can't interpret so the
|
||||
// caller knows to fall back to the form default.
|
||||
function normalizeBoolHint(value) {
|
||||
if (typeof value === 'boolean') return value;
|
||||
if (typeof value === 'string') {
|
||||
const v = value.trim().toLowerCase();
|
||||
if (v === 'true' || v === 'yes' || v === '1') return true;
|
||||
if (v === 'false' || v === 'no' || v === '0') return false;
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
// Coerce `od.featured` into a numeric priority. Lower numbers float to the
|
||||
// top of the Examples gallery; `true` is treated as priority 1; anything
|
||||
// missing/unrecognised becomes null so non-featured skills keep their
|
||||
// natural alphabetical order.
|
||||
@@ -99,12 +127,12 @@ function normalizeFeatured(value) {
|
||||
return null;
|
||||
}
|
||||
|
||||
// Prefer an explicitly authored `ocd.example_prompt`. Fall back to the
|
||||
// Prefer an explicitly authored `od.example_prompt`. Fall back to the
|
||||
// skill description's first sentence — it's already written in actionable
|
||||
// language ("Admin / analytics dashboard in a single HTML file…") so it
|
||||
// serves as a passable starter prompt.
|
||||
function derivePrompt(data) {
|
||||
const explicit = data.ocd?.example_prompt;
|
||||
const explicit = data.od?.example_prompt;
|
||||
if (typeof explicit === 'string' && explicit.trim()) return explicit.trim();
|
||||
const desc = typeof data.description === 'string' ? data.description.trim() : '';
|
||||
if (!desc) return '';
|
||||
|
||||
Reference in New Issue
Block a user