@schema2sheet/cli 1.0.0

package/dist/cli.mjs

@@ -0,0 +1,344 @@
+#!/usr/bin/env node
+import { Command } from "commander";
+import { config } from "dotenv";
+import { execSync } from "node:child_process";
+import fs from "node:fs/promises";
+import { Parser } from "@dbml/core";
+import { buildRefMap, collectEnumNames, convertDbmlTableToHeaders } from "@schema2sheet/dbml";
+import { generateOas } from "@schema2sheet/openapi";
+import { generateGas } from "@schema2sheet/gas";
+import { google } from "googleapis";
+
+//#region src/utils/parser.ts
+function parseHeaderValue(raw) {
+	const match = raw.match(/^(.+?)(\*)?(?::(.+))?$/);
+	if (!match) return null;
+	const [, name, required] = match;
+	return {
+		name,
+		required: !!required,
+		raw
+	};
+}
+
+//#endregion
+//#region src/utils/helpers.ts
+function escapeSheetName(name) {
+	if (name.includes(" ") || name.includes("'")) return `'${name.replace(/'/g, "''")}'`;
+	return name;
+}
+
+//#endregion
+//#region src/commands/sheet-write.ts
+const WRITE_SCOPES = ["https://www.googleapis.com/auth/spreadsheets"];
+const DEFAULT_MANUAL_TEXT = `📋 시트 사용 안내
+
+• 이 행(1행)은 매뉴얼입니다. 자유롭게 수정하세요.
+• 2행은 헤더입니다. 컬럼명과 타입이 정의되어 있습니다.
+• 3행부터 데이터를 입력하세요.
+
+📌 헤더 형식: 컬럼명*:타입
+• * (별표): 필수 입력 컬럼 (비워둘 수 없음)
+• 타입 종류:
+  - string: 일반 텍스트
+  - uuid: 고유 식별자 (예: 550e8400-e29b-41d4-a716-446655440000)
+  - email: 이메일 형식 (예: user@example.com)
+  - uri: URL 형식 (예: https://example.com)
+  - date: 날짜 (예: 2024-01-15)
+  - date-time: 날짜+시간 (예: 2024-01-15T09:30:00Z)
+  - number: 숫자 (소수점 가능)
+  - integer: 정수
+  - boolean: true 또는 false
+
+⚠️ 주의사항
+• id 컬럼은 수정하지 마세요 (자동 생성)
+• 타입이나 *(필수 여부)를 변경하면 기존 API 동작이 달라질 수 있습니다.
+• 헤더명을 변경한 경우, 반드시 OAS를 다시 생성하세요: npx sheet-schema gen-oas`;
+const DEFAULT_HEADER_COLOR = {
+	red: .71,
+	green: .84,
+	blue: .96
+};
+const BLACK_BORDER = {
+	style: "SOLID",
+	color: {
+		red: 0,
+		green: 0,
+		blue: 0
+	}
+};
+function lightenColor(color, factor = .5) {
+	return {
+		red: color.red + (1 - color.red) * factor,
+		green: color.green + (1 - color.green) * factor,
+		blue: color.blue + (1 - color.blue) * factor
+	};
+}
+async function ensureSheetHeader(options) {
+	const auth = new google.auth.GoogleAuth({ scopes: WRITE_SCOPES });
+	const sheets = google.sheets({
+		version: "v4",
+		auth
+	});
+	const existing = (await sheets.spreadsheets.get({
+		spreadsheetId: options.spreadsheetId,
+		fields: "sheets(properties(sheetId,title),bandedRanges(bandedRangeId))"
+	})).data.sheets?.find((sheet) => sheet.properties?.title === options.sheetName);
+	let sheetId = existing?.properties?.sheetId;
+	let created = false;
+	if (sheetId == null && options.createIfMissing !== false) {
+		sheetId = (await sheets.spreadsheets.batchUpdate({
+			spreadsheetId: options.spreadsheetId,
+			requestBody: { requests: [{ addSheet: { properties: { title: options.sheetName } } }] }
+		})).data.replies?.[0]?.addSheet?.properties?.sheetId;
+		created = true;
+	}
+	if (sheetId == null) throw new Error(`Sheet not found: ${options.sheetName}`);
+	const range = `${escapeSheetName(options.sheetName)}!1:2`;
+	const existingRows = (await sheets.spreadsheets.values.get({
+		spreadsheetId: options.spreadsheetId,
+		range
+	})).data.values ?? [];
+	const hasValues = existingRows.some((row) => row?.some((value) => String(value ?? "").trim()));
+	if (hasValues && !options.force) throw new Error(`Sheet "${options.sheetName}" already has data in rows 1-2. Use --force to overwrite.`);
+	if (hasValues && options.force) {
+		await sheets.spreadsheets.values.clear({
+			spreadsheetId: options.spreadsheetId,
+			range
+		});
+		const bandings = existing?.bandedRanges ?? [];
+		if (bandings.length > 0) await sheets.spreadsheets.batchUpdate({
+			spreadsheetId: options.spreadsheetId,
+			requestBody: { requests: bandings.map((b) => ({ deleteBanding: { bandedRangeId: b.bandedRangeId } })) }
+		});
+	}
+	const manualText = options.manualText ?? DEFAULT_MANUAL_TEXT;
+	await sheets.spreadsheets.values.update({
+		spreadsheetId: options.spreadsheetId,
+		range: `${escapeSheetName(options.sheetName)}!A1`,
+		valueInputOption: "RAW",
+		requestBody: { values: [[manualText], options.headers] }
+	});
+	const headerColor = options.headerColor ?? DEFAULT_HEADER_COLOR;
+	const dataRowColor = lightenColor(headerColor, .6);
+	await sheets.spreadsheets.batchUpdate({
+		spreadsheetId: options.spreadsheetId,
+		requestBody: { requests: [
+			{ mergeCells: {
+				range: {
+					sheetId,
+					startRowIndex: 0,
+					endRowIndex: 1,
+					startColumnIndex: 0,
+					endColumnIndex: options.headers.length
+				},
+				mergeType: "MERGE_ALL"
+			} },
+			{ updateDimensionProperties: {
+				range: {
+					sheetId,
+					dimension: "ROWS",
+					startIndex: 0,
+					endIndex: 1
+				},
+				properties: { pixelSize: 200 },
+				fields: "pixelSize"
+			} },
+			{ repeatCell: {
+				range: {
+					sheetId,
+					startRowIndex: 0,
+					endRowIndex: 1,
+					startColumnIndex: 0,
+					endColumnIndex: options.headers.length
+				},
+				cell: { userEnteredFormat: {
+					wrapStrategy: "WRAP",
+					verticalAlignment: "TOP",
+					textFormat: { fontSize: 10 }
+				} },
+				fields: "userEnteredFormat(wrapStrategy,verticalAlignment,textFormat)"
+			} },
+			{ repeatCell: {
+				range: {
+					sheetId,
+					startRowIndex: 1,
+					endRowIndex: 2,
+					startColumnIndex: 0,
+					endColumnIndex: options.headers.length
+				},
+				cell: { userEnteredFormat: {
+					backgroundColor: headerColor,
+					textFormat: { bold: true },
+					horizontalAlignment: "CENTER",
+					verticalAlignment: "MIDDLE",
+					borders: {
+						top: BLACK_BORDER,
+						bottom: BLACK_BORDER,
+						left: BLACK_BORDER,
+						right: BLACK_BORDER
+					}
+				} },
+				fields: "userEnteredFormat(backgroundColor,textFormat,horizontalAlignment,verticalAlignment,borders)"
+			} },
+			{ addBanding: { bandedRange: {
+				range: {
+					sheetId,
+					startRowIndex: 2,
+					endRowIndex: 1e3,
+					startColumnIndex: 0,
+					endColumnIndex: options.headers.length
+				},
+				rowProperties: {
+					firstBandColor: {
+						red: 1,
+						green: 1,
+						blue: 1
+					},
+					secondBandColor: dataRowColor
+				}
+			} } },
+			{ updateBorders: {
+				range: {
+					sheetId,
+					startRowIndex: 1,
+					endRowIndex: 1e3,
+					startColumnIndex: 0,
+					endColumnIndex: options.headers.length
+				},
+				top: BLACK_BORDER,
+				bottom: BLACK_BORDER,
+				left: BLACK_BORDER,
+				right: BLACK_BORDER,
+				innerHorizontal: BLACK_BORDER,
+				innerVertical: BLACK_BORDER
+			} },
+			{ updateSheetProperties: {
+				properties: {
+					sheetId,
+					gridProperties: { frozenRowCount: 2 }
+				},
+				fields: "gridProperties.frozenRowCount"
+			} },
+			{ autoResizeDimensions: { dimensions: {
+				sheetId,
+				dimension: "COLUMNS",
+				startIndex: 0,
+				endIndex: options.headers.length
+			} } }
+		] }
+	});
+	return {
+		sheetId,
+		created,
+		updated: true,
+		previousHeader: hasValues ? existingRows[1]?.map((value) => String(value ?? "")) : void 0
+	};
+}
+
+//#endregion
+//#region src/commands/apply.ts
+async function applyDbml(options) {
+	const dbmlContent = await fs.readFile(options.filePath, "utf8");
+	const exported = new Parser().parse(dbmlContent, "dbml").export();
+	const refMap = buildRefMap(exported.schemas);
+	const enumNames = collectEnumNames(exported.schemas);
+	const tables = exported.schemas.flatMap((s) => s.tables);
+	if (tables.length === 0) {
+		console.error("No tables found in DBML file.");
+		process.exit(1);
+	}
+	for (const table of tables) {
+		const headers = convertDbmlTableToHeaders(table, refMap, enumNames);
+		if (!headers.some((h) => h.startsWith("id*"))) {
+			console.warn(`Table "${table.name}": no id* column found. Adding id*:uuid.`);
+			headers.unshift("id*:uuid");
+		}
+		for (const header of headers) if (!parseHeaderValue(header)) throw new Error(`Generated invalid header for table "${table.name}": ${header}`);
+		if (options.dryRun) {
+			console.log(`[dry-run] ${table.name}: ${headers.join(" | ")}`);
+			continue;
+		}
+		const result = await ensureSheetHeader({
+			spreadsheetId: options.spreadsheetId,
+			sheetName: table.name,
+			headers,
+			force: options.force,
+			createIfMissing: true
+		});
+		const action = result.created ? "Created" : "Updated";
+		console.log(`${action} sheet: ${table.name} (sheetId=${result.sheetId})`);
+	}
+	if (options.dryRun) {
+		console.log("\n[dry-run] No sheets were modified.");
+		return;
+	}
+	console.log("\nGenerating OpenAPI spec...");
+	await generateOas({
+		spreadsheetId: options.spreadsheetId,
+		title: "Spreadsheet API",
+		version: "0.1.0",
+		outputPath: "openapi.json",
+		schemaPath: "schema.json",
+		hashPath: "openapi.hash",
+		pathPrefix: "/api",
+		excludePrefixes: ["_", "#"],
+		includeHidden: false,
+		scanRows: 10,
+		headerRow: 2,
+		metadataKey: null,
+		enumLimit: 200,
+		debug: false
+	});
+	console.log("Generated: openapi.json, schema.json");
+	console.log("\nGenerating Google Apps Script...");
+	await generateGas({
+		schemaPath: "schema.json",
+		spreadsheetId: options.spreadsheetId,
+		outputPath: "api.gs"
+	});
+	if (options.deploy) {
+		console.log("\nDeploying to Google Apps Script...");
+		try {
+			execSync("clasp push", { stdio: "inherit" });
+			execSync("clasp deploy", { stdio: "inherit" });
+			console.log("Deployed successfully.");
+		} catch {
+			console.error("clasp deploy failed. Make sure clasp is installed and configured.");
+			console.error("  npm install -g @google/clasp");
+			console.error("  clasp login");
+			console.error("  clasp create --type webapp --rootDir .");
+			process.exit(1);
+		}
+	}
+	console.log(`\nDone: ${tables.length} table(s) processed.`);
+}
+
+//#endregion
+//#region src/cli.ts
+config();
+const program = new Command();
+program.name("sheet-schema").description("Apply DBML schema to Google Sheets and generate OpenAPI + GAS").version("1.0.0");
+program.command("apply <file>").description("Apply a DBML schema: create sheets, generate OAS and GAS").option("-s, --spreadsheet-id <id>", "Spreadsheet ID (or set SPREADSHEET_ID env)").option("--force", "Overwrite existing header rows", false).option("--dry-run", "Print planned headers without writing to sheets", false).option("--deploy", "Deploy GAS to Apps Script via clasp", false).action(async (file, options) => {
+	const spreadsheetId = options.spreadsheetId || process.env.SPREADSHEET_ID;
+	if (!spreadsheetId) {
+		console.error("Missing spreadsheet id. Use --spreadsheet-id or SPREADSHEET_ID env.");
+		process.exit(1);
+	}
+	try {
+		await applyDbml({
+			filePath: file,
+			spreadsheetId,
+			force: Boolean(options.force),
+			dryRun: Boolean(options.dryRun),
+			deploy: Boolean(options.deploy)
+		});
+	} catch (error) {
+		console.error(error?.stack || error?.message || error);
+		process.exit(1);
+	}
+});
+await program.parseAsync(process.argv);
+
+//#endregion
+export {  };

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@schema2sheet/cli",
+  "version": "1.0.0",
+  "description": "CLI tool for schema2sheet",
+  "type": "module",
+  "main": "dist/cli.js",
+  "bin": {
+    "schema2sheet": "dist/cli.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "cli",
+    "schema2sheet",
+    "google-sheets"
+  ],
+  "license": "MIT",
+  "dependencies": {
+    "commander": "^11.1.0",
+    "dotenv": "^16.4.5",
+    "googleapis": "^140.0.0",
+    "@schema2sheet/openapi": "1.0.0",
+    "@schema2sheet/core": "1.0.0",
+    "@schema2sheet/gas": "1.0.0",
+    "@schema2sheet/sheets": "1.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.2",
+    "typescript": "^5.7.2"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/froggy1014/schema2sheet.git"
+  },
+  "homepage": "https://github.com/froggy1014/schema2sheet#readme",
+  "bugs": {
+    "url": "https://github.com/froggy1014/schema2sheet/issues"
+  },
+  "author": "froggy1014",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown --watch",
+    "lint": "biome check --write .",
+    "clean": "rm -rf dist .turbo node_modules",
+    "typecheck": "tsc --noEmit"
+  }
+}