ravensight-playtest 0.5.2 → 0.7.0

package/src/commands/assets.js

@@ -0,0 +1,62 @@
+import path from 'node:path';
+
+import { loadConfig } from '../config.js';
+import EXIT from '../run/exit.js';
+import { scanUsage } from '../assets/integration.js';
+import { buildInventory, countsLine, DEFAULT_ASSETS_DIR, describeFile, formatBytes, warningKinds } from '../assets/inventory.js';
+
+/**
+ * `ravensight-playtest assets`: what a project's art and audio folder holds, as
+ * measured on this machine. It needs no login, sends nothing anywhere and costs
+ * nothing, so it can be run as often as a studio likes before a feature job.
+ *
+ * @param {Object} flags
+ * @param {Object} [injected] test seam
+ * @returns {Promise<number>} an exit code
+ */
+export async function assetsCommand(flags = {}, injected = {}) {
+  const log = injected.log || (line => console.log(line));
+  const repoRoot = path.resolve(flags.repoRoot || process.cwd());
+  const config = await loadConfig({ repoRoot }).catch(() => null);
+  const projectDir = path.resolve(repoRoot, flags.godotProject || config?.godot_project || '.');
+  const folder = flags.assetsDir || config?.assets_dir || DEFAULT_ASSETS_DIR;
+  const grid = Number.isInteger(flags.grid) && flags.grid > 0 ? flags.grid : null;
+  if (flags.grid !== undefined && !grid) {
+    log('--grid has to be a whole number of art pixels across, such as 32.');
+    return EXIT.ENVIRONMENT;
+  }
+  let inventory;
+  try {
+    inventory = await buildInventory({ projectDir, folder, grid });
+  } catch (error) {
+    log(`The project could not be read: ${String(error && error.message)}`);
+    return EXIT.ENVIRONMENT;
+  }
+  if (!inventory.ok) {
+    log(inventory.reason);
+    return EXIT.ENVIRONMENT;
+  }
+  if (!inventory.exists) {
+    log(`There is no folder ${folder} in this project. Put your art and audio there, or name the folder with --assets-dir. A feature uses placeholders for anything it cannot find.`);
+    return flags.assetsDir ? EXIT.ENVIRONMENT : EXIT.OK;
+  }
+  const usage = await scanUsage({ projectDir, inventory });
+  if (flags.json) {
+    (injected.json || (value => console.log(JSON.stringify(value, null, 2))))({ ...inventory, usage: { used: usage.used, unused: usage.unused, built_in_code: usage.built_in_code } });
+    return EXIT.OK;
+  }
+  const used = new Set(usage.used);
+  log(`${inventory.folder}: ${countsLine(inventory.counts)}. ${usage.used.length} used by the project, ${usage.unused.length} unused.`);
+  for (const file of inventory.files) {
+    log(`${file.path}  ${[file.format, formatBytes(file.bytes), describeFile(file)].filter(Boolean).join(', ')}${used.has(file.path) ? '' : '  (unused)'}`);
+    for (const item of file.warnings) log(`  warning: ${item.text}`);
+  }
+  for (const item of inventory.warnings) log(`warning: ${item.text}`);
+  if (inventory.truncated) log(`Only the first ${inventory.counts.files} files are listed.`);
+  const kinds = warningKinds(inventory);
+  log(kinds.length === 0 ? 'No warnings.' : `${kinds.reduce((sum, item) => sum + item.count, 0)} warning(s).`);
+  log('This read your files on this machine and sent nothing.');
+  return EXIT.OK;
+}
+
+export default assetsCommand;

package/src/commands/check.js

@@ -425,7 +425,7 @@ export async function runChecks(flags = {}, deps = {}) {
         'login',
         games.length > 0 ? 'pass' : 'warn',
         games.length > 0
-          ? `${who}, valid, scoped to ${plural(games.length, 'game')}: ${games.map(gameLabel).join(', ')}`
+          ? `${who}, valid, scoped to ${plural(games.length, 'game')}: ${games.slice(0, MAX_GAMES_LISTED).map(gameLabel).join(', ')}${games.length > MAX_GAMES_LISTED ? `, and ${games.length - MAX_GAMES_LISTED} more (check --json lists them all)` : ''}`
           : `${who}, valid, but scoped to no games`,
         games.length > 0 ? null : 'run ravensight-playtest login again and approve the game for this token'
       ));
@@ -742,6 +742,9 @@ export async function firstScreenRow(measure, url, { authed, gameId, priced }) {
  * @param {Object} [deps]
  * @returns {Promise<number>} exit code, 3 when anything failed
  */
+/** Games named on check's login row; the rest are counted, and --json has them all. */
+export const MAX_GAMES_LISTED = 5;
+
 export async function check(flags = {}, deps = {}) {
   const progress = flags.json ? {} : { onProgress: line => ui.info(line) };
   const { rows, ok, cli, login, project, brief, build, automation } = await runChecks(flags, { ...progress, ...deps });