@dialekt/adapter-laravel 0.1.0

package/src/resources.test.ts

@@ -0,0 +1,59 @@
+import { describe, expect, it } from 'vitest';
+import { Effect } from 'effect';
+import { FileSystem, Path } from '@effect/platform';
+import { NodePlatformLayer } from 'dialekt';
+import { listLaravelLocales, listLaravelResources } from './resources.js';
+import { mkdirSync, writeFileSync, rmSync } from 'node:fs';
+import { join } from 'node:path';
+import { tmpdir } from 'node:os';
+
+describe('listLaravelLocales', () => {
+  it('detects locales from directory structure', async () => {
+    const dir = join(tmpdir(), `laravel-locales-${Date.now()}`);
+    mkdirSync(join(dir, 'en'), { recursive: true });
+    mkdirSync(join(dir, 'de'), { recursive: true });
+    mkdirSync(join(dir, 'es'), { recursive: true });
+
+    const program = listLaravelLocales(dir).pipe(Effect.provide(NodePlatformLayer));
+    const result = await Effect.runPromise(program);
+    expect(result).toContain('en');
+    expect(result).toContain('de');
+    expect(result).toContain('es');
+
+    rmSync(dir, { recursive: true, force: true });
+  });
+
+  it('excludes vendor and lang directories', async () => {
+    const dir = join(tmpdir(), `laravel-locales-exclude-${Date.now()}`);
+    mkdirSync(join(dir, 'en'), { recursive: true });
+    mkdirSync(join(dir, 'vendor'), { recursive: true });
+    mkdirSync(join(dir, 'lang'), { recursive: true });
+
+    const program = listLaravelLocales(dir).pipe(Effect.provide(NodePlatformLayer));
+    const result = await Effect.runPromise(program);
+    expect(result).toContain('en');
+    expect(result).not.toContain('vendor');
+    expect(result).not.toContain('lang');
+
+    rmSync(dir, { recursive: true, force: true });
+  });
+});
+
+describe('listLaravelResources', () => {
+  it('lists PHP domain files and JSON file', async () => {
+    const dir = join(tmpdir(), `laravel-resources-${Date.now()}`);
+    mkdirSync(join(dir, 'en'), { recursive: true });
+    writeFileSync(join(dir, 'en', 'validation.php'), '<?php return [];');
+    writeFileSync(join(dir, 'en', 'auth.php'), '<?php return [];');
+    writeFileSync(join(dir, 'en.json'), '{}');
+
+    const program = listLaravelResources(dir, 'en').pipe(Effect.provide(NodePlatformLayer));
+    const result = await Effect.runPromise(program);
+    const keys = result.map((r) => r.key);
+    expect(keys).toContain('validation');
+    expect(keys).toContain('auth');
+    expect(keys).toContain('json');
+
+    rmSync(dir, { recursive: true, force: true });
+  });
+});

package/src/resources.ts

@@ -0,0 +1,78 @@
+import { FileSystem, Path } from '@effect/platform';
+import { Effect } from 'effect';
+import type { ResourceRef, AdapterReadError } from 'dialekt';
+import { AdapterReadError as AdapterReadErrorClass } from 'dialekt';
+
+export function listLaravelLocales(langDir: string) {
+  return Effect.gen(function* () {
+    const fs = yield* FileSystem.FileSystem;
+    const path = yield* Path.Path;
+    const entries = yield* fs.readDirectory(langDir).pipe(
+      Effect.orElseSucceed(() => [] as string[]),
+    );
+    const locales: string[] = [];
+    for (const entry of entries) {
+      const fullPath = path.join(langDir, entry);
+      const stat = yield* fs.stat(fullPath).pipe(Effect.option);
+      if (
+        stat._tag === 'Some' &&
+        stat.value.type === 'Directory' &&
+        entry !== 'vendor' &&
+        entry !== 'lang'
+      ) {
+        locales.push(entry);
+      }
+    }
+    return locales;
+  }).pipe(
+    Effect.mapError(
+      (cause) =>
+        new AdapterReadErrorClass({
+          adapter: 'laravel',
+          locale: '',
+          resource: '',
+          cause,
+        }) as AdapterReadError,
+    ),
+  );
+}
+
+export function listLaravelResources(langDir: string, locale: string) {
+  return Effect.gen(function* () {
+    const fs = yield* FileSystem.FileSystem;
+    const path = yield* Path.Path;
+    const localeDir = path.join(langDir, locale);
+
+    const refs: ResourceRef[] = [];
+
+    // PHP domain files
+    const entries = yield* fs.readDirectory(localeDir).pipe(
+      Effect.orElseSucceed(() => [] as string[]),
+    );
+    for (const entry of entries) {
+      if (entry.endsWith('.php')) {
+        const domain = entry.replace(/\.php$/, '');
+        refs.push({ key: domain, label: domain });
+      }
+    }
+
+    // JSON locale file (e.g. en.json)
+    const jsonPath = path.join(langDir, `${locale}.json`);
+    const jsonExists = yield* fs.exists(jsonPath).pipe(Effect.orElseSucceed(() => false));
+    if (jsonExists) {
+      refs.push({ key: 'json', label: `${locale}.json` });
+    }
+
+    return refs;
+  }).pipe(
+    Effect.mapError(
+      (cause) =>
+        new AdapterReadErrorClass({
+          adapter: 'laravel',
+          locale,
+          resource: '',
+          cause,
+        }) as AdapterReadError,
+    ),
+  );
+}

package/src/unused-keys.test.ts

