CodeFileをSimpleCodeFileへ変更

Author: MijinkoSD

browser/websocket/updateCodeBlock.ts

@@ -10,7 +10,7 @@ import { TinyCodeBlock } from "../../rest/getCodeBlocks.ts";
 import { diffToChanges } from "./diffToChanges.ts";
 import { getUserId } from "./id.ts";
 import { pull } from "./pull.ts";
-import { CodeFile, isCodeFile } from "./updateCodeFile.ts";
+import { SimpleCodeFile, isSimpleCodeFile } from "./updateCodeFile.ts";
 import {
   applyCommit,
   countBodyIndent,
@@ -27,15 +27,15 @@ export interface UpdateCodeBlockOptions {
 
 /** コードブロックの中身を更新する
  *
- * newCodeにCodeFileオブジェクトを渡すと、そのオブジェクトに添ってコードブロックのファイル名も書き換えます
+ * newCodeにSimpleCodeFileオブジェクトを渡すと、そのオブジェクトに添ってコードブロックのファイル名も書き換えます
  * （文字列や文字列配列を渡した場合は書き換えません）。
  *
  * @param newCode 更新後のコードブロック
  * @param target 更新対象のコードブロック
  * @param project 更新対象のコードブロックが存在するプロジェクト名
  */
 export const updateCodeBlock = async (
-  newCode: string | string[] | CodeFile,
+  newCode: string | string[] | SimpleCodeFile,
   target: TinyCodeBlock,
   options?: UpdateCodeBlockOptions,
 ) => {
@@ -63,7 +63,7 @@ export const updateCodeBlock = async (
     userId,
   });
   const commits = [...fixCommits([...diffGenerator], target)];
-  if (isCodeFile(newCode)) {
+  if (isSimpleCodeFile(newCode)) {
     const titleCommit = makeTitleChangeCommit(newCode, target);
     if (titleCommit) commits.push(titleCommit);
   }
@@ -82,8 +82,8 @@ export const updateCodeBlock = async (
 };
 
 /** コード本文のテキストを取得する */
-function getCodeBody(code: string | string[] | CodeFile): string[] {
-  const content = isCodeFile(code) ? code.content : code;
+function getCodeBody(code: string | string[] | SimpleCodeFile): string[] {
+  const content = isSimpleCodeFile(code) ? code.content : code;
   if (Array.isArray(content)) return content;
   return content.split("\n");
 }
@@ -133,7 +133,7 @@ function* fixCommits(
 
 /** コードタイトルが違う場合は書き換える */
 function makeTitleChangeCommit(
-  code: CodeFile,
+  code: SimpleCodeFile,
   target: Pick<TinyCodeBlock, "titleLine">,
 ): UpdateCommit | null {
   const lineId = target.titleLine.id;

browser/websocket/updateCodeFile.test.ts

@@ -1,29 +1,29 @@
 /// <reference lib="deno.ns" />
 
 import { assert, assertFalse } from "../../deps/testing.ts";
-import { CodeFile, isCodeFile } from "./updateCodeFile.ts";
+import { SimpleCodeFile, isSimpleCodeFile } from "./updateCodeFile.ts";
 
-const codeFile: CodeFile = {
+const codeFile: SimpleCodeFile = {
   filename: "filename",
   content: ["line 0", "line 1"],
   lang: "language",
 };
 
-Deno.test("isCodeFile()", async (t) => {
-  await t.step("CodeFile object", () => {
-    assert(isCodeFile(codeFile));
-    assert(isCodeFile({ ...codeFile, content: "line 0" }));
-    assert(isCodeFile({ ...codeFile, lang: undefined }));
+Deno.test("isSimpleCodeFile()", async (t) => {
+  await t.step("SimpleCodeFile object", () => {
+    assert(isSimpleCodeFile(codeFile));
+    assert(isSimpleCodeFile({ ...codeFile, content: "line 0" }));
+    assert(isSimpleCodeFile({ ...codeFile, lang: undefined }));
   });
   await t.step("similer objects", () => {
-    assertFalse(isCodeFile({ ...codeFile, filename: 10 }));
-    assertFalse(isCodeFile({ ...codeFile, content: 10 }));
-    assertFalse(isCodeFile({ ...codeFile, content: [0, 1] }));
-    assertFalse(isCodeFile({ ...codeFile, lang: 10 }));
+    assertFalse(isSimpleCodeFile({ ...codeFile, filename: 10 }));
+    assertFalse(isSimpleCodeFile({ ...codeFile, content: 10 }));
+    assertFalse(isSimpleCodeFile({ ...codeFile, content: [0, 1] }));
+    assertFalse(isSimpleCodeFile({ ...codeFile, lang: 10 }));
   });
   await t.step("other type values", () => {
-    assertFalse(isCodeFile(10));
-    assertFalse(isCodeFile(undefined));
-    assertFalse(isCodeFile(["0", "1", "2"]));
+    assertFalse(isSimpleCodeFile(10));
+    assertFalse(isSimpleCodeFile(undefined));
+    assertFalse(isSimpleCodeFile(["0", "1", "2"]));
   });
 });

browser/websocket/updateCodeFile.ts

@@ -13,7 +13,7 @@ import { diff, toExtendedChanges } from "../../deps/onp.ts";
 import { applyCommit, countBodyIndent } from "./_codeBlock.ts";
 
 /** コードブロックの上書きに使う情報のinterface */
-export interface CodeFile {
+export interface SimpleCodeFile {
   /** ファイル名 */
   filename: string;
 
@@ -45,10 +45,10 @@ export interface UpdateCodeFileOptions {
   debug?: boolean;
 }
 
-/** objectがCodeFile型かどうかを判別する */
-export function isCodeFile(obj: unknown): obj is CodeFile {
+/** objectがSimpleCodeFile型かどうかを判別する */
+export function isSimpleCodeFile(obj: unknown): obj is SimpleCodeFile {
   if (Array.isArray(obj) || !(obj instanceof Object)) return false;
-  const code = obj as CodeFile;
+  const code = obj as SimpleCodeFile;
   const { filename, content, lang } = code;
   return (
     typeof filename == "string" &&
@@ -72,7 +72,7 @@ export function isCodeFile(obj: unknown): obj is CodeFile {
  * @param options その他の設定
  */
 export const updateCodeFile = async (
-  codeFile: CodeFile,
+  codeFile: SimpleCodeFile,
   project: string,
   title: string,
   options?: UpdateCodeFileOptions,
@@ -133,7 +133,7 @@ function flatCodeBodies(codeBlocks: readonly TinyCodeBlock[]): Line[] {
 /** コードブロックの差分からコミットデータを作成する */
 function* makeCommits(
   _codeBlocks: readonly TinyCodeBlock[],
-  codeFile: CodeFile,
+  codeFile: SimpleCodeFile,
   lines: Line[],
   { userId, insertPositionIfNotExist, isInsertEmptyLineInTail }: {
     userId: string;
@@ -247,7 +247,7 @@ function* makeCommits(
   }
 }
 
-function makeCodeBlockTitle(code: CodeFile) {
+function makeCodeBlockTitle(code: SimpleCodeFile) {
   const codeName = code.filename + (code.lang ? `(${code.lang})` : "");
   return `code:${codeName}`;
 }