n8n-3446-node-param-description-lowercase-first-char

.eslintrc.js

@@ -430,6 +430,7 @@ module.exports = {
 				'n8n-nodes-base/node-param-option-name-wrong-for-upsert': 'error',
 				'n8n-nodes-base/node-param-default-wrong-for-string': 'error',
 				'n8n-nodes-base/node-param-default-wrong-for-number': 'error',
+				'n8n-nodes-base/node-param-description-lowercase-first-char': 'error',
 				'n8n-nodes-base/node-param-display-name-miscased': 'error',
 			},
 		},

packages/nodes-base/nodes/AcuityScheduling/AcuitySchedulingTrigger.node.ts

@@ -86,27 +86,27 @@ export class AcuitySchedulingTrigger implements INodeType {
 					{
 						name: 'appointment.scheduled',
 						value: 'appointment.scheduled',
-						description: 'is called once when an appointment is initially booked',
+						description: 'Is called once when an appointment is initially booked',
 					},
 					{
 						name: 'appointment.rescheduled',
 						value: 'appointment.rescheduled',
-						description: 'is called when the appointment is rescheduled to a new time',
+						description: 'Is called when the appointment is rescheduled to a new time',
 					},
 					{
 						name: 'appointment.canceled',
 						value: 'appointment.canceled',
-						description: 'is called whenever an appointment is canceled',
+						description: 'Is called whenever an appointment is canceled',
 					},
 					{
 						name: 'appointment.changed',
 						value: 'appointment.changed',
-						description: 'is called when the appointment is changed in any way',
+						description: 'Is called when the appointment is changed in any way',
 					},
 					{
 						name: 'order.completed',
 						value: 'order.completed',
-						description: 'is called when an order is completed',
+						description: 'Is called when an order is completed',
 					},
 				],
 			},

packages/nodes-base/nodes/Amqp/Amqp.node.ts

@@ -38,7 +38,7 @@ export class Amqp implements INodeType {
 				type: 'string',
 				default: '',
 				placeholder: 'topic://sourcename.something',
-				description: 'name of the queue of topic to publish to',
+				description: 'Name of the queue of topic to publish to',
 			},
 			// Header Parameters
 			{

packages/nodes-base/nodes/Amqp/AmqpTrigger.node.ts

@@ -42,7 +42,7 @@ export class AmqpTrigger implements INodeType {
 				type: 'string',
 				default: '',
 				placeholder: 'topic://sourcename.something',
-				description: 'name of the queue of topic to listen to',
+				description: 'Name of the queue of topic to listen to',
 			},
 			{
 				displayName: 'Clientname',

packages/nodes-base/nodes/Box/FileDescription.ts

@@ -436,7 +436,7 @@ export const fileFields: INodeProperties[] = [
 					},
 				],
 				default: 'relevance',
-				description: 'returns the results ordered in descending order by date at which the item was last modified',
+				description: 'Returns the results ordered in descending order by date at which the item was last modified',
 			},
 			{
 				displayName: 'Trash Content',

packages/nodes-base/nodes/Box/FolderDescription.ts

@@ -388,7 +388,7 @@ export const folderFields: INodeProperties[] = [
 					},
 				],
 				default: 'relevance',