@@ -0,0 +1,78 @@
+import { describe, expect, it } from 'vitest';
+import { Effect } from 'effect';
+import { FileSystem, Path } from '@effect/platform';
+import { NodePlatformLayer } from 'dialekt';
+import { findUnusedLaravelKeys } from './unused-keys.js';
+import { mkdirSync, writeFileSync, rmSync } from 'node:fs';
+import { join } from 'node:path';
+import { tmpdir } from 'node:os';
+
+describe('findUnusedLaravelKeys', () => {
+  it('finds keys not referenced in source files', async () => {
+    const dir = join(tmpdir(), `laravel-unused-${Date.now()}`);
+    mkdirSync(join(dir, 'views'), { recursive: true });
+    writeFileSync(
+      join(dir, 'views', 'email.blade.php'),
+      "<div>{{ __('validation.email') }}</div>",
+    );
+
+    const program = findUnusedLaravelKeys([dir], 'validation', ['email', 'password']).pipe(
+      Effect.provide(NodePlatformLayer),
+    );
+    const result = await Effect.runPromise(program);
+    expect(result).toEqual(['password']);
+
+    rmSync(dir, { recursive: true, force: true });
+  });
+
+  it('finds @lang references too', async () => {
+    const dir = join(tmpdir(), `laravel-unused-lang-${Date.now()}`);
+    mkdirSync(join(dir, 'views'), { recursive: true });
+    writeFileSync(
+      join(dir, 'views', 'page.blade.php'),
+      "@lang('validation.password')",
+    );
+
+    const program = findUnusedLaravelKeys([dir], 'validation', ['email', 'password']).pipe(
+      Effect.provide(NodePlatformLayer),
+    );
+    const result = await Effect.runPromise(program);
+    expect(result).toEqual(['email']);
+
+    rmSync(dir, { recursive: true, force: true });
+  });
+
+  it('finds trans() references too', async () => {
+    const dir = join(tmpdir(), `laravel-unused-trans-${Date.now()}`);
+    mkdirSync(join(dir, 'app'), { recursive: true });
+    writeFileSync(
+      join(dir, 'app', 'Controller.php'),
+      "trans('validation.email');",
+    );
+
+    const program = findUnusedLaravelKeys([dir], 'validation', ['email', 'password']).pipe(
+      Effect.provide(NodePlatformLayer),
+    );
+    const result = await Effect.runPromise(program);
+    expect(result).toEqual(['password']);
+
+    rmSync(dir, { recursive: true, force: true });
+  });
+
+  it('does not treat substrings as matches', async () => {
+    const dir = join(tmpdir(), `laravel-unused-substr-${Date.now()}`);
+    mkdirSync(join(dir, 'views'), { recursive: true });
+    writeFileSync(
+      join(dir, 'views', 'page.blade.php'),
+      "__('validation.email_longer')",
+    );
+
+    const program = findUnusedLaravelKeys([dir], 'validation', ['email', 'email_longer']).pipe(
+      Effect.provide(NodePlatformLayer),
+    );
+    const result = await Effect.runPromise(program);
+    expect(result).toEqual(['email']);
+
+    rmSync(dir, { recursive: true, force: true });
+  });
+});

package/src/unused-keys.ts

@@ -0,0 +1,70 @@
+import { FileSystem, Path } from '@effect/platform';
+import { Effect } from 'effect';
+import type { AdapterReadError } from 'dialekt';
+import { AdapterReadError as AdapterReadErrorClass } from 'dialekt';
+
+export function findUnusedLaravelKeys(
+  scanPaths: readonly string[],
+  domain: string,
+  keys: readonly string[],
+) {
+  return Effect.gen(function* () {
+    const fs = yield* FileSystem.FileSystem;
+    const path = yield* Path.Path;
+
+    // Collect all referenced domain.key strings from source files.
+    const referenced = new Set<string>();
+
+    for (const scanPath of scanPaths) {
+      const exists = yield* fs.exists(scanPath).pipe(Effect.orElseSucceed(() => false));
+      if (!exists) continue;
+
+      const entries = yield* fs.readDirectory(scanPath, { recursive: true }).pipe(
+        Effect.orElseSucceed(() => [] as string[]),
+      );
+
+      for (const relativePath of entries) {
+        if (!relativePath.endsWith('.php') && !relativePath.endsWith('.blade.php')) {
+          continue;
+        }
+        const filePath = path.join(scanPath, relativePath);
+        const content = yield* fs.readFileString(filePath).pipe(Effect.orElseSucceed(() => ''));
+
+        // Extract all quoted string literals from the file content.
+        const quotedStrings: string[] = [];
+        const patterns = [
+          /'((?:[^'\\]|\\.)*)'/g,
+          /"((?:[^"\\]|\\.)*)"/g,
+        ];
+        for (const pattern of patterns) {
+          let m: RegExpExecArray | null;
+          while ((m = pattern.exec(content)) !== null) {
+            if (m[1] !== undefined) quotedStrings.push(m[1]!);
+          }
+        }
+
+        for (const str of quotedStrings) {
+          for (const key of keys) {
+            const fullKey = `${domain}.${key}`;
+            // Match literal fullKey as a whole string (not substring).
+            if (str === fullKey) {
+              referenced.add(key);
+            }
+          }
+        }
+      }
+    }
+
+    return keys.filter((key) => !referenced.has(key));
+  }).pipe(
+    Effect.mapError(
+      (cause) =>
+        new AdapterReadErrorClass({
+          adapter: 'laravel',
+          locale: '',
+          resource: domain,
+          cause,
+        }) as AdapterReadError,
+    ),
+  );
+}

package/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "dist"
+  },
+  "include": ["src"],
+  "references": [
+    { "path": "../dialekt" }
+  ]
+}