testophobia/lib/utils/file/file-name.js

Web application snapshot tester

import Base58 from 'bs58';

/**
 * Clean a file name string, replacing non-alphanumeric characters with hyphens
 *
 * @param {string} s The file name to be cleaned
 * @return {string} The cleansed file name
 */
export const cleanFileName = s => {
  if (!s) return 0;
  return s.replace(/ /g, '-').replace(/[`~!@#$%^&*()_|+\-=÷¿?;:'",.<>\{\}\[\]\\\/]/g, '-'); //eslint-disable-line no-useless-escape
};

/**
 * Get the encoded name of the initial test snapshot file
 *
 * @param {boolean} scaled The file is the post-resizing version
 * @return {string} The encoded file name
 */
export const getIntialStateFileName = scaled => {
  return Base58.encode(Buffer.from('initial-state', 'binary')) + (!scaled ? '-unscaled' : '');
};

/**
 * Get the encoded name of the test action snapshot file
 * @param {number} index The index of the action within the test
 * @param {object} action The test action reference
 * @param {boolean} skipEncode Skip encoding the file name (for display purposes)
 * @return {string} The encoded action file name
 */
export const getActionFileName = (index, action, skipEncode) => {
  const desc = cleanFileName(action.description);
  const target = cleanFileName(action.target);
  const genName = `${index}-${action.type}-${target}`;
  const name = desc ? desc : genName;
  return skipEncode ? (desc ? action.description : genName) : Base58.encode(Buffer.from(name, 'binary'));
};