👕 Apply node-param-description-miscased-url (#3441)

n8n-io · Jun 3, 2022 · c03ab51 · c03ab51
1 parent b238d75
commit c03ab51
Show file tree

Hide file tree

Showing 19 changed files with 30 additions and 24 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -423,6 +423,7 @@ module.exports = {
 				'n8n-nodes-base/node-param-resource-with-plural-option': 'error',
 				'n8n-nodes-base/node-param-resource-without-no-data-expression': 'error',
 				'n8n-nodes-base/node-param-type-options-missing-from-limit': 'error',
+				'n8n-nodes-base/node-param-description-miscased-url': 'error',
 			},
 		},
 	],

diff --git a/packages/nodes-base/nodes/Bannerbear/ImageDescription.ts b/packages/nodes-base/nodes/Bannerbear/ImageDescription.ts
@@ -111,7 +111,7 @@ export const imageFields: INodeProperties[] = [
 				name: 'webhookUrl',
 				type: 'string',
 				default: '',
-				description: 'A url to POST the Image object to upon rendering completed',
+				description: 'A URL to POST the Image object to upon rendering completed',
 			},
 		],
 	},
@@ -178,7 +178,7 @@ export const imageFields: INodeProperties[] = [
 						name: 'imageUrl',
 						type: 'string',
 						default: '',
-						description: 'Replacement image url you want to use (must be publicly viewable)',
+						description: 'Replacement image URL you want to use (must be publicly viewable)',
 					},
 				],
 			},

