feat: add utility process (#95)

electron · Oct 6, 2023 · 6fba569 · 6fba569
1 parent 4082332
commit 6fba569
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 7 deletions.
diff --git a/src/ParsedDocumentation.ts b/src/ParsedDocumentation.ts
@@ -90,6 +90,7 @@ export declare type BaseDocumentationContainer = {
 export declare type ProcessBlock = {
   main: boolean;
   renderer: boolean;
+  utility: boolean;
   exported: boolean;
 };
 export declare type ModuleDocumentationContainer = {

diff --git a/src/__tests__/markdown-helpers.spec.ts b/src/__tests__/markdown-helpers.spec.ts
@@ -530,48 +530,72 @@ foo`),
   });
 
   describe('findProcess()', () => {
-    it('should be available in main processe only', () => {
+    it('should be available in main process only', () => {
       var proc = findProcess(getTokens('Process: [Main](../glossary.md#main-process)'));
       expect(proc.main).toEqual(true);
       expect(proc.renderer).toEqual(false);
+      expect(proc.utility).toEqual(false);
     });
 
-    it('should be available in renderer processe only', () => {
+    it('should be available in renderer process only', () => {
       var proc = findProcess(getTokens('Process: [Renderer](../glossary.md#renderer-process)'));
       expect(proc.main).toEqual(false);
       expect(proc.renderer).toEqual(true);
+      expect(proc.utility).toEqual(false);
     });
 
-    it('should be available in both processes', () => {
+    it('should be available in utility process only', () => {
+      var proc = findProcess(getTokens('Process: [Utility](../glossary.md#utility-process)'));
+      expect(proc.main).toEqual(false);
+      expect(proc.renderer).toEqual(false);
+      expect(proc.utility).toEqual(true);
+    });
+
+    it('should be available in main and renderer processes', () => {
       var proc = findProcess(
         getTokens(
           'Process: [Main](../glossary.md#main-process), [Renderer](../glossary.md#renderer-process)',
         ),
       );
       expect(proc.main).toEqual(true);
       expect(proc.renderer).toEqual(true);
+      expect(proc.utility).toEqual(false);
     });
 
-    it('should be available in both processes', () => {
+    it('should be available in main and renderer processes', () => {
       var proc = findProcess(
         getTokens(
           'Process: [Renderer](../glossary.md#renderer-process), [Main](../glossary.md#main-process)',
         ),
       );
       expect(proc.main).toEqual(true);
       expect(proc.renderer).toEqual(true);
+      expect(proc.utility).toEqual(false);
+    });
+
+    it('should be available in main and utility processes', () => {
+      var proc = findProcess(
+        getTokens(
+          'Process: [Main](../glossary.md#main-process), [Utility](../glossary.md#renderer-process)',
+        ),
+      );
+      expect(proc.main).toEqual(true);
+      expect(proc.renderer).toEqual(false);
+      expect(proc.utility).toEqual(true);
     });
 
-    it('should be available in both processes', () => {
+    it('should be available in all processes', () => {
       var proc = findProcess(getTokens(''));
       expect(proc.main).toEqual(true);
       expect(proc.renderer).toEqual(true);
+      expect(proc.utility).toEqual(true);
     });
 
-    it('should be available in both processes', () => {
+    it('should be available in all processes', () => {
       var proc = findProcess([]);
       expect(proc.main).toEqual(true);
       expect(proc.renderer).toEqual(true);
+      expect(proc.utility).toEqual(true);
     });
   });
 

diff --git a/src/markdown-helpers.ts b/src/markdown-helpers.ts
@@ -818,6 +818,7 @@ export const findProcess = (tokens: Token[]): ProcessBlock => {
       const procs: ProcessBlock = {
         main: false,
         renderer: false,
+        utility: false,
         exported: !ptks.some(
           ptk => ptk.type === 'text' && ptk.content.startsWith('This class is not exported'),
         ),
@@ -826,11 +827,12 @@ export const findProcess = (tokens: Token[]): ProcessBlock => {
         if (ptk.type !== 'text') continue;
         if (ptk.content === 'Main') procs.main = true;
         if (ptk.content === 'Renderer') procs.renderer = true;
+        if (ptk.content === 'Utility') procs.utility = true;
       }
       return procs;
     }
   }
-  return { main: true, renderer: true, exported: false };
+  return { main: true, renderer: true, utility: true, exported: false };
 };
 
 export const slugifyHeading = (heading: string): string => {