node-param-description-miscased-url.test.ts

import rule from "../lib/rules/node-param-description-miscased-url";
import { getRuleName } from "../lib/ast";
import outdent from "outdent";
import { ruleTester } from "../lib/ast/utils/ruleTester";

ruleTester().run(getRuleName(module), rule, {
	valid: [
		{
			code: outdent`
			const test = {
				displayName: 'Operation',
				name: 'operation',
				type: 'string',
				default: '',
				description: 'The URL of the user',
			};`,
		},
		{
			code: outdent`
			const test = {
				name: 'User ID',
				value: 'userId',
				description: 'The URL of the user',
			};`,
		},
		{
			code: outdent`
			const test = {
				name: 'User ID',
				value: 'userId',
				description: 'The cURL command',
			};`,
		},
	],
	invalid: [
		{
			code: outdent`
			const test = {
				displayName: 'Operation',
				name: 'operation',
				type: 'string',
				default: '',
				description: 'The url of the curly user',
			};`,
			errors: [{ messageId: "uppercaseUrl" }],
			output: outdent`
			const test = {
				displayName: 'Operation',
				name: 'operation',
				type: 'string',
				default: '',
				description: 'The URL of the curly user',
			};`,
		},
		{
			code: outdent`
			const test = {
				displayName: 'Operation',
				name: 'operation',
				type: 'string',
				default: '',
				description: 'An avatar image url. note: the image url needs to be https.',
			};`,
			errors: [{ messageId: "uppercaseUrl" }],
			output: outdent`
			const test = {
				displayName: 'Operation',
				name: 'operation',
				type: 'string',
				default: '',
				description: 'An avatar image URL. note: the image URL needs to be https.',
			};`,
		},
		{
			code: outdent`
			const test = {
				displayName: 'Operation',
				name: 'operation',
				type: 'string',
				default: '',
				description: 'The Url of the curly user',
			};`,
			errors: [{ messageId: "uppercaseUrl" }],
			output: outdent`
			const test = {
				displayName: 'Operation',
				name: 'operation',
				type: 'string',
				default: '',
				description: 'The URL of the curly user',
			};`,
		},
		{
			code: outdent`
			const test = {
				displayName: 'Operation',
				name: 'operation',
				type: 'string',
				default: '',
				description: 'Url of the user',
			};`,
			errors: [{ messageId: "uppercaseUrl" }],
			output: outdent`
			const test = {
				displayName: 'Operation',
				name: 'operation',
				type: 'string',
				default: '',
				description: 'URL of the user',
			};`,
		},
		{
			code: outdent`
			const test = {
				name: 'User ID',
				value: 'userId',
				description: 'The url of the curly user',
			};`,
			errors: [{ messageId: "uppercaseUrl" }],
			output: outdent`
			const test = {
				name: 'User ID',
				value: 'userId',
				description: 'The URL of the curly user',
			};`,
		},
		{
			code: outdent`
			const test = {
				name: 'User ID',
				value: 'userId',
				description: 'The Url of the curly user',
			};`,
			errors: [{ messageId: "uppercaseUrl" }],
			output: outdent`
			const test = {
				name: 'User ID',
				value: 'userId',
				description: 'The URL of the curly user',
			};`,
		},
	],
});