Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(rule): tabindex should not be positive #744

Merged
merged 2 commits into from
Feb 9, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ export { Rule as PreferInlineDecorator } from './preferInlineDecoratorRule';
export { Rule as PreferOutputReadonlyRule } from './preferOutputReadonlyRule';
export { Rule as TemplateConditionalComplexityRule } from './templateConditionalComplexityRule';
export { Rule as TemplateCyclomaticComplexityRule } from './templateCyclomaticComplexityRule';
export { Rule as TemplateAccessibilityTabindexNoPositiveRule } from './templateAccessibilityTabindexNoPositiveRule';
export { Rule as TemplatesNoNegatedAsync } from './templatesNoNegatedAsyncRule';
export { Rule as TrackByFunctionRule } from './trackByFunctionRule';
export { Rule as UseHostPropertyDecoratorRule } from './useHostPropertyDecoratorRule';
Expand Down
51 changes: 51 additions & 0 deletions src/templateAccessibilityTabindexNoPositiveRule.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
import { ElementAst } from '@angular/compiler';
import { IRuleMetadata, RuleFailure, Rules } from 'tslint/lib';
import { SourceFile } from 'typescript/lib/typescript';
import { NgWalker } from './angular/ngWalker';
import { BasicTemplateAstVisitor } from './angular/templates/basicTemplateAstVisitor';
import { getAttributeValue } from './util/getAttributeValue';

export class Rule extends Rules.AbstractRule {
static readonly metadata: IRuleMetadata = {
description: 'Ensures that the tab index is not positive',
options: null,
optionsDescription: 'Not configurable.',
rationale: 'positive values for tabidex attribute should be avoided because they mess up with the order of focus (AX_FOCUS_03)',
ruleName: 'template-accessibility-tabindex-no-positive',
type: 'functionality',
typescriptOnly: true
};

static readonly FAILURE_MESSAGE = 'Tabindex cannot be positive';

apply(sourceFile: SourceFile): RuleFailure[] {
return this.applyWithWalker(
new NgWalker(sourceFile, this.getOptions(), {
templateVisitorCtrl: TemplateAccessibilityTabindexNoPositiveVisitor
})
);
}
}

class TemplateAccessibilityTabindexNoPositiveVisitor extends BasicTemplateAstVisitor {
visitElement(ast: ElementAst, context: any): any {
this.validateElement(ast);
super.visitElement(ast, context);
}

private validateElement(element: ElementAst) {
let tabIndexValue = getAttributeValue(element, 'tabindex');
if (tabIndexValue) {
tabIndexValue = parseInt(tabIndexValue, 10);
if (tabIndexValue > 0) {
const {
sourceSpan: {
end: { offset: endOffset },
start: { offset: startOffset }
}
} = element;
this.addFailureFromStartToEnd(startOffset, endOffset, Rule.FAILURE_MESSAGE);
}
}
}
}
12 changes: 12 additions & 0 deletions src/util/getAttributeValue.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
import { ElementAst } from '@angular/compiler';

export const getAttributeValue = (element: ElementAst, property: string) => {
const attr = element.attrs.find(attr => attr.name === property);
const input = element.inputs.find(input => input.name === property);
if (attr) {
return attr.value;
}
if (input) {
return (<any>input.value).ast.value;
}
};
63 changes: 63 additions & 0 deletions test/templateAccessibilityTabindexNoPositiveRule.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
import { Rule } from '../src/templateAccessibilityTabindexNoPositiveRule';
import { assertAnnotated, assertSuccess } from './testHelper';

const {
FAILURE_MESSAGE,
metadata: { ruleName }
} = Rule;

describe(ruleName, () => {
describe('failure', () => {
it('should fail when tabindex attr is positive', () => {
const source = `
@Component({
template: \`
<div tabindex="5"></div>
~~~~~~~~~~~~~~~~~~
\`
})
class Bar {}
`;
assertAnnotated({
message: FAILURE_MESSAGE,
ruleName,
source
});
});

it('should fail when tabindex input is positive', () => {
const source = `
@Component({
template: \`
<div [attr.tabindex]="1"></div>
~~~~~~~~~~~~~~~~~~~~~~~~~
\`
})
class Bar {}
`;
assertAnnotated({
message: FAILURE_MESSAGE,
ruleName,
source
});
});
});

describe('success', () => {
it('should work with tab index is not positive', () => {
const source = `
@Component({
template: \`
<span tabindex="-1"></span>
<span tabindex="0"></span>
<span [attr.tabindex]="-1"></span>
<span [attr.tabindex]="0"></span>
<span [attr.tabindex]="tabIndex"></span>
\`
})
class Bar {}
`;
assertSuccess(ruleName, source);
});
});
});