All files / packages/design-system/scripts/scs file-parser.js

98.88% Statements 89/90
95.83% Branches 23/24
97.22% Functions 35/36
98.8% Lines 83/84

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278      1x                                                                                                                     14x   12x 12x   12x     12x     12x     12x     12x     12x     12x 3x       12x   121x     12x 12x 12x 12x   12x 12x     12x   14x     12x 12x 12x 4x   12x 12x     12x   12x 111x 111x     12x   81x         12x     1x 12x   1x 6x         1x 12x                 1x 12x 150x     72x           1x 3x 7x     18x           16x 55x 55x 55x           12x 72x 72x 72x             81x       81x 81x       81x               1x 182x 182x 182x 182x     1x 182x   1x 393x   1x   1x 394x 394x     17x                                 64x 393x               1x 70x         78x 78x               1x 102x      
import * as autoVersion from './version-utils.js';
import _ from 'lodash';
 
const templates = [
  {
    filePath: 'slds/slds-.css',
    contentType: 'text/css',
    name: 'slds.css',
    properties: {
      version: '',
    },
  },
  {
    filePath: 'slds/slds-offline-.css',
    contentType: 'text/css',
    name: 'slds-offline.css',
    properties: {
      version: '',
    },
  },
  {
    filePath: 'slds/slds-legacy-.css',
    contentType: 'text/css',
    name: 'slds-legacy.css',
    properties: {
      version: '',
    },
  },
  {
    filePath: 'slds/slds-touch-.css',
    contentType: 'text/css',
    name: 'slds-touch.css',
    properties: {
      version: '',
    },
  },
  {
    filePath: 'slds/slds-plus-.css',
    contentType: 'text/css',
    name: 'slds-plus.css',
    properties: {
      version: '',
    },
  },
  {
    filePath: 'slds/scoped-slds-plus-.css',
    contentType: 'text/css',
    name: 'scoped-slds-plus.css',
    properties: {
      version: '',
    },
  },
];
 
export function FileParser(
  sldsVersionSemver,
  lwrMappedVersion,
  originalData,
  rejectFiles = [],
  nVers = [3, 3, 3],
  slds2VersionSemver = null,
) {
  if (!hasValidSemver(sldsVersionSemver)) return [originalData, []];
 
  const jsonData = _.cloneDeep(originalData);
  let files = jsonData.files;
 
  let [lwr, semver] = _.partition(files, isLWRFileEntry);
 
  // add any missing semver entries for legacy LWR entries
  const semverEntriesFromLWR = generateSemverEntriesFromLWR(lwr);
 
  // Combine semver entries with those generated from LWR
  semver = semver.concat(semverEntriesFromLWR);
 
  // generate complete set of LWR entries
  lwr = updateLWREntries(lwr, sldsVersionSemver, lwrMappedVersion);
 
  // Separate SLDS and SLDS+ files for independent version retention
  let [sldsPlusFiles, sldsFiles] = _.partition(semver, isSldsPlusFile);
 
  // generate complete set of semver entries for SLDS files
  sldsFiles = updateSemverEntries(sldsFiles, sldsVersionSemver);
 
  // generate semver entries for SLDS+ files if version provided
  if (slds2VersionSemver && hasValidSemver(slds2VersionSemver)) {
    sldsPlusFiles = updateSlds2SemverEntries(sldsPlusFiles, slds2VersionSemver);
  }
 
  // Apply version retention separately for SLDS files
  sldsFiles = _.uniqBy(
    sldsFiles,
    (entry) => `${entry.properties.version}---${entry.name}`,
  ).reverse();
 
  let sldsGrpVer = filesToGroups('major')(sldsFiles);
  sldsGrpVer = _.mapValues(sldsGrpVer, filesToGroups('minor'));
  sldsGrpVer = _.mapValues(sldsGrpVer, (g) =>
    _.mapValues(g, filesToGroups('patch')),
  );
  sldsGrpVer = filterGroups(nVers, sldsGrpVer);
  const filteredSldsFiles = groupsToFiles(sldsGrpVer);
 
  // Apply version retention separately for SLDS+ files
  sldsPlusFiles = _.uniqBy(
    sldsPlusFiles,
    (entry) => `${entry.properties.version}---${entry.name}`,
  ).reverse();
 
  let sldsPlusGrpVer = filesToGroups('major')(sldsPlusFiles);
  sldsPlusGrpVer = _.mapValues(sldsPlusGrpVer, filesToGroups('minor'));
  sldsPlusGrpVer = _.mapValues(sldsPlusGrpVer, (g) =>
    _.mapValues(g, filesToGroups('patch')),
  );
  sldsPlusGrpVer = filterGroups(nVers, sldsPlusGrpVer);
  const filteredSldsPlusFiles = groupsToFiles(sldsPlusGrpVer);
 
  // Combine all files
  jsonData.files = [...filteredSldsFiles, ...filteredSldsPlusFiles];
 
  const keepPaths = jsonData.files.reduce((acc, file) => {
    acc[file.filePath] = true;
    return acc;
  }, {});
 
  rejectFiles = _.uniqBy(
    rejectFiles.concat(
      originalData.files.filter((file) => !keepPaths[file.filePath]),
    ),
    'filePath',
  );
 
  return [jsonData, rejectFiles];
}
 
