@jjlmoya/utils-tabletop 1.32.0 → 1.34.0

package/src/pages/[locale]/[slug].astro

@@ -1,32 +1,32 @@
----
-import PreviewLayout from "../../layouts/PreviewLayout.astro";
-import PreviewNavSidebar from "../../components/PreviewNavSidebar.astro";
-import { ALL_TOOLS } from "../../index";
-import {
-  UtilityHeader,
-  FAQSection,
-  Bibliography,
-  SEORenderer,
-} from "@jjlmoya/utils-shared";
-import type { KnownLocale, ToolLocaleContent } from "../../types";
-import type { UtilitySEOContent } from "@jjlmoya/utils-shared";
-
-export async function getStaticPaths() {
-  const paths = [];
-
-  for (const { entry, Component: lazyComp } of ALL_TOOLS) {
-    const { default: Component } = await (lazyComp as () => Promise<{ default: unknown }>)();
-    const localeEntries = Object.entries(entry.i18n) as [
-      KnownLocale,
-      () => Promise<ToolLocaleContent>,
-    ][];
-    const localeContents = await Promise.all(
-      localeEntries.map(async ([locale, loader]) => ({
-        locale,
-        content: await loader(),
-      })),
-    );
-
+---
+import PreviewLayout from "../../layouts/PreviewLayout.astro";
+import PreviewNavSidebar from "../../components/PreviewNavSidebar.astro";
+import { ALL_TOOLS } from "../../index";
+import {
+  UtilityHeader,
+  FAQSection,
+  Bibliography,
+  SEORenderer,
+} from "@jjlmoya/utils-shared";
+import type { KnownLocale, ToolLocaleContent } from "../../types";
+import type { UtilitySEOContent } from "@jjlmoya/utils-shared";
+
+export async function getStaticPaths() {
+  const paths = [];
+
+  for (const { entry, Component: lazyComp } of ALL_TOOLS) {
+    const { default: Component } = await (lazyComp as () => Promise<{ default: unknown }>)();
+    const localeEntries = Object.entries(entry.i18n) as [
+      KnownLocale,
+      () => Promise<ToolLocaleContent>,
+    ][];
+    const localeContents = await Promise.all(
+      localeEntries.map(async ([locale, loader]) => ({
+        locale,
+        content: await loader(),
+      })),
+    );
+
     const localeUrls = Object.fromEntries(
       localeContents.map(({ locale, content }) => [
         locale,
@@ -38,44 +38,44 @@ export async function getStaticPaths() {
     const englishSlug = firstLoader ? (await firstLoader()).slug : entry.id;
 
     for (const { locale, content } of localeContents) {
-      const allToolsNav = (
-        await Promise.all(
-          ALL_TOOLS.map(async ({ entry: navEntry }) => {
-            const loader = navEntry.i18n[locale] ?? navEntry.i18n.en;
-            if (!loader) return null;
-            const navContent = await loader();
-            return {
-              id: navEntry.id,
-              title: navContent.title,
-              href: `/${locale}/${navContent.slug}`,
-              isActive: navEntry.id === entry.id,
-            };
-          }),
-        )
-      ).filter(Boolean) as NavItem[];
-      paths.push({
-        params: { locale, slug: content.slug },
+      const allToolsNav = (
+        await Promise.all(
+          ALL_TOOLS.map(async ({ entry: navEntry }) => {
+            const loader = navEntry.i18n[locale] ?? navEntry.i18n.en;
+            if (!loader) return null;
+            const navContent = await loader();
+            return {
+              id: navEntry.id,
+              title: navContent.title,
+              href: `/${locale}/${navContent.slug}`,
+              isActive: navEntry.id === entry.id,
+            };
+          }),
+        )
+      ).filter(Boolean) as NavItem[];
+      paths.push({
+        params: { locale, slug: content.slug },
         props: { Component, locale, content, localeUrls, allToolsNav, englishSlug },
-      });
-    }
-  }
-
-  return paths;
-}
-
-interface NavItem {
-  id: string;
-  title: string;
-  href: string;
-  isActive?: boolean;
-}
-
-type PageProps = {
-  Component: unknown;
-  locale: KnownLocale;
-  content: ToolLocaleContent;
-  localeUrls: Partial<Record<KnownLocale, string>>;
-  allToolsNav: NavItem[];
+      });
+    }
+  }
+
+  return paths;
+}
+
+interface NavItem {
+  id: string;
+  title: string;
+  href: string;
+  isActive?: boolean;
+}
+
+type PageProps = {
+  Component: unknown;
+  locale: KnownLocale;
+  content: ToolLocaleContent;
+  localeUrls: Partial<Record<KnownLocale, string>>;
+  allToolsNav: NavItem[];
   englishSlug: string;
 };
 
@@ -83,80 +83,80 @@ const { Component, locale, content, localeUrls, allToolsNav, englishSlug } = Ast
 
 const cssFiles = import.meta.glob<{ default: string }>("../../tool/*/*.css", { query: "?raw", import: "default" });
 const cssKey = Object.keys(cssFiles).find((k) => k.endsWith(`/${englishSlug}.css`));
-const cssLoader = cssKey ? cssFiles[cssKey] : undefined;
-const toolCss = cssLoader ? await cssLoader() as string : "";
-
-const seoContent: UtilitySEOContent = { locale, sections: content.seo ?? [] };
-
-const words = content.title.split(" ");
-const titleHighlight = words[0] || "";
-const titleBase = words.slice(1).join(" ") || "";
----
-
-<PreviewLayout
-  title={content.title}
-  currentLocale={locale}
-  localeUrls={localeUrls}
-  hasSidebar={true}
->
-  <PreviewNavSidebar
-    slot="sidebar"
-    categoryTitle="Tools"
-    tools={allToolsNav}
-  />
-  <Fragment slot="head">
-    {toolCss ? <Fragment set:html={`<style is:inline>${toolCss}</style>`} /> : null}
-    {
-      ( content.schemas ?? []).map((schema: unknown) => (
-        <script
-          is:inline
-          type="application/ld+json"
-          set:html={JSON.stringify(schema)}
-        />
-      ))
-    }
-  </Fragment>
-
-  <div class="tool-page">
-    <UtilityHeader
-      titleHighlight={titleHighlight}
-      titleBase={titleBase}
-      description={content.description}
-    />
-
-    <section class="section-tool">
-      <Component ui={content.ui} />
-    </section>
-
-    <section class="section-seo">
-      <SEORenderer content={seoContent} />
-    </section>
-
-    <section class="section-faq">
-      <FAQSection items={content.faq} />
-    </section>
-
-    <section class="section-bibliography">
-      <Bibliography links={content.bibliography} />
-    </section>
-  </div>
-</PreviewLayout>
-
-<style>
-  .tool-page {
-    display: flex;
-    flex-direction: column;
-    gap: 2rem;
-  }
-  .section-tool {
-    max-width: 1200px;
-    margin: 0 auto;
-    width: 100%;
-  }
-  .section-seo,
-  .section-faq,
-  .section-bibliography {
-    padding-top: 2rem;
-    border-top: 1px solid var(--border-color);
-  }
-</style>
+const cssLoader = cssKey ? cssFiles[cssKey] : undefined;
+const toolCss = cssLoader ? await cssLoader() as string : "";
+
+const seoContent: UtilitySEOContent = { locale, sections: content.seo ?? [] };
+
+const words = content.title.split(" ");
+const titleHighlight = words[0] || "";
+const titleBase = words.slice(1).join(" ") || "";
+---
+
+<PreviewLayout
+  title={content.title}
+  currentLocale={locale}
+  localeUrls={localeUrls}
+  hasSidebar={true}
+>
+  <PreviewNavSidebar
+    slot="sidebar"
+    categoryTitle="Tools"
+    tools={allToolsNav}
+  />
+  <Fragment slot="head">
+    {toolCss ? <Fragment set:html={`<style is:inline>${toolCss}</style>`} /> : null}
+    {
+      ( content.schemas ?? []).map((schema: unknown) => (
+        <script
+          is:inline
+          type="application/ld+json"
+          set:html={JSON.stringify(schema)}
+        />
+      ))
+    }
+  </Fragment>
+
+  <div class="tool-page">
+    <UtilityHeader
+      titleHighlight={titleHighlight}
+      titleBase={titleBase}
+      description={content.description}
+    />
+
+    <section class="section-tool">
+      <Component ui={content.ui} />
+    </section>
+
+    <section class="section-seo">
+      <SEORenderer content={seoContent} />
+    </section>
+
+    <section class="section-faq">
+      <FAQSection items={content.faq} />
+    </section>
+
+    <section class="section-bibliography">
+      <Bibliography links={content.bibliography} />
+    </section>
+  </div>
+</PreviewLayout>
+
+<style>
+  .tool-page {
+    display: flex;
+    flex-direction: column;
+    gap: 2rem;
+  }
+  .section-tool {
+    max-width: 1200px;
+    margin: 0 auto;
+    width: 100%;
+  }
+  .section-seo,
+  .section-faq,
+  .section-bibliography {
+    padding-top: 2rem;
+    border-top: 1px solid var(--border-color);
+  }
+</style>

package/src/pages/index.astro

@@ -1,4 +1,4 @@
 ---
 ---
 <meta http-equiv="refresh" content="0;url=/es" />
-
+

package/src/tests/bibliography_wellformed_export.test.ts

@@ -0,0 +1,46 @@
+import { describe, it, expect } from 'vitest';
+import { readdirSync, readFileSync, existsSync } from 'fs';
+import { join, relative } from 'path';
+
+function findBibliographyAstroFiles(dir: string): string[] {
+  const files: string[] = [];
+  if (!existsSync(dir)) return files;
+  const entries = readdirSync(dir, { withFileTypes: true });
+
+  for (const entry of entries) {
+    const fullPath = join(dir, entry.name);
+    if (entry.isDirectory()) {
+      files.push(...findBibliographyAstroFiles(fullPath));
+    } else if (entry.isFile() && entry.name === 'bibliography.astro') {
+      files.push(fullPath);
+    }
+  }
+
+  return files;
+}
+
+const toolDir = join(process.cwd(), 'src', 'tool');
+const bibliographyFiles = findBibliographyAstroFiles(toolDir);
+
+describe('Bibliography Component Wellformed Export', () => {
+  it('found tool bibliography.astro components', () => {
+    expect(bibliographyFiles.length).toBeGreaterThan(0);
+  });
+
+  bibliographyFiles.forEach((file) => {
+    const relativePath = relative(process.cwd(), file);
+
+    it(`${relativePath} should use SharedBibliography from @jjlmoya/utils-shared`, () => {
+      const content = readFileSync(file, 'utf-8');
+
+      const usesSharedComponent =
+        content.includes('@jjlmoya/utils-shared') &&
+        (content.includes('Bibliography') || content.includes('SharedBibliography'));
+
+      expect(
+        usesSharedComponent,
+        `File "${relativePath}" does not use the standard Bibliography component from @jjlmoya/utils-shared, resulting in unstyled or raw bibliography output.`,
+      ).toBe(true);
+    });
+  });
+});

package/src/tests/category_seo_quality.test.ts

@@ -0,0 +1,74 @@
+import { describe, expect, it } from 'vitest';
+import type { CategoryLocaleContent } from '../types';
+
+const EXPECTED_LOCALES = [
+  'de', 'en', 'es', 'fr', 'id', 'it', 'ja', 'ko', 'nl', 'pl', 'pt', 'ru', 'sv', 'tr', 'zh',
+] as const;
+const COMPACT_LOCALES = new Set(['ja', 'ko', 'zh']);
+
+const localeModules = import.meta.glob('../category/i18n/*.ts', { eager: true }) as Record<
+  string,
+  { content: CategoryLocaleContent }
+>;
+
+function textFrom(value: unknown): string {
+  if (typeof value === 'string') return value.replace(/<[^>]*>/g, ' ');
+  if (Array.isArray(value)) return value.map(textFrom).join(' ');
+  if (value && typeof value === 'object') return Object.values(value).map(textFrom).join(' ');
+  return '';
+}
+
+const STRONG_CLAIM = /\b(?:garantiz\w*|guarante\w*|validat(?:ed)|valid(?:ated|ado|ada|ados|adas|ée|ées)|actualizad\w*)\b/iu;
+
+function getContents(): Map<string, CategoryLocaleContent> {
+  return new Map(
+    Object.entries(localeModules).map(([file, module]) => [file.match(/\/([a-z]{2})\.ts$/u)?.[1] ?? file, module.content]),
+  );
+}
+
+function validateContent(locale: string, content: CategoryLocaleContent): string[] {
+  const failures: string[] = [];
+  const check = (condition: boolean, message: string) => { if (!condition) failures.push(`${locale}: ${message}`); };
+  const minimumTitleLength = COMPACT_LOCALES.has(locale) ? 4 : 12;
+  const minimumDescriptionLength = COMPACT_LOCALES.has(locale) ? 20 : 60;
+  check(content.title.trim().length >= minimumTitleLength && content.title.trim().length <= 70, 'title must use a useful 4/12–70 character length');
+  check(content.description.trim().length >= minimumDescriptionLength && content.description.trim().length <= 180, 'description must use a useful 20/60–180 character length');
+  check(content.seo.length >= 2, 'SEO needs at least two sections');
+  check(content.seo.some((section) => section.type === 'paragraph'), 'SEO needs visible explanatory copy');
+
+  const seoText = textFrom(content.seo).replace(/\s+/g, ' ').trim();
+  const minimumSeoLength = COMPACT_LOCALES.has(locale) ? 120 : 240;
+  check(seoText.length >= minimumSeoLength, 'SEO copy must contain the minimum visible copy for its script');
+  check(content.seo.filter((section) => section.type === 'title').length >= 1, 'SEO needs a section heading');
+  check(!/[�]/u.test(seoText), 'SEO contains replacement characters');
+  check(!/ {2,}/u.test(seoText), 'SEO contains duplicated whitespace');
+  check(!STRONG_CLAIM.test(seoText), 'SEO contains an unsupported strong claim');
+
+  check(content.slug.trim().length > 0 && /^[a-z0-9-]+$/u.test(content.slug), 'slug must be a non-empty URL-safe value');
+  return failures;
+}
+
+describe('Category SEO quality contract', () => {
+  it('has one content file for every configured locale', () => {
+    const contents = getContents();
+    expect([...contents.keys()].sort()).toEqual([...EXPECTED_LOCALES].sort());
+  });
+
+  it('keeps metadata, SEO structure and copy quality above the minimum in every locale', () => {
+    const contents = getContents();
+    const english = contents.get('en');
+    expect(english, 'English category content is required as the structural reference').toBeDefined();
+
+    const failures = EXPECTED_LOCALES.flatMap((locale) => {
+      const content = contents.get(locale);
+      return content ? validateContent(locale, content) : [];
+    });
+
+    for (const locale of EXPECTED_LOCALES) {
+      const content = contents.get(locale);
+      if (!content) failures.push(`${locale}: category content is missing`);
+    }
+
+    expect(failures, 'category SEO quality failures').toEqual([]);
+  }, 30000);
+});

package/src/tests/i18n_coverage.test.ts

@@ -1,36 +1,36 @@
-import { describe, it, expect } from 'vitest';
-import { ALL_TOOLS } from '../tools';
-
-const EXPECTED_LOCALES = [
-  'de', 'en', 'es', 'fr', 'id', 'it', 'ja', 'ko', 'nl', 'pl', 'pt', 'ru', 'sv', 'tr', 'zh'
-];
-
-describe('I18n Coverage Validation', () => {
-  it('all tools should be registered', () => {
-    expect(ALL_TOOLS.length).toBeGreaterThan(0);
-  });
-
-  ALL_TOOLS.forEach(({ entry }: { entry: any }) => {
-    describe(`Tool: ${entry.id}`, () => {
-      it('should have all 15 required locales', () => {
-        const registeredLocales = Object.keys(entry.i18n);
-        EXPECTED_LOCALES.forEach((locale) => {
-          expect(
-            registeredLocales,
-            `Tool "${entry.id}" is missing locale "${locale}"`,
-          ).toContain(locale);
-        });
-      });
-
-      it('all locale loaders should be functions', () => {
-        EXPECTED_LOCALES.forEach((locale) => {
-          const loader = entry.i18n[locale as keyof typeof entry.i18n];
-          expect(
-            typeof loader,
-            `Tool "${entry.id}" locale "${locale}" loader is not a function`,
-          ).toBe('function');
-        });
-      });
-    });
-  });
-});
+import { describe, it, expect } from 'vitest';
+import { ALL_TOOLS } from '../tools';
+
+const EXPECTED_LOCALES = [
+  'de', 'en', 'es', 'fr', 'id', 'it', 'ja', 'ko', 'nl', 'pl', 'pt', 'ru', 'sv', 'tr', 'zh'
+];
+
+describe('I18n Coverage Validation', () => {
+  it('all tools should be registered', () => {
+    expect(ALL_TOOLS.length).toBeGreaterThan(0);
+  });
+
+  ALL_TOOLS.forEach(({ entry }: { entry: any }) => {
+    describe(`Tool: ${entry.id}`, () => {
+      it('should have all 15 required locales', () => {
+        const registeredLocales = Object.keys(entry.i18n);
+        EXPECTED_LOCALES.forEach((locale) => {
+          expect(
+            registeredLocales,
+            `Tool "${entry.id}" is missing locale "${locale}"`,
+          ).toContain(locale);
+        });
+      });
+
+      it('all locale loaders should be functions', () => {
+        EXPECTED_LOCALES.forEach((locale) => {
+          const loader = entry.i18n[locale as keyof typeof entry.i18n];
+          expect(
+            typeof loader,
+            `Tool "${entry.id}" locale "${locale}" loader is not a function`,
+          ).toBe('function');
+        });
+      });
+    });
+  });
+});

package/src/tests/mocks/astro_mock.js

@@ -1,2 +1,2 @@
 export default function () { return null; }
-
+

package/src/tests/no_em_dash.test.ts

@@ -1,47 +1,47 @@
-import { describe, it } from 'vitest';
-import fs from 'node:fs';
-import path from 'node:path';
-
-function getFiles(dir: string, ext: string[]): string[] {
-  const results: string[] = [];
-  if (!fs.existsSync(dir)) return results;
-  const list = fs.readdirSync(dir);
-  for (const file of list) {
-    const fullPath = path.join(dir, file);
-    const stat = fs.statSync(fullPath);
-    if (stat && stat.isDirectory()) {
-      results.push(...getFiles(fullPath, ext));
-    } else if (ext.some((e) => file.endsWith(e))) {
-      results.push(fullPath);
-    }
-  }
-  return results;
-}
-
-const EM_DASH = '\u2014';
-
-describe('Em Dash Prohibition', () => {
-  const files = [
-    ...getFiles(path.join(process.cwd(), 'src', 'tool'), ['.ts']),
-    ...getFiles(path.join(process.cwd(), 'src', 'category'), ['.ts']),
-  ].filter(f => f.includes('i18n'));
-
-  it.each(files)('should not contain em dash (—) in %s', (filePath) => {
-    const content = fs.readFileSync(filePath, 'utf-8');
-    const relativePath = path.relative(process.cwd(), filePath);
-
-    const lines = content.split('\n');
-    const findings: { line: number; text: string }[] = [];
-
-    lines.forEach((line, index) => {
-      if (line.includes(EM_DASH)) {
-        findings.push({ line: index + 1, text: line.trim() });
-      }
-    });
-
-    if (findings.length > 0) {
-      const list = findings.map((f) => `  Line ${f.line}: ${f.text}`).join('\n');
-      throw new Error(`Em dash (—) found in ${relativePath}:\n${list}`);
-    }
-  });
-});
+import { describe, it } from 'vitest';
+import fs from 'node:fs';
+import path from 'node:path';
+
+function getFiles(dir: string, ext: string[]): string[] {
+  const results: string[] = [];
+  if (!fs.existsSync(dir)) return results;
+  const list = fs.readdirSync(dir);
+  for (const file of list) {
+    const fullPath = path.join(dir, file);
+    const stat = fs.statSync(fullPath);
+    if (stat && stat.isDirectory()) {
+      results.push(...getFiles(fullPath, ext));
+    } else if (ext.some((e) => file.endsWith(e))) {
+      results.push(fullPath);
+    }
+  }
+  return results;
+}
+
+const EM_DASH = '\u2014';
+
+describe('Em Dash Prohibition', () => {
+  const files = [
+    ...getFiles(path.join(process.cwd(), 'src', 'tool'), ['.ts']),
+    ...getFiles(path.join(process.cwd(), 'src', 'category'), ['.ts']),
+  ].filter(f => f.includes('i18n'));
+
+  it.each(files)('should not contain em dash (—) in %s', (filePath) => {
+    const content = fs.readFileSync(filePath, 'utf-8');
+    const relativePath = path.relative(process.cwd(), filePath);
+
+    const lines = content.split('\n');
+    const findings: { line: number; text: string }[] = [];
+
+    lines.forEach((line, index) => {
+      if (line.includes(EM_DASH)) {
+        findings.push({ line: index + 1, text: line.trim() });
+      }
+    });
+
+    if (findings.length > 0) {
+      const list = findings.map((f) => `  Line ${f.line}: ${f.text}`).join('\n');
+      throw new Error(`Em dash (—) found in ${relativePath}:\n${list}`);
+    }
+  });
+});