Merge branch 'develop' into main

Author: chipbell4

README.md

@@ -53,7 +53,7 @@ will make the accessibility checker fail with status code 123 if the test suite
 ### Linting Pass
 A typical linting pass would look like this:
 ```
-npx srlint -p path/to/the/game
+npx srlint -p path/to/the/game/src
 ```
 
 This will start at the root of the passed directory, and crawl it looking for non-asset JavaScript and TypeScript files.

bin/srac

@@ -2,9 +2,9 @@
 
 const packageJson = require('../package.json');
 const { program } = require('commander');
+const { isDirectory } = require('../src/lib/path-validation.js');
 
-const { isDirectory } = require('../lib/path-validation.js');
-const runner = require('../lib/runner.js');
+const accessibilityChecker = require('../src').accessibilityChecker;
 
 program.version(packageJson.version);
 program
@@ -18,20 +18,8 @@ if (!isDirectory(program.path)) {
   process.exit(program.exitCode);
 }
 
-console.log('About to run tests');
-runner
-  .runTests(program.path)
-  .then((testResults) => {
-    if (testResults.lastResult.failed > 0) {
-      const failedCount = testResults.lastResult.failed;
-      console.log(`${failedCount} test${failedCount > 1 ? 's' : ''} failed!`);
-      process.exit(program.exitCode);
-    } else {
-      console.log('Done!');
-      process.exit(0);
-    }
-  })
-  .catch((e) => {
-    console.error(e);
-    process.exit(program.exitCode);
-  });
+accessibilityChecker.run(program.path, true).then(() => {
+  process.exit();
+}).catch(() => {
+  process.exit(program.exitCode);
+});

bin/sras

@@ -3,30 +3,11 @@
 const packageJson = require('../package.json');
 const { program } = require('commander');
 
-const path = require('path');
 const fs = require('fs');
-const promisify = require('util').promisify;
-const imageSize = require('image-size');
-const musicMetadata = require('music-metadata');
 
-const { isDirectory } = require('../lib/path-validation.js');
-const { formatHRTFileSize, formatMsToHRT } = require('../lib/format.js');
-const { parseSRASConfig } = require('../lib/srasConfig.js');
-const { isPowerOfTwo } = require('../lib/mathHelpers.js');
+const assetScanner = require('../src/').assetScanner;
+const { isDirectory } = require('../src/lib/path-validation.js');
 
