Add fixer for no-skip-test rule (#183)

Author: Florian Breisch

readme.md

@@ -78,7 +78,7 @@ The rules will only activate in test files.
 - [no-nested-tests](docs/rules/no-nested-tests.md) - Ensure no tests are nested.
 - [no-only-test](docs/rules/no-only-test.md) - Ensure no `test.only()` are present. *(fixable)*
 - [no-skip-assert](docs/rules/no-skip-assert.md) - Ensure no assertions are skipped.
-- [no-skip-test](docs/rules/no-skip-test.md) - Ensure no tests are skipped.
+- [no-skip-test](docs/rules/no-skip-test.md) - Ensure no tests are skipped. *(fixable)*
 - [no-statement-after-end](docs/rules/no-statement-after-end.md) - Ensure `t.end()` is the last statement executed.
 - [no-todo-implementation](docs/rules/no-todo-implementation.md) - Ensure `test.todo()` is not given an implementation function.
 - [no-todo-test](docs/rules/no-todo-test.md) - Ensure no `test.todo()` is used.

rules/no-only-test.js

@@ -17,15 +17,11 @@ const create = context => {
 					node: propertyNode,
 					message: '`test.only()` should not be used.',
 					fix: fixer => {
-						const range = propertyNode.range.slice();
-						const source = context.getSourceCode().getText();
-						let dotPosition = range[0] - 1;
-						while (source.charAt(dotPosition) !== '.') {
-							dotPosition -= 1;
-						}
-						let snippet = source.substring(dotPosition, range[1]);
-						snippet = snippet.replace(/\.|only/g, '');
-						return fixer.replaceTextRange([dotPosition, range[1]], snippet);
+						return fixer.replaceTextRange.apply(null, util.removeTestModifier({
+							modifier: 'only',
+							node,
+							context
+						}));
 					}
 				});
 			}

rules/no-skip-test.js

@@ -15,7 +15,14 @@ const create = context => {
 			if (propertyNode) {
 				context.report({
 					node: propertyNode,
-					message: 'No tests should be skipped.'
+					message: 'No tests should be skipped.',
+					fix: fixer => {
+						return fixer.replaceTextRange.apply(null, util.removeTestModifier({
+							modifier: 'skip',
+							node,
+							context
+						}));
+					}
 				});
 			}
 		})
@@ -24,5 +31,7 @@ const create = context => {
 
 module.exports = {
 	create,
-	meta: {}
+	meta: {
+		fixable: 'code'
+	}
 };

test/no-skip-test.js

@@ -25,6 +25,7 @@ ruleTester.run('no-skip-test', rule, {
 	invalid: [
 		{
 			code: header + 'test.skip(t => { t.pass(); });',
+			output: header + 'test(t => { t.pass(); });',
 			errors: [{
 				ruleId,
 				message,
@@ -35,6 +36,7 @@ ruleTester.run('no-skip-test', rule, {
 		},
 		{
 			code: header + 'test.cb.skip(t => { t.pass(); t.end(); });',
+			output: header + 'test.cb(t => { t.pass(); t.end(); });',
 			errors: [{
 				ruleId,
 				message,
@@ -45,13 +47,36 @@ ruleTester.run('no-skip-test', rule, {
 		},
 		{
 			code: header + 'test.skip.cb(t => { t.pass(); t.end(); });',
+			output: header + 'test.cb(t => { t.pass(); t.end(); });',
 			errors: [{
 				ruleId,
 				message,
 				type: 'Identifier',
 				line: 2,
 				column: 6
 			}]
+		},
+		{
+			code: header + 'test.\n\tskip.cb(t => { t.pass(); t.end(); });',
+			output: header + 'test\n\t.cb(t => { t.pass(); t.end(); });',
+			errors: [{
+				ruleId,
+				message,
+				type: 'Identifier',
+				line: 3,
+				column: 2
+			}]
+		},
+		{
+			code: header + 'test  .skip  .cb(t => { t.pass(); t.end(); });',
+			output: header + 'test    .cb(t => { t.pass(); t.end(); });',
+			errors: [{
+				ruleId,
+				message,
+				type: 'Identifier',
+				line: 2,
+				column: 8
+			}]
 		}
 	]
 });

util.js

@@ -60,6 +60,29 @@ exports.getTestModifier = (node, mod) => {
 	return testModifiers.find(property => property.name === mod);
 };
 
+/**
+ * Removes given test-modifier from the source surrounding the given node
+ *
+ * @param {string} params.modifier - Name of the modifier
+ * @param {Node} params.node - ESTree-node as provided by ESLint
+ * @param {Context} params.context - ESLint-context as provided
+ *
+ * @return {Array} Compound parameters to be used as arguments for `fix.replaceTextRange()`
+ */
+exports.removeTestModifier = function (params) {
+	const modifier = params.modifier.trim();
+	const range = exports.getTestModifier(params.node, modifier).range.slice();
+	const replacementRegExp = new RegExp(`\\.|${modifier}`, 'g');
+	const source = params.context.getSourceCode().getText();
+	let dotPosition = range[0] - 1;
+	while (source.charAt(dotPosition) !== '.') {
+		dotPosition -= 1;
+	}
+	let snippet = source.slice(dotPosition, range[1]);
+	snippet = snippet.replace(replacementRegExp, '');
+	return [[dotPosition, range[1]], snippet];
+};
+
 const getMembers = node => {
 	const name = node.property.name;