chore(contented-processor): pipeline.type to support ``^[a-zA-Z_$][\w…

…$]*$` (#706) #### What this PR does / why we need it: As per title. #### Which issue(s) will this PR fix?:
fuxingloh · Nov 17, 2023 · f8e86ba · f8e86ba
1 parent 7d381b8
commit f8e86ba
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 3 deletions.
diff --git a/packages/contented-processor/src/ContentedProcessor.ts b/packages/contented-processor/src/ContentedProcessor.ts
@@ -39,9 +39,9 @@ export class ContentedProcessor {
     config.outDir = config.outDir ?? './.contented';
     config.pipelines.forEach((pipeline) => {
       pipeline.type = pipeline.type ?? 'Docs';
-      if (pipeline.type.match(/[^a-zA-Z]/g)) {
+      if (!pipeline.type.match(/^[a-zA-Z_$][\w$]*$/)) {
         throw new Error(
-          'Due to codegen, pipeline.type must be a string with allowed characters within the range of [a-zA-Z].',
+          'Due to codegen, pipeline.type must be a string with allowed characters within the range of ^[a-zA-Z_$][\\w$]*$.',
         );
       }
 

diff --git a/packages/contented-processor/src/ContentedProcessor.unit.ts b/packages/contented-processor/src/ContentedProcessor.unit.ts
@@ -418,9 +418,25 @@ describe('validation', () => {
       ],
     };
     expect(() => new ContentedProcessor(config)).toThrow(
-      'Due to codegen, pipeline.type must be a string with allowed characters within the range of [a-zA-Z].',
+      'Due to codegen, pipeline.type must be a string with allowed characters within the range of ^[a-zA-Z_$][\\w$]*$.',
     );
   });
+
+  it('should allow type.name with _', async () => {
+    const config: Config = {
+      rootDir: './fixtures',
+      outDir: './.contented',
+      pipelines: [
+        {
+          type: '_type',
+          pattern: '**/*.md',
+          processor: 'md',
+        },
+      ],
+    };
+
+    expect(() => new ContentedProcessor(config)).not.toThrow();
+  });
 });
 
 it('should dedup 2 files', async () => {