const generateSemverEntriesFromLWR = (files) =>
  files
    .map((file) =>
      templates
        .filter((t) => t.name === file.name)
        .map(createSldsSemverFile(getVersionStringFromFilename(file))),
    )
    .flat();
 
const updateLWREntries = (files, sldsVersionSemver, lwrMappedVersion) =>
  files
    .sort((a, b) => a.properties.version - b.properties.version)
    .concat(
      templates
        .map(_.cloneDeep)
        .map(createLWRFile(sldsVersionSemver, lwrMappedVersion)),
    )
    .reverse(); // ensure that uniqBy selects the newest entries
 
const updateSemverEntries = (files, sldsVersionSemver) =>
  files
    .sort((a, b) => semverDistanceFromString(a.filePath, b.filePath))
    .concat(
      templates
        .filter((t) => !t.name.includes('slds-plus'))
        .map(_.cloneDeep)
        .map(createSldsSemverFile(sldsVersionSemver)),
    )
    .reverse();
 
const updateSlds2SemverEntries = (files, slds2VersionSemver) =>
  files
    .sort((a, b) => semverDistanceFromString(a.filePath, b.filePath))
    .concat(
      templates
        .filter((t) => t.name.includes('slds-plus'))
        .map(_.cloneDeep)
        .map(createSldsSemverFile(slds2VersionSemver)),
    )
    .reverse();
 
const createSldsSemverFile = (sldsVersionString) => (file) => {
  const fileName = file.filePath.split('-').slice(0, -1).join('-');
  const filePath = `${fileName}-${sldsVersionString}.css`;
  return Object.assign({}, file, {
    filePath,
    properties: { version: sldsVersionString },
  });
};
 
const createLWRFile = (sldsVersionSemver, lwrVersion) => (file) => {
  const fileName = file.filePath.split('-').slice(0, -1).join('-');
  const filePath = `${fileName}-${sldsVersionSemver}.css`;
  return Object.assign({}, file, {
    filePath,
    properties: { version: lwrVersion.toString() },
  });
};
 
function isLWRFileVersion(version) {
  return String(parseInt(version)) == version && !isNaN(version);
}
 
function isLWRFileEntry(file) {
  const version = file.properties.version;
  return isLWRFileVersion(version);
}
 
function isSldsPlusFile(file) {
  return (
    file.filePath &&
    (file.filePath.includes('slds-plus') ||
      file.filePath.includes('scoped-slds-plus'))
  );
}
 
// Sorted in descending order
const semverDistance = (b, a) => {
  const majorDif = a.major - b.major;
  const minorDif = a.minor - b.minor;
  const patchDif = a.patch - b.patch;
  return majorDif ? majorDif : minorDif ? minorDif : patchDif;
};
 
export const semverDistanceFromString = (a, b) =>
  semverDistance(autoVersion.parse(a), autoVersion.parse(b));
 
const getSemverFromFilename = (file) =>
  autoVersion.parse(getVersionStringFromFilename(file));
 
const semverRegex = /\d+\.\d+\.\d+/;
 
const getVersionStringFromFilename = (file) => {
  const versionMatch = file.filePath.match(semverRegex);
  return versionMatch ? versionMatch[0] : '0.0.0';
};
 
const hasValidSemver = (string) => semverRegex.test(string);
 
/**
 * @callback Files
 * @param {Object[]}
 */
 
/**
 * @callback GroupedFiles
 * @param {{[number]: {[number]: {[number]: Object[]}}}}
 */
 
/**
 * Group files by semver key
 * @param {'major'|'minor'|'patch'} key
 * @returns {function(Files): GroupedFiles}
 */
const filesToGroups = (key) => (files) =>
  _.groupBy(files, (f) => getSemverFromFilename(f)[key]);
 
/**
 * Filter a nested tree of file entries to the latest N versions at each level
 * @param {number[]} ns Array of number of versions to keep at each level
 * @param {GroupedFiles} groups Object of file entries nested by semver
 * @returns {GroupedFiles}
 */
const filterGroups = (ns, groups) =>
  Object.keys(groups)
    .sort(semverDistanceFromString)
    .slice(0, ns[0])
    .reduce((acc, key) => {
      const val =
        ns.length > 1 ? filterGroups(ns.slice(1), groups[key]) : groups[key];
      return Object.assign(acc, { [key]: val });
    }, {});
 
/**
 * Flatten the nested files object to an array of file entries
 * @param {GroupedFiles} groups Object of file entries nested by semver
 * @returns {Object[]}
 */
const groupsToFiles = (groups) =>
  groups.length === undefined
    ? Object.values(groups).map(groupsToFiles).flat()
    : groups;