@loopress/cli 0.27.0 → 0.29.0

package/dist/utils/seo-format.d.ts

@@ -17,13 +17,13 @@ export type RemoteSeoSettings = {
     settings: Record<string, unknown>;
 };
 export type SeoRedirect = {
-    createdAt: string | undefined;
+    createdAt: null | string;
     headerCode: number;
     hits: number;
     id: number;
     sources: unknown;
     status: string;
-    updatedAt: string | undefined;
+    updatedAt: null | string;
     urlTo: string;
 };
 export declare function redirectFileBase(redirect: SeoRedirect): string;

package/dist/utils/template-format.d.ts

@@ -0,0 +1,31 @@
+import { type PageProblem, type SlugRule } from './page-format.js';
+export declare const CHILD_THEME_ENDPOINT = "loopress/v1/child-theme";
+export declare const TEMPLATE_SLUG_RULE: SlugRule;
+export type Template = {
+    html: string;
+    postTypes?: string[];
+    slug: string;
+    title?: string;
+};
+export type Part = {
+    area: string;
+    html: string;
+    slug: string;
+    title: string;
+};
+export type ChildTheme = {
+    active: boolean;
+    customized: string[];
+    exists: boolean;
+    parent: string;
+    parts: Part[];
+    stylesheet: string;
+    templates: Template[];
+};
+export declare function parseTemplateFile(slug: string, raw: string): Template;
+export declare function parsePartFile(slug: string, raw: string): Part;
+export declare function readLocalTemplates(templatesDir: string, partsDir: string): Promise<{
+    parts: Part[];
+    problems: PageProblem[];
+    templates: Template[];
+}>;

package/dist/utils/template-format.js

@@ -0,0 +1,43 @@
+import { parseHtmlHeader, readLocalHtmlFiles, titleFromSlug } from './page-format.js';
+export const CHILD_THEME_ENDPOINT = 'loopress/v1/child-theme';
+// Mirrored server-side in ChildThemeController. Looser than a page slug: the template hierarchy
+// embeds post type and taxonomy slugs as is (`taxonomy-download_tag`, `single-my_type`), and those
+// follow sanitize_key(), so lowercase letters, digits, `_` and `-`.
+export const TEMPLATE_SLUG_RULE = {
+    message: 'the file name must be lowercase letters, digits, "_" and "-" (e.g. "taxonomy-download_tag.html")',
+    pattern: /^[a-z0-9_-]+$/,
+};
+// A block delimiter as the first line (`<!-- wp:template-part ... /-->`, the usual one) is markup,
+// not a header.
+const BLOCK_START = /^\s*<!--\s*\/?wp:/;
+// `{"slug":"header","theme":"twentytwentyfive"}` makes WordPress load the named theme's part, so
+// the child's own parts/header.html would be silently ignored.
+const THEMED_PART = /<!--\s*wp:template-part\s+\{[^}]*"theme"\s*:/;
+function parseFile(raw, keys) {
+    const parsed = BLOCK_START.test(raw) ? { body: raw, meta: {} } : parseHtmlHeader(raw, keys);
+    if (THEMED_PART.test(parsed.body)) {
+        throw new Error('a template-part block has a "theme" attribute, remove it: WordPress would load that theme\'s part instead of the one in parts/');
+    }
+    return parsed;
+}
+export function parseTemplateFile(slug, raw) {
+    const { body, meta } = parseFile(raw, ['title', 'postTypes']);
+    const template = { html: body, slug };
+    if (meta.title)
+        template.title = meta.title;
+    if (meta.postTypes)
+        template.postTypes = meta.postTypes.split(',').map((type) => type.trim()).filter(Boolean);
+    return template;
+}
+// `area` defaults from the name, the way themes name their parts: header, header-large-title...
+export function parsePartFile(slug, raw) {
+    const { body, meta } = parseFile(raw, ['title', 'area']);
+    const nameArea = /^(header|footer)(-|$)/.exec(slug)?.[1] ?? 'uncategorized';
+    return { area: meta.area || nameArea, html: body, slug, title: meta.title || titleFromSlug(slug) };
+}
+// Same directory rules as pages/ (flat, `.html` only), with template slugs, every problem at once.
+export async function readLocalTemplates(templatesDir, partsDir) {
+    const templates = await readLocalHtmlFiles(templatesDir, parseTemplateFile, TEMPLATE_SLUG_RULE);
+    const parts = await readLocalHtmlFiles(partsDir, parsePartFile, TEMPLATE_SLUG_RULE);
+    return { parts: parts.files, problems: [...templates.problems, ...parts.problems], templates: templates.files };
+}