7.2.7 • Published 5 months ago

@sa11y/common v7.2.7

Weekly downloads
1,046
License
BSD-3-Clause
Repository
github
Last release
5 months ago

@sa11y/common

Common utilities, constants, error messages, and helper functions for @sa11y packages.

Overview

This package provides shared functionality used across all @sa11y packages. It includes utilities for environment detection, custom rule management, file processing, and result handling.

Utilities

Environment Detection

import { log, isFakeTimerUsed } from '@sa11y/common';

// Debug logging (only outputs when SA11Y_DEBUG is set)
log('Debug message');

// Check if fake timers are being used
if (isFakeTimerUsed()) {
    // Handle fake timer scenario
}

Custom Rules

import { useCustomRules, registerCustomRules } from '@sa11y/common';

// Load custom rules from environment
const customRules = useCustomRules();

// Register custom axe rules
registerCustomRules(changesData, rulesData, checkData);

File Processing

import { processFiles, writeHtmlFileInPath } from '@sa11y/common';

// Process files in a directory
const results = [];
processFiles('/path/to/directory', results, '.json', JSON.parse);

// Write HTML file for debugging
writeHtmlFileInPath('/output/path', 'test.html', '<html>...</html>');

Result Processing

import { getViolations, getIncomplete } from '@sa11y/common';

// Get violations using a custom checker function
const violations = await getViolations(async () => {
    const results = await axe.run();
    return results.violations;
});

// Get incomplete results
const incomplete = await getIncomplete(async () => {
    const results = await axe.run();
    return results.incomplete;
});

Environment Variables

  • SA11Y_DEBUG: Enable debug logging
  • SA11Y_CUSTOM_RULES: Path to custom rules JSON file
  • SA11Y_AUTO_FILTER_LIST_PACKAGE_NAME: Package name for auto-filter list
  • SA11Y_AUTO_FILTER_LIST_PACKAGE_REQUIREMENT: Package requirement for auto-filter
6.13.0

12 months ago

7.0.0

10 months ago

7.0.1

6 months ago

7.1.7

5 months ago

7.1.6

5 months ago

7.1.5

5 months ago

7.1.4

5 months ago

6.12.3

12 months ago

7.1.3

5 months ago

7.1.2

5 months ago

7.1.1

5 months ago

7.1.0

5 months ago

7.2.6

5 months ago

7.2.5

5 months ago

7.2.4

5 months ago

7.2.3

5 months ago

7.2.7

5 months ago

7.2.0-alpha.1

5 months ago

7.2.0-alpha.2

5 months ago

7.2.0-alpha.3

5 months ago

7.2.2

5 months ago

7.2.1

5 months ago

7.2.0

5 months ago

7.1.0-alpha.1

8 months ago

7.1.0-alpha.2

5 months ago

6.13.0-alpha.1

12 months ago

6.12.1

1 year ago

6.12.0

1 year ago

6.11.0

1 year ago

6.10.3

1 year ago

6.10.2

1 year ago

6.10.1-alpha.1

1 year ago

6.8.0

1 year ago

6.7.1-alpha.4

1 year ago

6.10.1

1 year ago

6.10.0

1 year ago

6.9.5-alpha.1

1 year ago

6.10.2-alpha.1

1 year ago

6.9.5-alpha.2

1 year ago

6.9.5-alpha.3

1 year ago

6.9.5-alpha.4

1 year ago

6.10.2-alpha.2

1 year ago

6.9.0

1 year ago

6.10.2-alpha.3

1 year ago

6.9.2

1 year ago

6.9.1

1 year ago

6.9.4

1 year ago

6.9.3

1 year ago

6.9.5

1 year ago

6.7.1-alpha.3

1 year ago

6.7.1-alpha.2

1 year ago

6.7.1-alpha.1

1 year ago

6.7.0

1 year ago

6.6.2

1 year ago

6.6.1

2 years ago

6.6.0

2 years ago

6.5.1

2 years ago

6.5.0

2 years ago

6.4.0

2 years ago

6.3.2

2 years ago

6.3.1

2 years ago

6.3.0

2 years ago

6.2.3

2 years ago

6.3.0-alpha.1

2 years ago

5.3.2

2 years ago

5.3.1

2 years ago

5.3.0

2 years ago

6.1.0

2 years ago

6.0.0

2 years ago

6.2.1

2 years ago

6.1.2

2 years ago

6.2.0

2 years ago

6.1.1

2 years ago

6.2.2

2 years ago

5.2.0

2 years ago

5.1.0

2 years ago

5.0.1

2 years ago

5.0.0

2 years ago

4.1.4

3 years ago

4.1.5

3 years ago

4.1.3

3 years ago

4.1.2

3 years ago

4.1.0

3 years ago

4.1.1

3 years ago

4.0.0-alpha.7

3 years ago

4.0.1

3 years ago

4.0.0

3 years ago

4.0.0-alpha.0

3 years ago

3.1.0

4 years ago

3.0.2

4 years ago

3.0.1

4 years ago

3.0.0

4 years ago

0.4.0

4 years ago

0.3.5

4 years ago

0.3.4

4 years ago

0.3.2

4 years ago

0.3.3

4 years ago

0.3.0

5 years ago

0.2.5-beta.0

5 years ago

0.2.4-beta.0

5 years ago

0.2.3-beta.0

5 years ago

0.2.2-beta.0

5 years ago

0.2.1-beta.0

5 years ago

0.2.0-beta.0

5 years ago

0.1.0-alpha

5 years ago