Obsidian Longform plugin - replace text using regular expressions

replace.js

// MIT License
//  
// Copyright (c) 2024 Timberfang
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

module.exports = {
    description: {
        name: "Replace Text",
        description: "Replaces text using regex",
        availableKinds: ["Scene", "Manuscript"],
        options: [
            {
                id: "pattern",
                name: "Pattern",
                description: "Regex pattern to search for",
                type: "Text", // Use "Text" for string type
                default: "",
            },
            {
                id: "replacement",
                name: "Replacement",
                description: "String to replace the matched pattern",
                type: "Text", // Use "Text" for string type
                default: "",
            },
        ],
    },

    compile: compile,
};

async function compile(input, context) {
    const { optionValues } = context;
    const { contents } = input;

    try {
        // If a regex pattern is provided, do replacement
        if (optionValues.pattern != "" && optionValues.replacement != "") {
            const pattern = new RegExp(optionValues.pattern, "g");
            const replacedContents = contents.replace(pattern, optionValues.replacement);

            // Return the updated Manuscript contents
            return { contents: replacedContents };
        }
        else {
            return { contents: contents }; // If no pattern provided, return original text
        }
    } catch (error) {
        // Handle regex compilation errors or other issues
        throw new Error(`Error in regex: ${error.message}`);
    }
}