feat(srtLoader): Implement SRT file loader (lingodotdev#300)

* feat(cli): implemented srt loader

Signed-off-by: Partik <partikbumrah13508@gmail.com>

* chore: removed comments

Signed-off-by: Partik <partikbumrah13508@gmail.com>

* chore: changesets

Signed-off-by: Partik <partikbumrah13508@gmail.com>

* chore: changesets

Signed-off-by: Partik <partikbumrah13508@gmail.com>

* chore: fixed build errors

Signed-off-by: Partik <partikbumrah13508@gmail.com>

* chore: fixed build errors

Signed-off-by: Partik <partikbumrah13508@gmail.com>

* chore: fixed build errors

Signed-off-by: Partik <partikbumrah13508@gmail.com>

* feat: changes to the srt loader

Signed-off-by: Partik <partikbumrah13508@gmail.com>

---------

Signed-off-by: Partik <partikbumrah13508@gmail.com>
Co-authored-by: Max Prilutskiy <5614659+maxprilutskiy@users.noreply.github.com>

Author: partik03

.changeset/sixty-suns-look.md

@@ -0,0 +1,6 @@
+---
+"@replexica/spec": minor
+"@replexica/cli": minor
+---
+
+implemented srt file loader and added support for srt file format in spec

bin/act

@@ -46,6 +46,7 @@
     "prettier": "^3.3.3",
     "properties-parser": "^0.6.0",
     "slugify": "^1.6.6",
+    "srt-parser-2": "^1.2.3",
     "typescript": "^5.6.3",
     "vitest": "^2.1.4",
     "xml2js": "^0.6.2",

packages/cli/package.json

@@ -859,6 +859,73 @@ user.password=Contraseña
       );
     });
   });
+  describe('srt bucket loader', () => {
+    it('should load srt', async () => {
+      setupFileMocks();
+  
+      const input = `
+1
+00:00:00,000 --> 00:00:01,000
+Hello!
+
+2
+00:00:01,000 --> 00:00:02,000
+World!
+      `.trim();
+      const expectedOutput = {"1#00:00:00,000-00:00:01,000": "Hello!","2#00:00:01,000-00:00:02,000": "World!"};
+  
+      mockFileOperations(input);
+  
+      const srtLoader = createBucketLoader('srt', 'i18n/[locale].srt');
+      srtLoader.setDefaultLocale('en');
+      const data = await srtLoader.pull('en');
+  
+      expect(data).toEqual(expectedOutput);
+    });
+
+
+      it('should save srt', async () => {
+        setupFileMocks();
+    
+        const input = `
+1
+00:00:00,000 --> 00:00:01,000
+Hello!
+
+2
+00:00:01,000 --> 00:00:02,000
+World!
+  `.trim();
+  
+        const payload = {"1#00:00:00,000-00:00:01,000": "¡Hola!","2#00:00:01,000-00:00:02,000": "Mundo!"}
+        
+        const expectedOutput = `1
+00:00:00,000 --> 00:00:01,000
+¡Hola!
+
+2
+00:00:01,000 --> 00:00:02,000
+Mundo!\n`;
+
+    
+      mockFileOperations(input);
+
+      const srtLoader = createBucketLoader('srt', 'i18n/[locale].srt');
+      srtLoader.setDefaultLocale('en');
+      await srtLoader.pull('en');
+
+      await srtLoader.push('es', payload);
+    
+        expect(fs.writeFile).toHaveBeenCalledWith(
+          'i18n/es.srt',
+          expectedOutput,
+          { encoding: 'utf-8', flag: 'w' },
+        );
+      });
+  
+  });
+  
+
 });
 
 // Helper functions

packages/cli/src/loaders/index.spec.ts

@@ -19,6 +19,7 @@ import createXcodeXcstringsLoader from './xcode-xcstrings';
 import createPrettierLoader from './prettier';
 import createUnlocalizableLoader from './unlocalizable';
 import createPoLoader from './po';
+import createSrtLoader from './srt';
 
 export default function createBucketLoader(
   bucketType: Z.infer<typeof bucketTypeSchema>,
@@ -109,5 +110,10 @@ export default function createBucketLoader(
       createFlatLoader(),
       createUnlocalizableLoader(),
     );
+    case 'srt': return composeLoaders(
+      createTextFileLoader(bucketPathPattern),
+      createSrtLoader(),
+      createUnlocalizableLoader(),
+    );
   }
 }

packages/cli/src/loaders/index.ts

@@ -0,0 +1,43 @@
+import { ILoader } from "./_types";
+import { createLoader } from './_utils';
+import srtParser from "srt-parser-2";
+import fs from 'fs/promises';
+
+export default function createSrtLoader(): ILoader<string, Record<string, any>> {
+  const parser = new srtParser();
+  return createLoader({
+
+    async pull(locale, input) {      
+      const parsed = parser.fromSrt(input) || [];
+      const result: Record<string, string> = {};
+
+      parsed.forEach((entry) => {
+        const key = `${entry.id}#${entry.startTime}-${entry.endTime}`;
+        result[key] = entry.text;
+      });
+
+      return result;
+    },
+
+    async push(locale, payload) {
+      const output = Object.entries(payload).map(([key, text]) => {
+        const [id, timeRange] = key.split('#');
+        const [startTime, endTime] = timeRange.split('-');
+
+        return {
+          id: id,
+          startTime: startTime,
+          startSeconds: 0,
+          endTime: endTime,
+          endSeconds: 0,
+          text: text
+        };
+      });
+
+      const srtContent = parser.toSrt(output).trim().replace(/\r?\n/g, '\n');
+      console.log(srtContent);
+
+      return srtContent;
+    }
+  });
+}

packages/cli/src/loaders/srt.ts

@@ -14,7 +14,7 @@ export const bucketTypes = [
   'yaml-root-key',
   'properties',
   'po',
-
+  'srt',
   'compiler',
 ] as const;