Security News
GitHub Removes Malicious Pull Requests Targeting Open Source Repositories
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.
jasmine-axe
Advanced tools
Custom Jasmine matcher for aXe for testing accessibility
npm install --save-dev jasmine-axe
import { TestBed } from "@angular/core/testing";
import { axe, toHaveNoViolations } from "jasmine-axe";
import TestComponent from "./TestComponent.component";
describe("TestComponent", () => {
beforeEach(() => {
TestBed.configureTestingModule({
declarations: [TestComponent],
});
TestBed.compileComponents();
jasmine.addMatchers(toHaveNoViolations);
});
it("should pass accessibility test", async () => {
const fixture = TestBed.createComponent(TestComponent);
expect(await axe(fixture.nativeElement)).toHaveNoViolations();
});
});
If you want to add an accessibility check on an existing project, you will probably find many accessibility issues, and you may not have time to fix them right away.
Instead of skipping the test until you have time to fix the issues, you can use another matcher toHaveLessThanXViolations
. You will be able to prevent new accessibility issues to appear.
This matcher should be use as a temporary fix, the objective is of course to have no violations at all.
import { TestBed } from "@angular/core/testing";
import { axe, toHaveLessThanXViolations } from "jasmine-axe";
import TestComponent from "./TestComponent.component";
describe("TestComponent", () => {
beforeEach(() => {
TestBed.configureTestingModule({
declarations: [TestComponent],
});
TestBed.compileComponents();
jasmine.addMatchers(toHaveLessThanXViolations);
});
it("should have less than 2 accessibility issues", async () => {
const fixture = TestBed.createComponent(TestComponent);
expect(await axe(fixture.nativeElement)).toHaveLessThanXViolations(2);
});
});
The axe
function allows options to be set with the same options as documented in axe-core:
import { axe, toHaveNoViolations } from "jasmine-axe";
describe("TestComponent", () => {
beforeEach(() => {
TestBed.configureTestingModule({
declarations: [],
});
TestBed.compileComponents();
jasmine.addMatchers(toHaveNoViolations);
});
it("should demonstrate this matcher`s usage with a custom config", async () => {
const render = () => `
<div>
<img src="#"/>
</div>
`;
const html = render();
const results = await axe(html, {
rules: {
// for demonstration only, don't disable rules that need fixing.
"image-alt": { enabled: false },
},
});
expect(results).toHaveNoViolations();
});
});
If you find yourself repeating the same options multiple times, you can export a version of the axe
function with defaults set.
Note: You can still pass additional options to this new instance; they will be merged with the defaults.
The configuration object passed to configureAxe
also accepts a globalOptions
property to configure the format of the data used by axe and to add custom checks and rules. The property value is the same as the parameter passed to axe.configure.
// Global helper file (axe-helper.js)
import { configureAxe } from "jasmine-axe";
const axe = configureAxe({
rules: {
// for demonstration only, don't disable rules that need fixing.
"image-alt": { enabled: false },
},
globalOptions: {
checks: [
/* custom checks definitions */
],
},
});
export default axe;
Thanks goes to these wonderful people (emoji key):
MathildeDuboille ️️️️♿️ 💻 | Albéric Trancart ️️️️♿️ 💻 |
This project follows the all-contributors specification. Contributions of any kind welcome!
FAQs
Custom Jasmine matcher for aXe for testing accessibility
We found that jasmine-axe demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.
Security News
RubyGems.org has added a new "maintainer" role that allows for publishing new versions of gems. This new permission type is aimed at improving security for gem owners and the service overall.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.