-let scannedFiles = 0;
-let skippedFiles = 0;
-let ignoredFiles = 0;
-
-const scannedTypes = {};
-const unpermittedTypes = {};
-const scanReports = [];
-
-const fsReadDir = promisify(fs.readdir);
-const fsStat = promisify(fs.stat);
-const sizeOf = promisify(imageSize);
-
-const buildReportMsg = (...segments) => segments.join(' ');
 const fail = (err) => {
   console.log('Scan failed:');
   console.error(err);
@@ -46,205 +27,8 @@ if (!isDirectory(program.path)) {
 }
 
 const config = JSON.parse(fs.readFileSync(program.config));
-const scanConfig = parseSRASConfig(config);
-
-const scanJs = async (filePath, scanRules) => {
-  try {
-    const stat = await fsStat(filePath);
-    const maxSize = scanRules.maxSize || Infinity;
-    if (maxSize > 0 && stat.size > maxSize) {
-      const fileName = path.basename(filePath);
-      scanReports.push(buildReportMsg(
-        'JS file size is larger than the recommended file size',
-        `[recommended = ${formatHRTFileSize(maxSize)}],`,
-        `[${fileName} = ${formatHRTFileSize(stat.size)}]`,
-      ));
-    }
-  } catch (e) {
-    fail(e);
-  }
-};
-
-const scanImage = async (filePath, scanRules) => {
-  try {
-    const stat = await fsStat(filePath);
-    const dimensions = await sizeOf(filePath);
-
-    const maxWidth = scanRules.maxWidth || Infinity;
-    const maxHeight = scanRules.maxHeight || Infinity;
-    const maxSize = scanRules.maxSize || Infinity;
-
-    const fileName = filePath.split('\\').pop();
-
-    if (dimensions.width > maxWidth || dimensions.height > maxHeight) {
-      scanReports.push(buildReportMsg(
-        'Image is larger than the recommended max dimensions',
-        `[recommended = ${maxHeight}x${maxHeight}],`,
-        `[${fileName} = ${dimensions.width}x${dimensions.height}]`,
-      ));
-    }
-
-    if (!!scanRules.powerOfTwo && (!isPowerOfTwo(dimensions.width) || !isPowerOfTwo(dimensions.height))) {
-      scanReports.push(buildReportMsg(
-        'Image dimensions are recommended to be powers of two',
-        `[${fileName} = ${dimensions.width}x${dimensions.height}]`,
-      ));
-    }
-
-    if (maxSize > 0 && stat.size > maxSize) {
-      scanReports.push(buildReportMsg(
-        'Image file size is larger than the recommended file size',
-        `[recommended = ${formatHRTFileSize(maxSize)}],`,
-        `[${fileName} = ${formatHRTFileSize(stat.size)}]`,
-      ));
-    }
-  } catch (err) {
-    fail(err);
-  }
-};
-
-const scanAudio = async (filePath, scanRules) => {
-  try {
-    const stat = await fsStat(filePath);
-    const metadata = await musicMetadata.parseFile(filePath);
-
-    const maxSize = scanRules.maxSize || 0;
-    const maxChannels = scanRules.maxChannels || 0;
-    const sampleRate = scanRules.sampleRate || 0;
-    const duration = scanRules.duration || 0;
-
-    const fileName = filePath.split('\\').pop();
-
-    if (maxSize > 0 && stat.size > maxSize) {
-      scanReports.push(buildReportMsg(
-        'Audio file size is larger than the recommended file size',
-        `[recommended = ${maxSize}],`,
-        `[${fileName} = ${formatHRTFileSize(stat.size)}]`,
-      ));
-    }
-
-    if (maxChannels > 0 && metadata.format.numberOfChannels > maxChannels) {
-      scanReports.push(buildReportMsg(
-        'Audio file contains more than the recommended number of channels',
-        `[recommended = ${maxChannels}],`,
-        `[${fileName} = ${metadata.format.numberOfChannels}]`,
-      ));
-    }
-
-    if (sampleRate > 0 && metadata.format.sampleRate !== sampleRate) {
-      scanReports.push(buildReportMsg(
-        'Audio sample rate does not match the recommended sample rate',
-        `[recommended = ${sampleRate}],`,
-        `[${fileName} = ${metadata.format.sampleRate}]`,
-      ));
-    }
-
-    const convertedDuration = metadata.format.duration * 1000; // S to MS
-    if (duration > 0 && convertedDuration > duration) {
-      scanReports.push(buildReportMsg(
-        'Audio duration is larger than recommended duration',
-        `[recommended = ${duration}],`,
-        `[${fileName} = ${convertedDuration}]`,
-      ));
-    }
-  } catch (err) {
-    fail(err);
-  }
-};
-
-const scanDirectory = async (filePath) => {
-  if (!isDirectory(filePath)) {
-    const ext = path.extname(filePath).slice(1);
-
-    if (scanConfig.ignored.test(ext)) {
-      // Track total ignored files.
-      ignoredFiles++;
-      return;
-    } else if (scanConfig.unpermitted.test(ext)) {
-      // Track how times we have scanned an this unpermitted file type.
-      unpermittedTypes[ext] = (unpermittedTypes[ext] || 0) + 1;
-      skippedFiles++; // skipped or ignored ??????
-      return;
-    }
-
-    // Check if there is a rule category for this file extension.
-    const hasJsRule = scanConfig.codeRules && scanConfig.codeRules.js && ext === 'js';
-    const hasImgRule = scanConfig.imgRules[ext] !== undefined;
-    const hasAudRule = !hasImgRule && scanConfig.audRules[ext] !== undefined;
-
-    if (hasJsRule) {
-      await scanJs(filePath, scanConfig.codeRules.js);
-    } else if (hasImgRule) {
-      await scanImage(filePath, scanConfig.imgRules[ext]);
-    } else if (hasAudRule) {
-      await scanAudio(filePath, scanConfig.audRules[ext]);
-    } else {
-      // Cannot find rules for this file type so it will be skipped.
-      // Track total skipped files.
-      skippedFiles++;
-      return;
-    }
-
-    // Track how many times we have scanned this file type.
-    scannedTypes[ext] = (scannedTypes[ext] || 0) + 1;
-
-    // Track total scanned files.
-    scannedFiles++;
-  } else {
-    try {
-      const files = await fsReadDir(filePath);
-      for (let i = 0; i < files.length; i++) {
-        await scanDirectory(path.join(filePath, files[i]));
-      }
-    } catch (err) {
-      fail(err);
-    }
-  }
-};
-
-const assetScan = async () => {
-  const startTime = Date.now();
-
-  console.log(`Scanning assets at [path = ${program.path}]`);
-
-  await scanDirectory(program.path);
-
-  const counts = [];
-  const unpermittedReports = [];
-  const missingRequiredReports = [];
-
-  Object.keys(scannedTypes).forEach((i) => counts.push(`${scannedTypes[i]} ${i}(s)`));
-  Object.keys(unpermittedTypes).forEach((i) => unpermittedReports.push(
-    `Detected ${unpermittedTypes[i]} unpermitted file type(s) [type = ${i}]`,
-  ));
-
-  scanConfig.requiredTypes.forEach((type) => {
-    if (scannedTypes[type] === undefined) {
-      missingRequiredReports.push(`Could not find file types matching [type = ${type}]`);
-    }
-  });
-
-  // RENDER SCAN REPORTS
-
-  if (scanReports.length > 0) {
-    console.log(scanReports.join('\n'));
-  }
-  if (unpermittedReports.length > 0) {
-    console.log(unpermittedReports.join('\n'));
-  }
-  if (missingRequiredReports.length > 0) {
-    console.log(missingRequiredReports.join('\n'));
-  }
-  if (counts.length > 0) {
-    console.log(`Scanned ${counts.join(', ')}`);
-  }
-  console.log(
-    `Scan complete [time = ${formatMsToHRT(Date.now() - startTime)}]:`,
-    `${scannedFiles} file(s) scanned, ${skippedFiles} file(s) skipped, ${ignoredFiles} file(s) ignored`,
-  );
-
+assetScanner.run(program.path, config, true).then(() => {
   process.exit();
-};
-
-// Begin scanning
-assetScan();
+}).catch((err) => {
+  fail(err);
+});

bin/srlint

@@ -1,13 +1,11 @@
 #!/usr/bin/env node
 
 const path = require('path');
-const eslint = require('eslint');
 const packageJson = require('../package.json');
 const { program } = require('commander');
-const expandPath = require('../lib/expand-path.js');
-const { isDirectory } = require('../lib/path-validation.js');
-const eslintignore = require('../lib/eslintignore.js');
-const pad = require('../lib/pad.js');
+const expandPath = require('../src/lib/expand-path.js');
+const { isDirectory } = require('../src/lib/path-validation.js');
+const fileLinter = require('../src').fileLinter;
 
 program.version(packageJson.version);
 program
@@ -23,32 +21,14 @@ if (!isDirectory(gameFullPath)) {
   process.exit(0);
 }
 
-const cliEngine = new eslint.CLIEngine({
+const lintConfig = {
   configFile: path.resolve(__dirname, '../config/eslint.json'),
   extensions: [ '.js', '.ts' ],
   useEslintrc: false,
-});
-
-// resolve the list of files and lint them
-const eslintIgnorePath = eslintignore.findEslintIgnore(gameFullPath);
-const filesToIgnore = eslintIgnorePath === null ? new Set() : eslintignore.expandEslintIgnore(eslintIgnorePath);
-const filesToLint = eslintignore.expandRootToNonIgnoredFiles(gameFullPath, filesToIgnore);
-const report = cliEngine.executeOnFiles(filesToLint);
-
-for (const record of report.results) {
-  if (record.errorCount === 0) {
-    continue;
-  }
+};
 
-  console.error(`${record.filePath}`);
-  for (const message of record.messages) {
-    const lineNumber = pad.left(`${message.line}`, 4, ' ');
-    const column = pad.right(`${message.column}`, 4, ' ');
-    const rule = pad.left(`${message.ruleId}`, 25, ' ');
-    const paddedMessage = pad.left(`${message.message}`, 50, ' ');
-    console.log(`${lineNumber}:${column} ${rule} ${paddedMessage}`);
-  }
-}
-
-const exitCode = report.errorCount === 0 ? 0 : program.exitCode;
-process.exit(exitCode);
+fileLinter.run(gameFullPath, lintConfig, true).then(() => {
+  process.exit();
+}).catch(() => {
+  process.exit(program.exitCode);
+});

package-lock.json

@@ -1,15 +1,15 @@
 {
   "name": "springroll-automated-qa",
-  "version": "1.0.3",
+  "version": "1.1.0",
   "description": "An automated QA tool for SpringRoll games",
-  "main": "index.js",
+  "main": "src/index.js",
   "bin": {
     "srac": "bin/srac",
     "srlint": "bin/srlint",
     "sras": "bin/sras"
   },
   "scripts": {
-    "lint": "eslint --fix bin/* config/*.js lib/*.js tests/*.js",
+    "lint": "eslint --fix bin/* config/*.js src/**/*.js tests/*.js",
     "start": "node index.js"
   },
   "keywords": [],

package.json

@@ -0,0 +1,5 @@
+module.exports = {
+  assetScanner: require('./tools/AssetScanner'),
+  fileLinter: require('./tools/FileLinter'),
+  accessibilityChecker: require('./tools/AccessibilityChecker'),
+};

src/index.js

@@ -2,7 +2,7 @@ const expandPath = require('./expand-path');
 const fs = require('fs');
 const glob = require('glob');
 const path = require('path');
-const { isFile } = require('../lib/path-validation.js');
+const { isFile } = require('./path-validation.js');
 
 /**
  * Crawls upward from a path, looking for an .eslintignore file
@@ -19,6 +19,10 @@ const findEslintIgnore = (startingPath) => {
       return eslintIgnorePath;
     }
 
+    if (currentDirectory === path.dirname(currentDirectory)) {
+      return null;
+    }
+
     // Go back a directory and look there
     currentDirectory = path.dirname(currentDirectory);
   }