Core: comment in en

Author: elvisdragonmao

packages/sdk/tsconfig.json

@@ -1,30 +1,25 @@
 {
-	"compilerOptions": {
-		/* 語言 / Runtime */
-		"target": "ES2019",
-		"lib": ["ES2019", "DOM"],
-		"useDefineForClassFields": true,
+  "compilerOptions": {
+    "target": "ES2019",
+    "lib": ["ES2019", "DOM"],
+    "useDefineForClassFields": true,
 
-		/* Module */
-		"module": "ESNext",
-		"moduleResolution": "Bundler",
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
 
-		/* 輸出 */
-		"rootDir": "src",
-		"outDir": "dist",
-		"declaration": true,
-		"declarationMap": true,
-		"emitDeclarationOnly": false,
-		"sourceMap": true,
+    "rootDir": "src",
+    "outDir": "dist",
+    "declaration": true,
+    "declarationMap": true,
+    "emitDeclarationOnly": false,
+    "sourceMap": true,
 
-		/* 型別嚴謹度 */
-		"strict": true,
-		"exactOptionalPropertyTypes": true,
-		"noUncheckedIndexedAccess": true,
+    "strict": true,
+    "exactOptionalPropertyTypes": true,
+    "noUncheckedIndexedAccess": true,
 
-		/* DX / 穩定性 */
-		"skipLibCheck": true,
-		"forceConsistentCasingInFileNames": true
-	},
-	"include": ["src"]
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true
+  },
+  "include": ["src"]
 }

scripts/patch-openapi.js

@@ -5,61 +5,52 @@ const OPENAPI_PATH = "./tsp-output/schema/openapi.1.0.0.yaml";
 
 const spec = yaml.load(readFileSync(OPENAPI_PATH, "utf8"));
 
-/* ------------------------------------------------------------------ */
-/* 0. Patch info (TypeSpec 無法表達的部分) */
-/* ------------------------------------------------------------------ */
-
+// Patch OpenAPI spec
 spec.info = {
-	...spec.info,
-	description: `
+  ...spec.info,
+  description: `
 ## Pages
 - [API Documentation (Redocly)](redocly/)
 - [API Documentation (Swagger UI)](swagger/)
 - [SDK Documentation (TypeDoc)](sdk/)
 `.trim(),
 
-	termsOfService: "https://sdc.nycu.club/terms",
+  termsOfService: "https://sdc.nycu.club/terms",
 
-	contact: {
-		name: "NYCU Software Development Club",
-		email: "contact@sdc.nycu.club",
-		url: "https://github.com/NYCU-SDC/core-system-api"
-	},
+  contact: {
+    name: "NYCU Software Development Club",
+    email: "contact@sdc.nycu.club",
+    url: "https://github.com/NYCU-SDC/core-system-api",
+  },
 
-	license: {
-		name: "Apache-2.0",
-	}
+  license: {
+    name: "Apache-2.0",
+  },
 };
 
-/* ------------------------------------------------------------------ */
-/* 1. 強制指定 requestBody 為 multipart/form-data */
-/* ------------------------------------------------------------------ */
-
+// Patch OpenAPI spec
 const upload = spec.paths?.["/forms/{id}/cover"]?.post;
 
 if (upload?.requestBody?.content) {
-	const original = upload.requestBody.content["application/json"] ?? upload.requestBody.content[Object.keys(upload.requestBody.content)[0]];
+  const original =
+    upload.requestBody.content["application/json"] ??
+    upload.requestBody.content[Object.keys(upload.requestBody.content)[0]];
 
-	upload.requestBody.content = {
-		"multipart/form-data": original
-	};
+  upload.requestBody.content = {
+    "multipart/form-data": original,
+  };
 }
 
-/* ------------------------------------------------------------------ */
-/* 2. 強制 binary 欄位 (file upload) */
-/* ------------------------------------------------------------------ */
-
+// Force coverImage to be binary format
 const schema = spec.components?.schemas?.["Forms.FormCoverUploadRequest"];
 
 if (schema?.properties?.coverImage) {
-	schema.properties.coverImage = {
-		type: "string",
-		format: "binary"
-	};
+  schema.properties.coverImage = {
+    type: "string",
+    format: "binary",
+  };
 }
 
-/* ------------------------------------------------------------------ */
-
 writeFileSync(OPENAPI_PATH, yaml.dump(spec, { lineWidth: -1 }), "utf8");
 
 console.log("😉 Patched OpenAPI spec successfully.");