@vernikr/size-report 2.9.0 → 2.9.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vernikr/size-report",
-  "version": "2.9.0",
+  "version": "2.9.1",
   "author": "vernikr",
   "repository": {
     "type": "git",
@@ -65,7 +65,7 @@
     "report"
   ],
   "devDependencies": {
-    "@vernikr/size-report": "2.8.9",
+    "@vernikr/size-report": "2.9.0",
     "c8": "10",
     "dependency-cruiser": "17",
     "eslint": "^9.18.0",

package/src/locales.js

@@ -41,8 +41,6 @@ export const LOCALES = {
         + 'Включите хотя бы одну в панели выше: без метрик нет ни одной колонки с числом.',
       noFiles: 'Ни один файл не выбран: в таблице остался только общий объём. '
         + 'Включите файл в панели выше, чтобы увидеть его колонки.',
-      linkForeign: 'Ссылка собрана в другом отчёте и не применена: показано то, что '
-        + 'выбрано в этом браузере. Адрес не тронут.',
       linkBroken: 'В адресе испорченный выбор — прочитать его не удалось. Показано то, '
         + 'что выбрано в этом браузере.',
       linkExtra: 'Часть ссылки пропущена: в этом отчёте нет {n} названных имён. '
@@ -95,8 +93,6 @@ export const LOCALES = {
         + 'Turn on at least one above: without metrics there is no column holding a number.',
       noFiles: 'No file is selected: the table shows the total only. '
         + 'Turn on a file above to see its columns.',
-      linkForeign: 'The link was built for another report, so it is not applied: you '
-        + 'see what this browser has. The address is left as it is.',
       linkBroken: 'The choice in the address is unreadable. You see what this browser '
         + 'has.',
       linkExtra: 'Part of the link is skipped: this report has none of the {n} names '

package/src/page/app.css

@@ -34,8 +34,7 @@ body {
 h1 { margin: 0 0 9px; font-size: 21px; font-weight: 650; letter-spacing: -.012em; }
 
 /* The panel of choices is a card: it separates the controls from the data and does not merge with the table that begins
- * below. The report's heading opens it — the page has no band above the numbers, and the title belongs where the file it
- * names is read from (see the markup in `src/page/build.js`). */
+ * below. The report's heading opens it: the page has no band above the numbers (the markup is in `src/page/build.js`). */
 .panel {
   margin: 0 0 var(--gap);
   padding: 12px 14px 13px;
@@ -164,9 +163,8 @@ h1 { margin: 0 0 9px; font-size: 21px; font-weight: 650; letter-spacing: -.012em
  * (`src/page/build.js`), and adding nodes to it for the sake of styling would mean changing the page's shape in two places
  * instead of one. There are three rows, named by subject: the message about a link, the **working row** and the empty
  * state — while the panel of choices spans them all in the left column, its heading inside it. Only the working row
- * stretches — the table gets all the remaining height and the panel no more than that; the panel's own height is not
- * "whatever came out" (it would push the table off the screen) but that same working row, inside which it scrolls: a file
- * list longer than the window is the usual case.
+ * stretches: the table gets all the remaining height and the panel no more than that; the panel's own height is not
+ * "whatever came out" (it would push the table off the screen) but that same working row, inside which it scrolls.
  *
  * The threshold of 900px is the same as the adaptations' below: one border between "wide" and "narrow", or the page would
  * be left with no rule at all between two thresholds. */
@@ -187,7 +185,7 @@ h1 { margin: 0 0 9px; font-size: 21px; font-weight: 650; letter-spacing: -.012em
   #shell { grid-area: 2 / 2 / 3 / 3; }
   #state { grid-area: 3 / 2 / 4 / 3; align-self: start; }
   /* The working row runs the full height, as the table does: the panel ends where it ends. The panel scrolls rather than the
-   * page, and its top padding is gone: the heading carries that room instead, and it travels away with the list, while the
+   * page, and its top padding is gone: the heading carries that room instead and travels away with the list, while the
    * sticky row of categories stands flush with the card's edge rather than under a band of passing rows. */
   .panel { grid-area: 1 / 1 / -1 / 2; min-height: 0; margin-bottom: 0; padding-top: 0; overflow: auto; }
   .panel h1 { padding-top: 12px; }

package/src/page/build.js

@@ -85,7 +85,6 @@ function uiText(page, loc) {
     foldClose: page.foldClose,
     foldOpen: page.foldOpen,
     all: page.all,
-    linkForeign: page.linkForeign,
     linkBroken: page.linkBroken,
     linkExtra: page.linkExtra,
     /* What a host that cannot unpack the block is told: the page's one message about its own file rather than about
@@ -197,8 +196,8 @@ export function pagePayload(data) {
     schema: 2,
     tool: data.tool,
     /* The report's own words are the ones the page reads: `heading` is the artifact's `<h1>`, built before the block,
-     * `journal` is null today, and `fixCommand` was quoted by the note under the table, which the page no longer has —
-     * the page builds no heading, prints no journal and suggests no command. */
+     * `journal` is null today, and `fixCommand` belongs to a refusal and to the contract rather than to the page, which
+     * builds no heading, prints no journal and suggests no command. */
     report: {
       locale: data.report.locale,
       title: data.report.title,
@@ -238,11 +237,10 @@ export function pagePacked(text) {
 /* The report's page is one file: the data lies in it, the script is pasted in, there are no external references. Hence
  * it opens with a double click and works without a network.
  *
- * The page's chrome is the panel and the table, and nothing stands above the numbers: the report's heading opens the
- * panel (the one place that holds the reader's own controls) rather than a band of its own, and neither the tool, nor the
- * version, nor the artifact's path is printed anywhere — the file is opened from a directory whose name already says
- * where it lies. The panel's card is the markup's and the fields inside it are the script's: `#panel` is emptied and
- * rebuilt on every opening, which is why the heading is the card's other child rather than one more field. */
+ * The page's chrome is the panel and the table, and nothing stands above the numbers: the heading opens the panel — the
+ * one place holding the reader's own controls — and neither the tool, nor its version, nor the artifact's path is printed
+ * anywhere, the file lying in a directory whose name already says where. The panel's card is the markup's and its fields
+ * are the script's: `#panel` is emptied and rebuilt on every opening, hence the heading is the card's other child. */
 export function pageHtml(data, cfg) {
   const loc = LOCALES[cfg.locale];
   return '<!doctype html>\n<html lang="' + esc(loc.html) + '">\n<head>\n<meta charset="utf-8">\n'

package/src/page/panel.js

@@ -188,10 +188,9 @@ export function appPanel() {
   const metrics = appEl('fieldset');
   metrics.appendChild(appEl('legend', null, appUi.metrics));
   const mrow = appEl('div', 'row');
-  /* What a metric is and how its number was obtained stand in one place: the tooltip of the box that switches it. The
-   * token dictionary and the way of compression come from the settings of the run, and the page has nothing to switch
-   * them with, so the reader has to know with what he is counting — while the lines that said it in words under the
-   * switches took the room beside the numbers. */
+  /* What a metric is and how its number was obtained stand in the tooltip of the box that switches it: the dictionary
+   * and the minifier come from the run's settings, so the reader has to see with what he is counting, and the box is
+   * where he looks. */
   appData.metrics.forEach((m) => {
     const box = appBox(m.label, m.note + ' — ' + appUi.methodLabel + ' ' + m.method, appView.metrics[m.key], (e) => {
       appView.metrics[m.key] = e.target.checked;

package/src/page/payload.js

@@ -146,8 +146,9 @@ function appRowOf(p, r, values) {
   };
 }
 
-/* The whole block, unrolled into the dense contract the page reads: `schema: 2` is refused by `appRecordOk`
- * rather than unrolled — a record written for a block of another form describes another choice. */
+/* The whole block, unrolled into the dense contract the page reads: the block is a shape of that contract rather than a
+ * subset of it, so `schema` and `tool` come over with the rest although the page reads neither — the form mark and the
+ * author belong to the answer an agent is given, and one shape is cheaper to keep than two. */
 export function appDecode(p) {
   const keys = p.metrics.map((m) => appText(p, m[0]));
   const hist = appUnroll(p, keys);

package/src/page/state.js

@@ -11,12 +11,11 @@ import { appDecode } from './payload.js';
  * network: the styling arrives in the same file, and the cell markup follows the rules of the shared part of the styling
  * (`clip`, a commit's caption).
  *
- * The panel remembers the reader's choice between visits ("the choice's memory" below): the record is addressed by the
- * report rather than by a build of it (`appPassport`), it keeps the fact of a whole category where the reader decided by
- * groups and the names of the files where he decided one by one, and only what is switched off is written down — so
- * someone else's record is not applied while a vanished name simply means nothing. The record stays in the browser's
- * memory and nowhere else: a report opened from disk keeps a clean address, and a link made in an earlier release is
- * still read (`appLinkUse`).
+ * The panel remembers the reader's choice between visits ("the choice's memory" below): one record for the browser, under
+ * a name of this page's own, keeping the fact of a whole category and the names of the files switched off one by one —
+ * only what is off is written down, and a name the report does not hold matches nothing. The choice is the reader's
+ * rather than a report's, since all `file://` pages share one storage, and it stays in the browser: a report opened from
+ * disk keeps a clean address, and a link made in an earlier release is still read (`appLinkUse`).
  *
  * The page draws no conclusion about how a number was obtained: the method of each metric arrives in the data, and the
  * page prints it. There is no second rule of counting here, and no vocabulary of precision either. */
@@ -31,8 +30,6 @@ export let appData = null;
 export let appView = null;
 export let appMetric = null;
 export let appMeasured = null;
-let appKey = null;
-let appFoldKey = null;
 
 /* One place that turns the unpacked block into what the chapters speak: the sparse form is unrolled by the payload
  * chapter into the dense contract every number comes from — snapshots per commit, the texts themselves, "now" as
@@ -45,10 +42,8 @@ let appFoldKey = null;
  * page's tree is the project's tree while the numbers belong to columns only); the name follows the same rule as the
  * choice's record (`appFileAt`), so the tree and the reader's memory cannot drift apart.
  *
- * The key the reader's memory lives under is counted here as well, because it is the report's passport: it depends
- * on the data, and until the block is unpacked there is nothing to count it from. The addresses an earlier naming of
- * the passport left behind go away at the same moment (`appSweep`): the report is in a position to say what is dead,
- * and nothing of the reader's memory has been read yet. */
+ * What other namings left in this storage go at the same moment (`appSweep`), before anything of the reader's memory is
+ * read. */
 export function appBoot(text) {
   appData = appDecode(JSON.parse(text));
   /* The tree is folded as it opens: a project's tree is longer than the window, and the reader's first look is at a
@@ -59,8 +54,6 @@ export function appBoot(text) {
   appMeasured = {};
   appData.metrics.forEach((m) => { appView.metrics[m.key] = true; appMetric[m.key] = m; });
   appData.files.forEach((_f, i) => { appView.files.push(true); appMeasured[appFileAt(i)] = i; });
-  appKey = APP_FORM + appPassport();
-  appFoldKey = appKey + ':tree';
   appSweep();
 }
 
@@ -75,13 +68,11 @@ let appTransient = false;
 
 /* -------- the reader's memory of his choice -------- */
 
-/* The form of the memory's address: the tool's namespace, a mark of the form, then the report's identity (`appPassport`
- * counts it). The mark stands in the address because the identity was named differently once — in the first naming the
- * columns stood inside it, so every build of the report had an address of its own and the reader's choice was left
- * behind at the previous one — and because the mark is what lets this release tell the addresses it writes from the
- * addresses of that naming (`appSweep`), without pretending to know whose record lies under the older one. */
+/* The two keys of this page's memory: the choice and the unfolded tree. The namespace is this page's own and it is one
+ * for every report — all `file://` pages share a storage, so the memory belongs to the reader rather than to a report. */
 const APP_STORE = 'size-report:';
-const APP_FORM = APP_STORE + '2:';
+const APP_KEY = APP_STORE + 'choice';
+const APP_FOLD_KEY = APP_STORE + 'tree';
 
 /* The name of a file for the record is its path at HEAD, or the last of the settings when the file is already gone from
  * there: that is the name it is recognised by in the report. */
@@ -90,74 +81,22 @@ export function appFileAt(i) {
   return f.path === null ? f.paths[0] : f.path;
 }
 
-/* The files of one category, in the order of the data: a category is a group of files as the engine named it
- * (`category`), and the record, the boxes of the panel and their fields all ask for that group here rather than walking
- * the files a second time. */
+/* The files of one category, in the order of the data: a category is a group as the engine named it (`category`), and
+ * the panel's boxes, their fields and the record all ask for that group here. */
 export function appCatOf(key) {
   const idx = [];
   appData.files.forEach((f, i) => { if (f.category === key) idx.push(i); });
   return idx;
 }
 
-/* The passport's fingerprint: an identifying mark of a record rather than protection against forgery, so 32 bits are
- * enough (FNV-1a). */
-function appHash(text) {
-  let h = 2166136261;
-  for (let i = 0; i < text.length; i++) {
-    h ^= text.charCodeAt(i);
-    h = Math.imul(h, 16777619);
-  }
-  return (h >>> 0).toString(16);
-}
-
-/* The report's passport: the tool's name, the data schema, the artifact's path, the title and the oldest row of the
- * history. It is what tells one report from another — the record's key is chosen by it, so a choice made in someone
- * else's report is not picked up — and it is what makes the memory the report's rather than a build of it: every later
- * build of the same report counts the same value and finds the same choice.
- *
- * The first four are what the report says about itself, and they are the same in a report of another project (both the
- * artifact's path and the title are defaults there, and all `file://` pages share one memory), which is what the fifth
- * is for: the oldest row is a commit of this history, the same in every clone and every build, and the one commit the
- * history never moves — rows are built from the oldest commit up, so a commit appends rows and leaves that one where it
- * stands.
- *
- * The package version and the top of the history are absent on purpose: updating the tool does not change what a column
- * means, while a grown history is the very history the reader comes back to.
- *
- * The columns were named here once, and they are what does not belong here at all: their labels and their order move
- * with the numbers — a project without settings pinned derives the columns on every run, ordered by size within an
- * extension (`src/project.js`), so every commit that grew or shrank a file gave the report another passport and left the
- * reader's choice at the old address. What a record holds are names, and a name the report no longer has means nothing
- * (`appApply`), so the columns have nothing to guard in the passport.
- *
- * Counted once per document: it is a constant of the report, which depends on nothing the reader can change, and every
- * click asks for it (the key of the memory and the passport of the record). A second count would be a second answer
- * waiting to happen, and the block it reads does not change while the page is open. */
-let appPassportValue = null;
-function appPassport() {
-  if (appPassportValue === null) {
-    const oldest = appData.rows.length === 0 ? '' : appData.rows[0].sha;
-    appPassportValue = appHash([appData.tool.name, appData.schema, appData.report.artifact,
-      appData.report.title, oldest].join('\n'));
-  }
-  return appPassportValue;
-}
-
-/* The addresses an earlier naming left in the browser: every one of them belonged to a single build of a report, and no
- * report ever looks under them again — the memory is read under the address of the report's identity alone. A browser
- * that has lived through a long history holds one such record per commit, so they go away, once, when a report of this
- * release is opened.
- *
- * What is swept is the mark of the form rather than a claim about whose record it is: the older address was counted from
- * the data, so the record under it cannot be attributed to a report — hence a memory left by an older release in this
- * browser goes too, and it is one of a report that was not rebuilt since its reader last clicked (that release moved the
- * address at the next build itself, leaving the memory behind). What this release writes is left alone: under it lies
- * this report's memory and another report's, and the two are told apart by the identity rather than by the form. */
+/* What other namings left in this storage: the memory is read under the two keys above and under nothing else, so any
+ * other name in the namespace is dead weight — an address counted per build, a record of an older form. They go once,
+ * when a report is opened. */
 function appSweep() {
   try {
     for (let i = window.localStorage.length - 1; i >= 0; i--) {
       const key = window.localStorage.key(i);
-      if (key !== null && key.indexOf(APP_STORE) === 0 && key.indexOf(APP_FORM) !== 0) {
+      if (key !== null && key.indexOf(APP_STORE) === 0 && key !== APP_KEY && key !== APP_FOLD_KEY) {
         window.localStorage.removeItem(key);
       }
     }
@@ -166,18 +105,15 @@ function appSweep() {
   }
 }
 
-/* One record of the choice: the facts of the groups where the reader decided by groups, the names of the files where he
- * decided one by one, and only what is switched off.
+/* One record of the choice: the facts of the groups, the names of the files switched off one by one, and nothing else.
  *
- * A category whose box is wholly off — or wholly on — is written down as that fact rather than as the state of every
- * file in it: `cats` names the group and says where it stands, so a file that joins the category later is switched with
- * it, which is exactly what the reader asked for when he switched the group, and the record does not grow with the
- * project. A category in the third state cannot speak for his choice — the choice was made file by file — and the files
- * he switched off go into the record by name (`files`), as they did before this chapter knew categories; such a category
- * is **absent** from `cats`, which is how the record distinguishes "a group fact" from "no group fact to state".
+ * A category wholly off or wholly on is written down as that fact — the group is named, so a file joining it later is
+ * switched with it and the record does not grow with the project — while a category in the third state cannot speak for
+ * the reader, whose choice was made file by file: those files go into `files` by name, and the category stays out of
+ * `cats`, which is how a group fact differs from no group fact to state.
  *
- * "Switched on" and "no record" are the same state, hence `null` rather than an empty record — turning every checkbox
- * back on removes the record instead of leaving a trace indistinguishable from a choice. */
+ * "Switched on" and "no record" are the same state, hence `null` rather than an empty record: turning every box back on
+ * removes it instead of leaving a trace indistinguishable from a choice. */
 function appRecord() {
   const metrics = {};
   const cats = {};
@@ -191,12 +127,12 @@ function appRecord() {
   });
   const empty = Object.keys(metrics).length === 0 && Object.keys(files).length === 0
     && Object.keys(cats).every((key) => cats[key] === true);
-  return empty ? null : { v: 1, passport: appPassport(), metrics: metrics, cats: cats, files: files };
+  return empty ? null : { v: 1, metrics: metrics, cats: cats, files: files };
 }
 
-// Whether a record is ours and of the right format — one rule for the memory and the address alike.
+// Whether a record is of this format — one rule for the memory and the address alike.
 function appRecordOk(rec) {
-  return rec !== null && typeof rec === 'object' && rec.v === 1 && rec.passport === appPassport();
+  return rec !== null && typeof rec === 'object' && rec.v === 1;
 }
 
 /* A record into the browser's memory or out of it, and what is read back from it: the two halves of the memory, written
@@ -217,7 +153,7 @@ function appKeep(key, rec) {
 }
 
 export function appWrite() {
-  if (!appTransient) appKeep(appKey, appRecord());
+  if (!appTransient) appKeep(APP_KEY, appRecord());
 }
 
 /* What the browser saved under a key: its absence, a foreign record, a broken one and a record of another report amount
@@ -241,10 +177,10 @@ function appAll() {
   appData.files.forEach((_f, i) => { appView.files[i] = true; });
 }
 
-/* What the address says. It answers either with a record of ours or with a refusal (`linkForeign` — a link of another
- * report, `linkBroken` — nothing to read): someone else's or a broken choice is not applied, but it does not stay silent
- * either — otherwise the reader would not understand why he sees something other than what was sent to him. An address
- * without the link's name is no link at all: silence, so as not to argue with the page's ordinary anchors. */
+/* What the address says. It answers either with a record of this format or with a refusal (`linkBroken` — nothing to
+ * read): a choice that cannot be read is not applied, but it does not stay silent either — otherwise the reader would not
+ * understand why he sees something other than what was sent to him. An address without the link's name is no link at
+ * all: silence, so as not to argue with the page's ordinary anchors. */
 function appLinkRead() {
   const hash = window.location.hash || '';
   if (hash.indexOf(APP_LINK) !== 0) return { rec: null, refused: null };
@@ -259,10 +195,7 @@ function appLinkRead() {
       return { rec: null, refused: 'linkBroken' };
     }
   }
-  if (!appRecordOk(rec)) {
-    return { rec: null, refused: rec === null || typeof rec !== 'object' || rec.v !== 1
-      ? 'linkBroken' : 'linkForeign' };
-  }
+  if (!appRecordOk(rec)) return { rec: null, refused: 'linkBroken' };
   return { rec: rec, refused: null, extra: appUnknown(rec) };
 }
 
@@ -303,9 +236,9 @@ export function appLinkUse() {
   return 'none';
 }
 
-// Reading: the reader's own choice, as he left it — another report's record lies under another key.
+// Reading: the reader's own choice, as he left it.
 export function appRead() {
-  return appLoad(appKey);
+  return appLoad(APP_KEY);
 }
 
 /* Applying goes by name: a file is recognised by its path, a metric by its key, a category by the key the engine gave
@@ -313,9 +246,8 @@ export function appRead() {
  * the settings), while files, categories and metrics that appeared stay switched on — the way someone opening the page
  * for the first time sees them.
  *
- * A category's fact is applied to the files of that category as they are now, and the names are applied after it: the
- * file-by-file decision is the finer one and stands last, and a record of an earlier release — which knew no categories
- * and wrote only names — is applied by its names exactly as it was. */
+ * The groups go first, the names after them: the file-by-file decision is the finer one, and a record that knows no
+ * groups is applied by its names. */
 export function appApply(rec) {
   const metrics = rec.metrics || {};
   const cats = rec.cats || {};
@@ -335,10 +267,9 @@ export function appApply(rec) {
  * what the onlooker looks at rather than about which numbers are read, which is why it never goes into a link and never
  * leaves the browser. The tree opens folded, so **the unfolded folders are what is kept** (`true`) — the default is the
  * absence of the name, the same way "switched on" is the absence of a choice. A folder's name is its path ("src/page"),
- * so a vanished name simply means nothing. `appFoldKey` is set with the model (`appBoot`), for the reason the key itself
- * is. */
+ * so a vanished name simply means nothing. */
 export function appFoldRead() {
-  const rec = appLoad(appFoldKey);
+  const rec = appLoad(APP_FOLD_KEY);
   if (rec === null) return;
   const open = rec.open || {};
   Object.keys(open).forEach((p) => { if (open[p] === true) appView.open[p] = true; });
@@ -350,7 +281,5 @@ export function appFoldSet(path, open) {
   if (open) appView.open[path] = true;
   else delete appView.open[path];
   const names = Object.keys(appView.open);
-  appKeep(appFoldKey, names.length === 0
-    ? null
-    : { v: 1, passport: appPassport(), open: appView.open });
+  appKeep(APP_FOLD_KEY, names.length === 0 ? null : { v: 1, open: appView.open });
 }