-				description: 'returns the results ordered in descending order by date at which the item was last modified',
+				description: 'Returns the results ordered in descending order by date at which the item was last modified',
 			},
 			{
 				displayName: 'Trash Content',
@@ -792,7 +792,7 @@ export const folderFields: INodeProperties[] = [
 							{
 								name: 'Company',
 								value: 'company',
-								description: 'only people within the company',
+								description: 'Only people within the company',
 							},
 							{
 								name: 'Open',

packages/nodes-base/nodes/ClickUp/TaskDescription.ts

@@ -348,7 +348,7 @@ export const taskFields: INodeProperties[] = [
 				displayName: 'Time Estimate',
 				name: 'timeEstimate',
 				type: 'number',
-				description: 'time estimate in minutes',
+				description: 'Time estimate in minutes',
 				default: 1,
 			},
 		],
@@ -483,7 +483,7 @@ export const taskFields: INodeProperties[] = [
 				displayName: 'Time Estimate',
 				name: 'timeEstimate',
 				type: 'number',
-				description: 'time estimate in minutes',
+				description: 'Time estimate in minutes',
 				default: 1,
 			},
 		],

packages/nodes-base/nodes/Freshdesk/Freshdesk.node.ts

@@ -479,7 +479,7 @@ export class Freshdesk implements INodeType {
 						name: 'tags',
 						type: 'string',
 						default: '',
-						description: 'separated by a comma (,) tags that have been associated with the ticket',
+						description: 'Separated by a comma (,) tags that have been associated with the ticket',
 					},
 					{
 						displayName: 'Type',
@@ -835,7 +835,7 @@ export class Freshdesk implements INodeType {
 						name: 'tags',
 						type: 'string',
 						default: '',
-						description: 'separated by a comma (,) tags that have been associated with the ticket',
+						description: 'Separated by a comma (,) tags that have been associated with the ticket',
 					},
 					{
 						displayName: 'Type',

packages/nodes-base/nodes/HelpScout/CustomerDescription.ts

@@ -191,14 +191,12 @@ export const customerFields: INodeProperties[] = [
 						name: 'line1',
 						type: 'string',
 						default: '',
-						description: 'line1',
 					},
 					{
 						displayName: 'Line 2',
 						name: 'line2',
 						type: 'string',
 						default: '',
-						description: 'line2',
 					},
 					{
 						displayName: 'City',

packages/nodes-base/nodes/HomeAssistant/TemplateDescription.ts

@@ -19,7 +19,7 @@ export const templateOperations: INodeProperties[] = [
 			{
 				name: 'Create',
 				value: 'create',
-				description: 'create a template',
+				description: 'Create a template',
 			},
 		],
 		default: 'create',

packages/nodes-base/nodes/Hubspot/TicketDescription.ts

@@ -173,7 +173,7 @@ export const ticketFields: INodeProperties[] = [
 				name: 'createDate',
 				type: 'dateTime',
 				default: '',
-				description: 'the date the ticket was created',
+				description: 'The date the ticket was created',
 			},
 			{
 				displayName: 'Description',

packages/nodes-base/nodes/Hunter/Hunter.node.ts

@@ -56,7 +56,7 @@ export class Hunter implements INodeType {
 					},
 				],
 				default: 'domainSearch',
-				description: 'operation to consume',
+				description: 'Operation to consume',
 			},
 			{
 				displayName: 'Domain',

packages/nodes-base/nodes/Iterable/EventDescription.ts

@@ -137,6 +137,7 @@ export const eventFields: INodeProperties[] = [
 				name: 'userId',
 				type: 'string',
 				default: '',
+				// eslint-disable-next-line n8n-nodes-base/node-param-description-lowercase-first-char
 				description: 'userId that was passed into the updateUser call',
 			},
 		],

packages/nodes-base/nodes/Jira/IssueCommentDescription.ts

@@ -67,6 +67,7 @@ export const issueCommentFields: INodeProperties[] = [
 			},
 		},
 		default: '',
+		// eslint-disable-next-line n8n-nodes-base/node-param-description-lowercase-first-char
 		description: 'issueComment Key',
 	},
 	{

packages/nodes-base/nodes/Microsoft/Teams/ChannelDescription.ts

@@ -114,7 +114,7 @@ export const channelFields: INodeProperties[] = [
 					alwaysOpenEditWindow: true,
 				},
 				default: '',
-				description: 'channel\'s description',
+				description: 'Channel\'s description',
 			},
 			{
 				displayName: 'Type',
@@ -370,7 +370,7 @@ export const channelFields: INodeProperties[] = [
 					alwaysOpenEditWindow: true,
 				},
 				default: '',
-				description: 'channel\'s description',
+				description: 'Channel\'s description',
 			},
 		],
 	},

packages/nodes-base/nodes/Notion/DatabaseDescription.ts

