improve highlighter type

Author: MrWangJustToDo

packages/core/src/diff-parse.ts

@@ -1,5 +1,6 @@
 /* eslint-disable max-lines */
-// NODE: ALL of the Diff parse logic from desktop, SEE https://github.com/desktop/desktop
+
+// !NOTE: ALL of the diff parse logic copy from desktop, SEE https://github.com/desktop/desktop
 
 // https://en.wikipedia.org/wiki/Diff_utility
 //

packages/core/src/file.ts

@@ -2,7 +2,7 @@ import { highlighter } from "@git-diff-view/lowlight";
 
 import { Cache } from "./cache";
 
-import type { AST } from "@git-diff-view/lowlight";
+import type { DiffAST } from "@git-diff-view/lowlight";
 
 const map = new Cache<string, File>();
 
@@ -44,7 +44,7 @@ export type SyntaxLine = {
 };
 
 export class File {
-  ast?: AST;
+  ast?: DiffAST;
 
   rawFile: Record<number, string> = {};
 

packages/lowlight/src/index.ts

@@ -50,16 +50,16 @@ lowlight.register("vue", function hljsDefineVue(hljs) {
   };
 });
 
-export type AST = ReturnType<typeof lowlight.highlight>;
+export type DiffAST = ReturnType<typeof lowlight.highlight>;
 
-export type Highlighter = {
+export type DiffHighlighter = {
   name: string;
   maxLineToIgnoreSyntax: number;
   setMaxLineToIgnoreSyntax: (v: number) => void;
   ignoreSyntaxHighlightList: (string | RegExp)[];
   setIgnoreSyntaxHighlightList: (v: (string | RegExp)[]) => void;
-  getAST: (raw: string, fileName?: string, lang?: string) => AST;
-  processAST: (ast: AST) => { syntaxFileObject: Record<number, SyntaxLine>; syntaxFileLineNumber: number };
+  getAST: (raw: string, fileName?: string, lang?: string) => DiffAST;
+  processAST: (ast: DiffAST) => { syntaxFileObject: Record<number, SyntaxLine>; syntaxFileLineNumber: number };
 };
 
 const instance = { name: "lowlight" };
@@ -120,11 +120,11 @@ Object.defineProperty(instance, "getAST", {
 });
 
 Object.defineProperty(instance, "processAST", {
-  value: (ast: AST) => {
+  value: (ast: DiffAST) => {
     return processAST(ast);
   },
 });
 
 export { processAST } from "./processAST";
 
-export const highlighter: Highlighter = instance as Highlighter;
+export const highlighter: DiffHighlighter = instance as DiffHighlighter;

packages/lowlight/src/processAST.ts

@@ -1,4 +1,4 @@
-import type { AST } from ".";
+import type { DiffAST } from ".";
 
 export type SyntaxNode = {
   type: string;
@@ -17,7 +17,7 @@ export type SyntaxLine = {
   nodeList: { node: SyntaxNode; wrapper?: SyntaxNode }[];
 };
 
-export const processAST = (ast: AST) => {
+export const processAST = (ast: DiffAST) => {
   let lineNumber = 1;
 
   const syntaxObj: Record<number, SyntaxLine> = {};

packages/shiki/src/index.ts

@@ -4,16 +4,16 @@ import { processAST, type SyntaxLine } from "./processAST";
 
 import type { codeToHast } from "shiki";
 
-export type AST = DePromise<ReturnType<typeof codeToHast>>;
+export type DiffAST = DePromise<ReturnType<typeof codeToHast>>;
 
-export type Highlighter = {
+export type DiffHighlighter = {
   name: string;
   maxLineToIgnoreSyntax: number;
   setMaxLineToIgnoreSyntax: (v: number) => void;
   ignoreSyntaxHighlightList: (string | RegExp)[];
   setIgnoreSyntaxHighlightList: (v: (string | RegExp)[]) => void;
-  getAST: (raw: string, fileName?: string, lang?: string) => AST;
-  processAST: (ast: AST) => { syntaxFileObject: Record<number, SyntaxLine>; syntaxFileLineNumber: number };
+  getAST: (raw: string, fileName?: string, lang?: string) => DiffAST;
+  processAST: (ast: DiffAST) => { syntaxFileObject: Record<number, SyntaxLine>; syntaxFileLineNumber: number };
 };
 
 let internal: DePromise<ReturnType<typeof getHighlighter>> | null = null;
@@ -106,14 +106,14 @@ Object.defineProperty(instance, "getAST", {
 });
 
 Object.defineProperty(instance, "processAST", {
-  value: (ast: AST) => {
+  value: (ast: DiffAST) => {
     return processAST(ast);
   },
 });
 
-const highlighter: Highlighter = instance as Highlighter;
+const highlighter: DiffHighlighter = instance as DiffHighlighter;
 
-export const highlighterReady = new Promise<Highlighter>((r) => {
+export const highlighterReady = new Promise<DiffHighlighter>((r) => {
   if (internal) {
     r(highlighter);
   } else {
@@ -125,4 +125,6 @@ export const highlighterReady = new Promise<Highlighter>((r) => {
   }
 });
 
+export { processAST } from "./processAST";
+
 export * from "shiki";

packages/shiki/src/processAST.ts

@@ -1,4 +1,4 @@
-import type { AST } from ".";
+import type { DiffAST } from ".";
 
 export type SyntaxNode = {
   type: string;
@@ -17,7 +17,7 @@ export type SyntaxLine = {
   nodeList: { node: SyntaxNode; wrapper?: SyntaxNode }[];
 };
 
-export const processAST = (ast: AST) => {
+export const processAST = (ast: DiffAST) => {
   let lineNumber = 1;
 
   const syntaxObj: Record<number, SyntaxLine> = {};