Skip to content

ts-migration/no-test-prefixes #328

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jul 20, 2019
Merged

ts-migration/no-test-prefixes #328

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 3 additions & 2 deletions src/rules/__tests__/no-test-prefixes.test.js → src/rules/__tests__/no-test-prefixes.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { RuleTester } from 'eslint';
import { TSESLint } from '@typescript-eslint/experimental-utils';
import rule from '../no-test-prefixes';

const ruleTester = new RuleTester();
const ruleTester = new TSESLint.RuleTester();

ruleTester.run('no-test-prefixes', rule, {
valid: [
Expand All @@ -15,6 +15,7 @@ ruleTester.run('no-test-prefixes', rule, {
'it.skip("foo", function () {})',
'test.skip("foo", function () {})',
'foo()',
'[1,2,3].forEach()',
],
invalid: [
{
Expand Down
17 changes: 11 additions & 6 deletions src/rules/no-test-prefixes.js → src/rules/no-test-prefixes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,27 @@
import { getDocsUrl, getNodeName, isDescribe, isTestCase } from './util';
import { createRule, getNodeName, isDescribe, isTestCase } from './tsUtils';

export default {
export default createRule({
name: __filename,
meta: {
docs: {
url: getDocsUrl(__filename),
category: 'Best Practices',
description: 'Use `.only` and `.skip` over `f` and `x`',
recommended: 'error',
},
messages: {
usePreferredName: 'Use "{{ preferredNodeName }}" instead',
},
fixable: 'code',
schema: [],
type: 'suggestion',
},
defaultOptions: [],
create(context) {
return {
CallExpression(node) {
const nodeName = getNodeName(node.callee);

if (!isDescribe(node) && !isTestCase(node)) return;
if (!nodeName || (!isDescribe(node) && !isTestCase(node))) return;

const preferredNodeName = getPreferredNodeName(nodeName);

Expand All @@ -33,9 +38,9 @@ export default {
},
};
},
};
});

function getPreferredNodeName(nodeName) {
function getPreferredNodeName(nodeName: string) {
const firstChar = nodeName.charAt(0);

if (firstChar === 'f') {
Expand Down