gbu-accessibility-package 3.12.0 → 3.13.0

package/index.js

@@ -1,3 +1,6 @@
-const AccessibilityFixer = require('./lib/fixer.js');
+const AccessibilityChecker = require('./lib/checker.js');
 
-module.exports = { AccessibilityFixer };
+module.exports = {
+  AccessibilityChecker,
+  AccessibilityFixer: AccessibilityChecker
+};

package/lib/checker.js

@@ -0,0 +1,233 @@
+const AccessibilityFixer = require('./fixer.js');
+
+class AccessibilityChecker extends AccessibilityFixer {
+  constructor(config = {}) {
+    super({
+      ...config,
+      dryRun: true,
+      backupFiles: false,
+      autoFixHeadings: false
+    });
+  }
+
+  transformLogValue(value) {
+    if (typeof value !== 'string') {
+      return value;
+    }
+
+    return value
+      .replace(/Đang sửa/g, 'Đang kiểm tra')
+      .replace(/Fixing/g, 'Checking')
+      .replace(/✅ Fixed/g, '✅ Reported')
+      .replace(/Files fixed/g, 'Files with findings')
+      .replace(/files fixed/g, 'files with findings')
+      .replace(/Tự động sửa/g, 'Rà soát')
+      .replace(/Sử dụng --meta-fix để tự động sửa các lỗi này/g, 'Các lỗi meta cần được review và xử lý thủ công')
+      .replace(/Use without --dry-run to apply changes\./g, 'Source files are never modified.');
+  }
+
+  async withCheckOnlyLogging(task) {
+    const originalLog = console.log;
+    const originalError = console.error;
+
+    console.log = (...messages) => originalLog(...messages.map((message) => this.transformLogValue(message)));
+    console.error = (...messages) => originalError(...messages.map((message) => this.transformLogValue(message)));
+
+    try {
+      return await task();
+    } finally {
+      console.log = originalLog;
+      console.error = originalError;
+    }
+  }
+
+  normalizeSimulationResults(results = []) {
+    return results.map((result) => {
+      if (result.status === 'fixed') {
+        return {
+          ...result,
+          status: 'issue-found',
+          rawStatus: result.status
+        };
+      }
+
+      if (result.status === 'no-change') {
+        return {
+          ...result,
+          status: 'clean',
+          rawStatus: result.status
+        };
+      }
+
+      return result;
+    });
+  }
+
+  async checkLang(directory = '.') {
+    return this.withCheckOnlyLogging(async () => this.normalizeSimulationResults(await super.fixHtmlLang(directory)));
+  }
+
+  async checkAltText(directory = '.') {
+    return this.withCheckOnlyLogging(async () => this.normalizeSimulationResults(await super.fixEmptyAltAttributes(directory)));
+  }
+
+  async checkRoles(directory = '.') {
+    return this.withCheckOnlyLogging(async () => this.normalizeSimulationResults(await super.fixRoleAttributes(directory)));
+  }
+
+  async checkAriaLabels(directory = '.') {
+    return this.withCheckOnlyLogging(async () => this.normalizeSimulationResults(await super.fixAriaLabels(directory)));
+  }
+
+  async checkForms(directory = '.') {
+    return this.withCheckOnlyLogging(async () => this.normalizeSimulationResults(await super.fixFormLabels(directory)));
+  }
+
+  async checkNestedControls(directory = '.') {
+    return this.withCheckOnlyLogging(async () => this.normalizeSimulationResults(await super.fixNestedInteractiveControls(directory)));
+  }
+
+  async checkButtons(directory = '.') {
+    return this.withCheckOnlyLogging(async () => this.normalizeSimulationResults(await super.fixButtonNames(directory)));
+  }
+
+  async checkLinks(directory = '.') {
+    return this.withCheckOnlyLogging(async () => this.normalizeSimulationResults(await super.fixLinkNames(directory)));
+  }
+
+  async checkLandmarks(directory = '.') {
+    return this.withCheckOnlyLogging(async () => this.normalizeSimulationResults(await super.fixLandmarks(directory)));
+  }
+
+  async checkHeadings(directory = '.') {
+    return this.withCheckOnlyLogging(async () => this.normalizeSimulationResults(await super.fixHeadingStructure(directory)));
+  }
+
+  async checkDescriptionLists(directory = '.') {
+    return this.withCheckOnlyLogging(async () => this.normalizeSimulationResults(await super.fixDescriptionLists(directory)));
+  }
+
+  async checkLinksAndResources(directory = '.') {
+    return this.withCheckOnlyLogging(async () => {
+      const [brokenLinks, missingResources] = await Promise.all([
+        this.checkBrokenLinks(directory),
+        this.check404Resources(directory)
+      ]);
+
+      return {
+        brokenLinks,
+        missingResources
+      };
+    });
+  }
+
+  async previewUnusedFilesListRemoval(directory = '.', listFile = 'unused-files-list.txt') {
+    return this.withCheckOnlyLogging(async () => super.deleteUnusedFilesFromList(directory, listFile, { dryRun: true }));
+  }
+
+  async checkMetaTags(directory = '.') {
+    return this.withCheckOnlyLogging(async () => super.checkMetaTags(directory));
+  }
+
+  async checkUnusedFiles(directory = '.') {
+    return this.withCheckOnlyLogging(async () => super.checkUnusedFiles(directory));
+  }
+
+  async generateUnusedFilesList(directory = '.', listFile = 'unused-files-list.txt') {
+    return this.withCheckOnlyLogging(async () => super.generateUnusedFilesList(directory, listFile));
+  }
+
+  async checkDeadCode(directory = '.') {
+    return this.withCheckOnlyLogging(async () => super.checkDeadCode(directory));
+  }
+
+  async checkFileSizes(directory = '.') {
+    return this.withCheckOnlyLogging(async () => super.checkFileSizes(directory));
+  }
+
+  async checkGoogleTagManager(directory = '.') {
+    return this.withCheckOnlyLogging(async () => super.checkGoogleTagManager(directory));
+  }
+
+  async generateFullReport(directory = '.', outputPath = null) {
+    return this.withCheckOnlyLogging(async () => super.generateFullReport(directory, outputPath));
+  }
+
+  async runComprehensiveChecks(directory = '.') {
+    const results = {};
+
+    results.lang = await this.checkLang(directory);
+    results.alt = await this.checkAltText(directory);
+    results.roles = await this.checkRoles(directory);
+    results.ariaLabels = await this.checkAriaLabels(directory);
+    results.forms = await this.checkForms(directory);
+    results.nestedControls = await this.checkNestedControls(directory);
+    results.buttons = await this.checkButtons(directory);
+    results.links = await this.checkLinks(directory);
+    results.landmarks = await this.checkLandmarks(directory);
+    results.headings = await this.checkHeadings(directory);
+    results.descriptionLists = await this.checkDescriptionLists(directory);
+    results.externalLinks = await this.withCheckOnlyLogging(async () => this.checkBrokenLinks(directory));
+    results.missingResources = await this.withCheckOnlyLogging(async () => this.check404Resources(directory));
+
+    return results;
+  }
+
+  async fixHtmlLang(directory = '.') {
+    return this.checkLang(directory);
+  }
+
+  async fixEmptyAltAttributes(directory = '.') {
+    return this.checkAltText(directory);
+  }
+
+  async fixRoleAttributes(directory = '.') {
+    return this.checkRoles(directory);
+  }
+
+  async fixAriaLabels(directory = '.') {
+    return this.checkAriaLabels(directory);
+  }
+
+  async fixFormLabels(directory = '.') {
+    return this.checkForms(directory);
+  }
+
+  async fixNestedInteractiveControls(directory = '.') {
+    return this.checkNestedControls(directory);
+  }
+
+  async fixButtonNames(directory = '.') {
+    return this.checkButtons(directory);
+  }
+
+  async fixLinkNames(directory = '.') {
+    return this.checkLinks(directory);
+  }
+
+  async fixLandmarks(directory = '.') {
+    return this.checkLandmarks(directory);
+  }
+
+  async fixHeadingStructure(directory = '.') {
+    return this.checkHeadings(directory);
+  }
+
+  async fixDescriptionLists(directory = '.') {
+    return this.checkDescriptionLists(directory);
+  }
+
+  async fixMetaTags(directory = '.') {
+    return this.checkMetaTags(directory);
+  }
+
+  async fixAllAccessibilityIssues(directory = '.') {
+    return this.runComprehensiveChecks(directory);
+  }
+
+  async deleteUnusedFilesFromList(directory = '.', listFile = 'unused-files-list.txt') {
+    return this.previewUnusedFilesListRemoval(directory, listFile);
+  }
+}
+
+module.exports = AccessibilityChecker;