resopt-cli 0.6.0

Find, review and safely apply resource optimizations for Apple and Android projects.
Documentation 
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

// Pure helpers shared by the report UI. No DOM access here: tests/report-ui.cjs
// loads this file on its own.
const WARNING_KINDS = ['alpha_error_exceeds_policy', 'transparency_presence_changed', 'quality_below_policy'];
const BROWSER_FORMATS = ['png', 'jpeg', 'webp', 'gif'];

function formatNumber(value, locale) { return new Intl.NumberFormat(locale).format(value); }

// Binary units for reading; exact bytes belong in a title/secondary label.
function formatSize(value, locale = 'en-US') {
  if (typeof value !== 'number' || !Number.isFinite(value) || value < 0) return '—';
  if (value < 1024) return `${formatNumber(value, locale)} B`;
  const units = ['KiB', 'MiB', 'GiB', 'TiB', 'PiB'];
  let amount = value / 1024, unit = 0;
  while (amount >= 1024 && unit < units.length - 1) { amount /= 1024; unit++; }
  return `${new Intl.NumberFormat(locale, { minimumFractionDigits: 1, maximumFractionDigits: 2 }).format(amount)} ${units[unit]}`;
}

function formatPercent(ratio) { return Number.isFinite(ratio) ? `${(ratio * 100).toFixed(1)}%` : '—'; }

// Only generated artifact paths may become URLs; anything else is dropped.
function assetUrl(path) {
  if (typeof path !== 'string') return null;
  const parts = path.replaceAll('\\', '/').split('/');
  if (!['previews', 'originals', 'candidates'].includes(parts[0]) || parts.length < 2
    || parts.some(p => !p || p === '.' || p === '..' || [...p].some(ch => ch.charCodeAt(0) < 32 || ch === ':'))) return null;
  return parts.map(encodeURIComponent).join('/');
}

function basename(path) { return String(path || '').split(/[\\/]/).pop(); }

// A warning is a structurally sound lossy candidate that misses a visual policy
// threshold. Every other rejection is a hard failure and is never approvable.
function warningKind(candidate) {
  return candidate && candidate.lossy && !candidate.valid && candidate.artifact
    && WARNING_KINDS.includes(candidate.rejection) ? candidate.rejection : null;
}

// Every threshold the candidate misses; approval must name all of them.
function warningKinds(candidate) {
  if (!warningKind(candidate)) return [];
  const all = Array.isArray(candidate.warnings) ? candidate.warnings.filter(w => WARNING_KINDS.includes(w)) : [];
  return all.length ? all : [candidate.rejection];
}

function recommended(resource) {
  const index = resource && resource.smallest_candidate;
  const candidate = Number.isInteger(index) && index >= 0 ? resource.candidates && resource.candidates[index] : null;
  return candidate && candidate.valid && candidate.artifact ? candidate : null;
}

function recommendedSavings(resource) {
  const candidate = recommended(resource);
  return candidate ? Math.max(0, candidate.savings_bytes || 0) : 0;
}

function hasWarningCandidate(resource) {
  return !!(resource && resource.candidates && resource.candidates.some(c => warningKind(c)));
}

// Empty string when the candidate may be applied (possibly after a warning
// confirmation); otherwise the identifier of the blocking reason.
function blockedReason(resource, candidate) {
  if (!candidate || !candidate.artifact) return 'no_smaller_candidate';
  if (!candidate.valid && !warningKind(candidate)) return 'failed_verification';
  if (resource.resource && resource.resource.conversion_exclusion) return resource.resource.conversion_exclusion;
  const crossing = candidate.format !== resource.resource.format || resource.resource.extension_mismatch;
  if (crossing && resource.resource.format_lock) return resource.resource.format_lock;
  return '';
}

function displayableInBrowser(format) { return BROWSER_FORMATS.includes(format); }