UNPKG

akasharender

Version:

Rendering support for generating static HTML websites or EPUB eBooks

111 lines 13.5 kB
/** * * Copyright 2014-2025 David Herron * * This file is part of AkashaCMS (http://akashacms.com/). * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ import { promises as fsp } from 'node:fs'; import matter from 'gray-matter'; /** * Refactor tag names across all documents. * Changes all occurrences of oldTag to newTag in document frontmatter. * * @param config - The AkashaRender configuration * @param oldTag - The tag name to replace * @param newTag - The new tag name * @param options - Options including dryRun mode * @returns Result object with details of all changes made or that would be made */ export async function refactorTag(config, oldTag, newTag, options) { const result = { oldTag, newTag, dryRun: options.dryRun, modifiedDocuments: [], mergedDocuments: [], errors: [] }; // Get documents cache from the filecache const filecache = config.akasha.filecache; const documentsCache = filecache.documentsCache; // Find all documents with the old tag const vpaths = await documentsCache.documentsWithTag(oldTag); for (const vpath of vpaths) { try { // Get the document info to get the filesystem path const docInfo = await documentsCache.find(vpath); if (!docInfo || !docInfo.fspath) { result.errors.push({ vpath, fspath: '', error: `Could not find document info for ${vpath}` }); continue; } const fspath = docInfo.fspath; // Read the file const content = await fsp.readFile(fspath, 'utf-8'); // Parse frontmatter const parsed = matter(content); const originalTags = Array.isArray(parsed.data.tags) ? [...parsed.data.tags] : []; // Check if document already has the new tag const hasNewTag = originalTags.includes(newTag); const hasOldTag = originalTags.includes(oldTag); if (!hasOldTag) { // This shouldn't happen, but handle it gracefully continue; } // Compute new tags array let newTags; if (hasNewTag) { // Document already has new tag, just remove the old tag newTags = originalTags.filter(t => t !== oldTag); } else { // Replace old tag with new tag newTags = originalTags.map(t => t === oldTag ? newTag : t); } const change = { vpath, fspath, originalTags, newTags }; if (hasNewTag) { result.mergedDocuments.push(change); } else { result.modifiedDocuments.push(change); } // If not dry run, write the file if (!options.dryRun) { parsed.data.tags = newTags; const newContent = matter.stringify(parsed.content, parsed.data); await fsp.writeFile(fspath, newContent, 'utf-8'); } } catch (err) { result.errors.push({ vpath, fspath: '', error: err instanceof Error ? err.message : String(err) }); } } return result; } //# sourceMappingURL=data:application/json;base64,{"version":3,"file":"refactor-tags.js","sourceRoot":"","sources":["../lib/refactor-tags.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,EAAE,QAAQ,IAAI,GAAG,EAAE,MAAM,SAAS,CAAC;AAC1C,OAAO,MAAM,MAAM,aAAa,CAAC;AAajC;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC7B,MAAqB,EACrB,MAAc,EACd,MAAc,EACd,OAAwB;IAExB,MAAM,MAAM,GAAsB;QAC9B,MAAM;QACN,MAAM;QACN,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,iBAAiB,EAAE,EAAE;QACrB,eAAe,EAAE,EAAE;QACnB,MAAM,EAAE,EAAE;KACb,CAAC;IAEF,yCAAyC;IACzC,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC;IAC1C,MAAM,cAAc,GAAG,SAAS,CAAC,cAAc,CAAC;IAEhD,sCAAsC;IACtC,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAE7D,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QACzB,IAAI,CAAC;YACD,mDAAmD;YACnD,MAAM,OAAO,GAAG,MAAM,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACjD,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;gBAC9B,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC;oBACf,KAAK;oBACL,MAAM,EAAE,EAAE;oBACV,KAAK,EAAE,oCAAoC,KAAK,EAAE;iBACrD,CAAC,CAAC;gBACH,SAAS;YACb,CAAC;YAED,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;YAE9B,gBAAgB;YAChB,MAAM,OAAO,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAEpD,oBAAoB;YACpB,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;YAC/B,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;gBAChD,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;gBACvB,CAAC,CAAC,EAAE,CAAC;YAET,4CAA4C;YAC5C,MAAM,SAAS,GAAG,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YAChD,MAAM,SAAS,GAAG,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YAEhD,IAAI,CAAC,SAAS,EAAE,CAAC;gBACb,kDAAkD;gBAClD,SAAS;YACb,CAAC;YAED,yBAAyB;YACzB,IAAI,OAAiB,CAAC;YACtB,IAAI,SAAS,EAAE,CAAC;gBACZ,wDAAwD;gBACxD,OAAO,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC;YACrD,CAAC;iBAAM,CAAC;gBACJ,+BAA+B;gBAC/B,OAAO,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC/D,CAAC;YAED,MAAM,MAAM,GAA2B;gBACnC,KAAK;gBACL,MAAM;gBACN,YAAY;gBACZ,OAAO;aACV,CAAC;YAEF,IAAI,SAAS,EAAE,CAAC;gBACZ,MAAM,CAAC,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACxC,CAAC;iBAAM,CAAC;gBACJ,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC1C,CAAC;YAED,iCAAiC;YACjC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;gBAClB,MAAM,CAAC,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC;gBAC3B,MAAM,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;gBACjE,MAAM,GAAG,CAAC,SAAS,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;YACrD,CAAC;QACL,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC;gBACf,KAAK;gBACL,MAAM,EAAE,EAAE;gBACV,KAAK,EAAE,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC;aAC1D,CAAC,CAAC;QACP,CAAC;IACL,CAAC;IAED,OAAO,MAAM,CAAC;AAClB,CAAC","sourcesContent":["/**\n *\n * Copyright 2014-2025 David Herron\n *\n * This file is part of AkashaCMS (http://akashacms.com/).\n *\n *  Licensed under the Apache License, Version 2.0 (the \"License\");\n *  you may not use this file except in compliance with the License.\n *  You may obtain a copy of the License at\n *\n *      http://www.apache.org/licenses/LICENSE-2.0\n *\n *  Unless required by applicable law or agreed to in writing, software\n *  distributed under the License is distributed on an \"AS IS\" BASIS,\n *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n *  See the License for the specific language governing permissions and\n *  limitations under the License.\n */\n\nimport { promises as fsp } from 'node:fs';\nimport matter from 'gray-matter';\n\nimport type { Configuration } from './index.js';\nimport type {\n    RefactorTagResult,\n    RefactorDocumentChange,\n    RefactorError\n} from './types.js';\n\nexport interface RefactorOptions {\n    dryRun: boolean;\n}\n\n/**\n * Refactor tag names across all documents.\n * Changes all occurrences of oldTag to newTag in document frontmatter.\n * \n * @param config - The AkashaRender configuration\n * @param oldTag - The tag name to replace\n * @param newTag - The new tag name\n * @param options - Options including dryRun mode\n * @returns Result object with details of all changes made or that would be made\n */\nexport async function refactorTag(\n    config: Configuration,\n    oldTag: string,\n    newTag: string,\n    options: RefactorOptions\n): Promise<RefactorTagResult> {\n    const result: RefactorTagResult = {\n        oldTag,\n        newTag,\n        dryRun: options.dryRun,\n        modifiedDocuments: [],\n        mergedDocuments: [],\n        errors: []\n    };\n\n    // Get documents cache from the filecache\n    const filecache = config.akasha.filecache;\n    const documentsCache = filecache.documentsCache;\n\n    // Find all documents with the old tag\n    const vpaths = await documentsCache.documentsWithTag(oldTag);\n\n    for (const vpath of vpaths) {\n        try {\n            // Get the document info to get the filesystem path\n            const docInfo = await documentsCache.find(vpath);\n            if (!docInfo || !docInfo.fspath) {\n                result.errors.push({\n                    vpath,\n                    fspath: '',\n                    error: `Could not find document info for ${vpath}`\n                });\n                continue;\n            }\n\n            const fspath = docInfo.fspath;\n\n            // Read the file\n            const content = await fsp.readFile(fspath, 'utf-8');\n\n            // Parse frontmatter\n            const parsed = matter(content);\n            const originalTags = Array.isArray(parsed.data.tags) \n                ? [...parsed.data.tags] \n                : [];\n\n            // Check if document already has the new tag\n            const hasNewTag = originalTags.includes(newTag);\n            const hasOldTag = originalTags.includes(oldTag);\n\n            if (!hasOldTag) {\n                // This shouldn't happen, but handle it gracefully\n                continue;\n            }\n\n            // Compute new tags array\n            let newTags: string[];\n            if (hasNewTag) {\n                // Document already has new tag, just remove the old tag\n                newTags = originalTags.filter(t => t !== oldTag);\n            } else {\n                // Replace old tag with new tag\n                newTags = originalTags.map(t => t === oldTag ? newTag : t);\n            }\n\n            const change: RefactorDocumentChange = {\n                vpath,\n                fspath,\n                originalTags,\n                newTags\n            };\n\n            if (hasNewTag) {\n                result.mergedDocuments.push(change);\n            } else {\n                result.modifiedDocuments.push(change);\n            }\n\n            // If not dry run, write the file\n            if (!options.dryRun) {\n                parsed.data.tags = newTags;\n                const newContent = matter.stringify(parsed.content, parsed.data);\n                await fsp.writeFile(fspath, newContent, 'utf-8');\n            }\n        } catch (err) {\n            result.errors.push({\n                vpath,\n                fspath: '',\n                error: err instanceof Error ? err.message : String(err)\n            });\n        }\n    }\n\n    return result;\n}\n"]}