/* Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you 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. */ /* Provides a set of utility methods, which can also be spied on during unit tests. */ // TODO: Perhaps this should live in cordova-common? const fs = require('fs-extra'); const which = require('which'); const os = require('os'); /** * Reads, searches, and replaces the found occurences with replacementString and then writes the file back out. * A backup is not made. * * @param {string} file A file path to a readable & writable file * @param {RegExp} searchRegex The search regex * @param {string} replacementString The string to replace the found occurences * @returns void */ exports.replaceFileContents = function (file, searchRegex, replacementString) { let contents = fs.readFileSync(file).toString(); contents = contents.replace(searchRegex, replacementString); fs.writeFileSync(file, contents); }; // Some helpers for easier sorting exports.compare = (a, b) => (a < b && -1) || +(a > b); exports.compareBy = f => (a, b) => exports.compare(f(a), f(b)); exports.compareByAll = fns => { const comparators = fns.map(exports.compareBy); return (a, b) => { for (const cmp of comparators) { const result = cmp(a, b); if (result) return result; } return 0; }; }; exports.forgivingWhichSync = (cmd) => { const whichResult = which.sync(cmd, { nothrow: true }); // On null, returns empty string to maintain backwards compatibility // realpathSync follows symlinks return whichResult === null ? '' : fs.realpathSync(whichResult); }; exports.isWindows = () => os.platform() === 'win32'; exports.isDarwin = () => os.platform() === 'darwin'; const UNESCAPED_REGEX = /[&<>"']/g; const escapes = { '&': '&', '<': '<', '>': '>', '"': '"', "'": ''' }; /** * Converts the characters "&", "<", ">", '"' and "'" in the given string to * their corresponding escaped value * @param {string} str the string to be escaped * @returns the escaped string */ exports.escape = (str) => UNESCAPED_REGEX.test(str) ? str.replace(UNESCAPED_REGEX, (key) => escapes[key]) : str;