diff --git a/packages/nodes-base/nodes/Ghost/PostDescription.ts b/packages/nodes-base/nodes/Ghost/PostDescription.ts
@@ -440,6 +440,7 @@ export const postFields: INodeProperties[] = [
 				name: 'fields',
 				type: 'string',
 				default: '',
+				// eslint-disable-next-line n8n-nodes-base/node-param-description-miscased-url
 				description: 'Limit the fields returned in the response object. E.g. for posts fields=title,url.',
 			},
 			{
@@ -487,6 +488,7 @@ export const postFields: INodeProperties[] = [
 				name: 'fields',
 				type: 'string',
 				default: '',
+				// eslint-disable-next-line n8n-nodes-base/node-param-description-miscased-url
 				description: 'Limit the fields returned in the response object. E.g. for posts fields=title,url.',
 			},
 			{
@@ -604,6 +606,7 @@ export const postFields: INodeProperties[] = [
 				name: 'fields',
 				type: 'string',
 				default: '',
+				// eslint-disable-next-line n8n-nodes-base/node-param-description-miscased-url
 				description: 'Limit the fields returned in the response object. E.g. for posts fields=title,url.',
 			},
 			{
@@ -669,6 +672,7 @@ export const postFields: INodeProperties[] = [
 				name: 'fields',
 				type: 'string',
 				default: '',
+				// eslint-disable-next-line n8n-nodes-base/node-param-description-miscased-url
 				description: 'Limit the fields returned in the response object. E.g. for posts fields=title,url.',
 			},
 			{

diff --git a/packages/nodes-base/nodes/HelpScout/CustomerDescription.ts b/packages/nodes-base/nodes/HelpScout/CustomerDescription.ts
@@ -517,7 +517,7 @@ export const customerFields: INodeProperties[] = [
 						name: 'value',
 						type: 'string',
 						default: '',
-						description: 'Social Profile handle (url for example)',
+						description: 'Social Profile handle (URL for example)',
 					},
 				],
 			},

diff --git a/packages/nodes-base/nodes/Intercom/LeadDescription.ts b/packages/nodes-base/nodes/Intercom/LeadDescription.ts
@@ -347,7 +347,7 @@ export const leadFields: INodeProperties[] = [
 				name: 'avatar',
 				type: 'string',
 				default: '',
-				description: 'An avatar image URL. note: the image url needs to be https.',
+				description: 'An avatar image URL. note: the image URL needs to be https.',
 			},
 			{
 				displayName: 'Companies',
@@ -430,7 +430,7 @@ export const leadFields: INodeProperties[] = [
 				name: 'utmSource',
 				type: 'string',
 				default: '',
-				description: 'An avatar image URL. note: the image url needs to be https.',
+				description: 'An avatar image URL. note: the image URL needs to be https.',
 			},
 			{
 				displayName: 'UTM Term',

diff --git a/packages/nodes-base/nodes/Intercom/UserDescription.ts b/packages/nodes-base/nodes/Intercom/UserDescription.ts
@@ -361,7 +361,7 @@ export const userFields: INodeProperties[] = [
 				name: 'avatar',
 				type: 'string',
 				default: '',
-				description: 'An avatar image URL. note: the image url needs to be https.',
+				description: 'An avatar image URL. note: the image URL needs to be https.',
 			},
 			{
 				displayName: 'Companies',
@@ -483,7 +483,7 @@ export const userFields: INodeProperties[] = [
 				name: 'utmSource',
 				type: 'string',
 				default: '',
-				description: 'An avatar image URL. note: the image url needs to be https.',
+				description: 'An avatar image URL. note: the image URL needs to be https.',
 			},
 			{
 				displayName: 'UTM Term',

diff --git a/packages/nodes-base/nodes/Lemlist/descriptions/LeadDescription.ts b/packages/nodes-base/nodes/Lemlist/descriptions/LeadDescription.ts
@@ -143,14 +143,14 @@ export const leadFields: INodeProperties[] = [
 				name: 'picture',
 				type: 'string',
 				default: '',
-				description: 'Picture url of the lead to create',
+				description: 'Picture URL of the lead to create',
 			},
 			{
 				displayName: 'LinkedIn URL',
 				name: 'linkedinUrl',
 				type: 'string',
 				default: '',
-				description: 'LinkedIn url of the lead to create',
+				description: 'LinkedIn URL of the lead to create',
 			},
 		],
 	},

diff --git a/packages/nodes-base/nodes/Markdown/Markdown.node.ts b/packages/nodes-base/nodes/Markdown/Markdown.node.ts
@@ -324,7 +324,7 @@ export class Markdown implements INodeType {
 						// eslint-disable-next-line n8n-nodes-base/node-param-default-wrong-for-simplify
 						default: false,
 						// eslint-disable-next-line n8n-nodes-base/node-param-description-wrong-for-simplify
-						description: 'Whether to enable automatic linking to urls',
+						description: 'Whether to enable automatic linking to URLs',
 					},
 					{
 						displayName: 'Backslash Escapes HTML Tags',
@@ -368,8 +368,7 @@ export class Markdown implements INodeType {
 						name: 'excludeTrailingPunctuationFromURLs',
 						type: 'boolean',
 						default: false,
-						description:
-							'Whether to exclude trailing punctuation from autolinking urls. Punctuation excluded: . ! ? ( ). Only applies if simplifiedAutoLink option is set to true.',
+						description: 'Whether to exclude trailing punctuation from autolinking URLs. Punctuation excluded: . ! ? ( ). Only applies if simplifiedAutoLink option is set to true.',
 					},
 					{
 						displayName: 'GitHub Code Blocks',

diff --git a/packages/nodes-base/nodes/Nasa/Nasa.node.ts b/packages/nodes-base/nodes/Nasa/Nasa.node.ts
@@ -600,7 +600,7 @@ export class Nasa implements INodeType {
 					},
 				},
 				default: true,
-				description: 'By default just the url of the image is returned. When set to true the image will be downloaded.',
+				description: 'By default just the URL of the image is returned. When set to true the image will be downloaded.',
 			},
 			{
 				displayName: 'Binary Property',

diff --git a/packages/nodes-base/nodes/OneSimpleApi/OneSimpleApi.node.ts b/packages/nodes-base/nodes/OneSimpleApi/OneSimpleApi.node.ts
@@ -162,7 +162,7 @@ export class OneSimpleApi implements INodeType {
 					{
 						name: 'Expand URL',
 						value: 'expandURL',
-						description: 'Expand a shortened url',
+						description: 'Expand a shortened URL',
 					},
 					{
 						name: 'Generate QR Code',

diff --git a/packages/nodes-base/nodes/Rocketchat/Rocketchat.node.ts b/packages/nodes-base/nodes/Rocketchat/Rocketchat.node.ts
@@ -183,7 +183,7 @@ export class Rocketchat implements INodeType {
 						name: 'avatar',
 						type: 'string',
 						default: '',
-						description: 'If provided, this will make the avatar use the provided image url',
+						description: 'If provided, this will make the avatar use the provided image URL',
 					},
 					{
 						displayName: 'Emoji',

diff --git a/packages/nodes-base/nodes/Segment/GroupDescription.ts b/packages/nodes-base/nodes/Segment/GroupDescription.ts
@@ -155,7 +155,7 @@ export const groupFields: INodeProperties[] = [
 						name: 'page',
 						type: 'string',
 						default: '',
-						description: 'Dictionary of information about the current page in the browser, containing hash, path, referrer, search, title and url',
+						description: 'Dictionary of information about the current page in the browser, containing hash, path, referrer, search, title and URL',
 					},
 					{
 						displayName: 'Timezone',

diff --git a/packages/nodes-base/nodes/Segment/IdentifyDescription.ts b/packages/nodes-base/nodes/Segment/IdentifyDescription.ts
@@ -137,7 +137,7 @@ export const identifyFields: INodeProperties[] = [
 						name: 'page',
 						type: 'string',
 						default: '',
-						description: 'Dictionary of information about the current page in the browser, containing hash, path, referrer, search, title and url',
+						description: 'Dictionary of information about the current page in the browser, containing hash, path, referrer, search, title and URL',
 					},
 					{
 						displayName: 'Timezone',

diff --git a/packages/nodes-base/nodes/Segment/TrackDescription.ts b/packages/nodes-base/nodes/Segment/TrackDescription.ts
@@ -120,7 +120,7 @@ export const trackFields: INodeProperties[] = [
 						name: 'page',
 						type: 'string',
 						default: '',
-						description: 'Dictionary of information about the current page in the browser, containing hash, path, referrer, search, title and url',
+						description: 'Dictionary of information about the current page in the browser, containing hash, path, referrer, search, title and URL',
 					},
 					{
 						displayName: 'Timezone',
@@ -437,7 +437,7 @@ export const trackFields: INodeProperties[] = [
 						name: 'page',
 						type: 'string',
 						default: '',
-						description: 'Dictionary of information about the current page in the browser, containing hash, path, referrer, search, title and url',
+						description: 'Dictionary of information about the current page in the browser, containing hash, path, referrer, search, title and URL',
 					},
 					{
 						displayName: 'Timezone',

diff --git a/packages/nodes-base/nodes/Slack/MessageDescription.ts b/packages/nodes-base/nodes/Slack/MessageDescription.ts
@@ -774,7 +774,7 @@ export const messageFields: INodeProperties[] = [
 											},
 										},
 										default: '',
-										description: 'A URL to load in the user\'s browser when the button is clicked. Maximum length for this field is 3000 characters. If you\'re using url, you\'ll still receive an interaction payload and will need to send an acknowledgement response.',
+										description: 'A URL to load in the user\'s browser when the button is clicked. Maximum length for this field is 3000 characters. If you\'re using URL, you\'ll still receive an interaction payload and will need to send an acknowledgement response.',
 									},
 									{
 										displayName: 'Value',
@@ -1252,7 +1252,7 @@ export const messageFields: INodeProperties[] = [
 										},
 										type: 'string',
 										default: '',
-										description: 'A URL to load in the user\'s browser when the button is clicked. Maximum length for this field is 3000 characters. If you\'re using url, you\'ll still receive an interaction payload and will need to send an acknowledgement response.',
+										description: 'A URL to load in the user\'s browser when the button is clicked. Maximum length for this field is 3000 characters. If you\'re using URL, you\'ll still receive an interaction payload and will need to send an acknowledgement response.',
 									},
 									{
 										displayName: 'Value',

diff --git a/packages/nodes-base/nodes/Telegram/Telegram.node.ts b/packages/nodes-base/nodes/Telegram/Telegram.node.ts
@@ -1433,7 +1433,7 @@ export class Telegram implements INodeType {
 														name: 'url',
 														type: 'string',
 														default: '',
-														description: 'HTTP or tg:// url to be opened when button is pressed',
+														description: 'HTTP or tg:// URL to be opened when button is pressed',
 													},
 												],
 											},

diff --git a/packages/nodes-base/nodes/Trello/BoardDescription.ts b/packages/nodes-base/nodes/Trello/BoardDescription.ts
@@ -368,7 +368,7 @@ export const boardFields: INodeProperties[] = [
 				name: 'fields',
 				type: 'string',
 				default: 'all',
-				description: 'Fields to return. Either "all" or a comma-separated list: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed, url.',
+				description: 'Fields to return. Either "all" or a comma-separated list: closed, dateLastActivity, dateLastView, desc, descData, idOrganization, invitations, invited, labelNames, memberships, name, pinned, powerUps, prefs, shortLink, shortUrl, starred, subscribed, URL.',
 			},
 			{
 				displayName: 'Plugin Data',

diff --git a/packages/nodes-base/nodes/Trello/CardDescription.ts b/packages/nodes-base/nodes/Trello/CardDescription.ts
@@ -243,6 +243,7 @@ export const cardFields: INodeProperties[] = [
 				name: 'fields',
 				type: 'string',
 				default: 'all',
+				// eslint-disable-next-line n8n-nodes-base/node-param-description-miscased-url
 				description: 'Fields to return. Either "all" or a comma-separated list: badges, checkItemStates, closed, dateLastActivity, desc, descData, due, email, idBoard, idChecklists, idLabels, idList, idMembers, idShort, idAttachmentCover, manualCoverAttachment, labels, name, pos, shortUrl, url.',
 			},
 			{
@@ -257,6 +258,7 @@ export const cardFields: INodeProperties[] = [
 				name: 'board_fields',
 				type: 'string',
 				default: 'all',
+				// eslint-disable-next-line n8n-nodes-base/node-param-description-miscased-url
 				description: 'Fields to return. Either "all" or a comma-separated list: name, desc, descData, closed, idOrganization, pinned, url, prefs.',
 			},
 			{

diff --git a/packages/nodes-base/nodes/UptimeRobot/MonitorDescription.ts b/packages/nodes-base/nodes/UptimeRobot/MonitorDescription.ts
@@ -257,7 +257,7 @@ export const monitorFields: INodeProperties[] = [
 				name: 'search',
 				type: 'string',
 				default: '',
-				description: 'A keyword to be matched against url and friendly name',
+				description: 'A keyword to be matched against URL and friendly name',
 			},
 			{
 				displayName: 'Statuses',