@@ -32,7 +32,7 @@ export const databaseOperations = [
 			{
 				name: 'Search',
 				value: 'search',
-				description: 'search databases using text search',
+				description: 'Search databases using text search',
 			},
 		],
 		default: 'get',

packages/nodes-base/nodes/Paddle/PaymentDescription.ts

@@ -140,21 +140,21 @@ export const paymentFields: INodeProperties[] = [
 				name: 'from',
 				type: 'dateTime',
 				default: '',
-				description: 'payment starting from date',
+				description: 'Payment starting from date',
 			},
 			{
 				displayName: 'Date To',
 				name: 'to',
 				type: 'dateTime',
 				default: '',
-				description: 'payment up until date',
+				description: 'Payment up until date',
 			},
 			{
 				displayName: 'Is Paid',
 				name: 'isPaid',
 				type: 'boolean',
 				default: false,
-				description: 'payment is paid',
+				description: 'Payment is paid',
 			},
 			{
 				displayName: 'Plan ID',

packages/nodes-base/nodes/PagerDuty/IncidentDescription.ts

@@ -447,7 +447,7 @@ export const incidentFields: INodeProperties[] = [
 					},
 				],
 				default: [],
-				description: 'urgencies of the incidents to be returned. Defaults to all urgencies. Account must have the urgencies ability to do this',
+				description: 'Urgencies of the incidents to be returned. Defaults to all urgencies. Account must have the urgencies ability to do this',
 			},
 			{
 				displayName: 'User IDs',

packages/nodes-base/nodes/QuickBase/RecordDescription.ts

@@ -381,7 +381,7 @@ export const recordFields: INodeProperties[] = [
 			},
 		},
 		default: '',
-		description: 'update can use the key field on the table, or any other supported unique field',
+		description: 'Update can use the key field on the table, or any other supported unique field',
 	},
 	{
 		displayName: 'Simplify',
@@ -507,7 +507,7 @@ export const recordFields: INodeProperties[] = [
 			},
 		},
 		default: '',
-		description: 'update can use the key field on the table, or any other supported unique field',
+		description: 'Update can use the key field on the table, or any other supported unique field',
 	},
 	{
 		displayName: 'Merge Field Name or ID',

packages/nodes-base/nodes/RenameKeys/RenameKeys.node.ts

@@ -61,7 +61,7 @@ export class RenameKeys implements INodeType {
 								type: 'string',
 								default: '',
 								placeholder: 'newKey',
-								description: 'the name the key should be renamed to. It is also possible to define deep keys by using dot-notation like for example: "level1.level2.newKey".',
+								description: 'The name the key should be renamed to. It is also possible to define deep keys by using dot-notation like for example: "level1.level2.newKey".',
 							},
 						],
 					},

packages/nodes-base/nodes/Salesforce/ContactDescription.ts

@@ -279,7 +279,7 @@ export const contactFields: INodeProperties[] = [
 				name: 'jigsaw',
 				type: 'string',
 				default: '',
-				description: 'references the ID of a contact in Data.com. If a contact has a value in this field, it means that a contact was imported as a contact from Data.com.',
+				description: 'References the ID of a contact in Data.com. If a contact has a value in this field, it means that a contact was imported as a contact from Data.com.',
 			},
 			{
 				displayName: 'Lead Source Name or ID',

packages/nodes-base/nodes/SentryIo/ReleaseDescription.ts

@@ -613,7 +613,7 @@ export const releaseFields: INodeProperties[] = [
 				name: 'dateReleased',
 				type: 'dateTime',
 				default: '',
-				description: 'an optional date that indicates when the release went live. If not provided the current time is assumed.',
+				description: 'An optional date that indicates when the release went live. If not provided the current time is assumed.',
 			},
 			{
 				displayName: 'Ref',

packages/nodes-base/nodes/Signl4/Signl4.node.ts

@@ -123,7 +123,7 @@ export class Signl4 implements INodeType {
 							{
 								name: 'Multi ACK',
 								value: 'multi_ack',
-								description: 'in case this alert must be confirmed by the number of people who are on duty at the time this Singl is raised',
+								description: 'In case this alert must be confirmed by the number of people who are on duty at the time this Singl is raised',
 							},
 						],
 						default: 'single_ack',

packages/nodes-base/nodes/Slack/UserProfileDescription.ts

@@ -119,21 +119,21 @@ export const userProfileFields: INodeProperties[] = [
 				name: 'status_emoji',
 				type: 'string',
 				default: '',
-				description: 'is a string referencing an emoji enabled for the Slack team, such as :mountain_railway:',
+				description: 'Is a string referencing an emoji enabled for the Slack team, such as :mountain_railway:',
 			},
 			{
 				displayName: 'Status Expiration',
 				name: 'status_expiration',
 				type: 'dateTime',
 				default: '',
-				description: 'is an integer specifying seconds since the epoch, more commonly known as "UNIX time". Providing 0 or omitting this field results in a custom status that will not expire.',
+				description: 'Is an integer specifying seconds since the epoch, more commonly known as "UNIX time". Providing 0 or omitting this field results in a custom status that will not expire.',
 			},
 			{
 				displayName: 'Status Text',
 				name: 'status_text',
 				type: 'string',
 				default: '',
-				description: 'allows up to 100 characters, though we strongly encourage brevity',
+				description: 'Allows up to 100 characters, though we strongly encourage brevity',
 			},
 			{
 				displayName: 'User ID',

packages/nodes-base/nodes/Splunk/descriptions/SearchResultDescription.ts

@@ -127,7 +127,7 @@ export const searchResultFields: INodeProperties[] = [
 							{
 								displayName: 'Value',
 								name: 'value',
-								description: 'value to match against',
+								description: 'Value to match against',
 								type: 'string',
 								default: '',
 							},

packages/nodes-base/nodes/Supabase/GenericFunctions.ts

@@ -181,12 +181,12 @@ export function getFilters(
 								{
 									name: 'LIKE operator',
 									value: 'like',
-									description: 'use * in place of %',
+									description: 'Use * in place of %',
 								},
 								{
 									name: 'ILIKE operator',
 									value: 'ilike',
-									description: 'use * in place of %',
+									description: 'Use * in place of %',
 								},
 								{
 									name: 'Is',

packages/nodes-base/nodes/SyncroMSP/v1/actions/customer/getAll/description.ts

@@ -105,7 +105,7 @@ export const customerGetAllDescription: CustomerProperties = [
 				type: 'string',
 				default: '',
 				placeholder: 'firstname ASC',
-				description: 'customer field to order by, eg: "firstname ASC", "city DESC" etc',
+				description: 'Customer field to order by, eg: "firstname ASC", "city DESC" etc',
 			},
 		],
 	},

packages/nodes-base/nodes/TheHive/descriptions/AlertDescription.ts

@@ -357,7 +357,7 @@ export const alertFields: INodeProperties[] = [
 				],
 			},
 		},
-		description: 'if true, the alert becomes active when updated default=true',
+		description: 'If true, the alert becomes active when updated default=true',
 	},
 	{
 		displayName: 'Artifacts',
@@ -751,7 +751,7 @@ export const alertFields: INodeProperties[] = [
 				name: 'follow',
 				type: 'boolean',
 				default: true,
-				description: 'if true, the alert becomes active when updated default=true',
+				description: 'If true, the alert becomes active when updated default=true',
 			},
 			{
 				displayName: 'Severity',
@@ -930,7 +930,7 @@ export const alertFields: INodeProperties[] = [
 				name: 'follow',
 				type: 'boolean',
 				default: false,
-				description: 'if true, the alert becomes active when updated default=true',
+				description: 'If true, the alert becomes active when updated default=true',
 			},
 			{
 				displayName: 'Severity',

packages/nodes-base/nodes/TheHive/descriptions/ObservableDescription.ts

@@ -470,7 +470,7 @@ export const observableFields: INodeProperties[] = [
 			{
 				displayName: 'Sighted',
 				name: 'sighted',
-				description: 'sighted previously',
+				description: 'Sighted previously',
 				type: 'boolean',
 				default: false,
 			},