👕 Apply node-param-description-comma-separated-hyphen (#3190)

.eslintrc.js

@@ -385,6 +385,7 @@ module.exports = {
 				"n8n-nodes-base/node-param-collection-type-unsorted-items": "error",
 				"n8n-nodes-base/node-param-default-wrong-for-fixed-collection": "error",
 				"n8n-nodes-base/node-param-default-wrong-for-multi-options": "error",
+				"n8n-nodes-base/node-param-description-comma-separated-hyphen": "error",
 				"n8n-nodes-base/node-param-default-wrong-for-simplify": "error",
 			 }
 		},

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

@@ -433,7 +433,7 @@ export class Airtable implements INodeType {
 							},
 						},
 						default: '',
-						description: 'Comma separated list of fields to ignore.',
+						description: 'Comma-separated list of fields to ignore.',
 					},
 					{
 						displayName: 'Typecast',

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

@@ -327,7 +327,7 @@ export const fileFields: INodeProperties[] = [
 				name: 'contet_types',
 				type: 'string',
 				default: '',
-				description: `Limits search results to items with the given content types. Content types are defined as a comma separated lists of Box recognized content types.`,
+				description: 'Limits search results to items with the given content types. Content types are defined as a comma-separated lists of Box recognized content types.',
 			},
 			{
 				displayName: 'Created At Range',
@@ -396,7 +396,7 @@ export const fileFields: INodeProperties[] = [
 				name: 'ancestor_folder_ids',
 				type: 'string',
 				default: '',
-				description: `Limits search results to items within the given list of folders. Folders are defined as a comma separated lists of folder IDs.`,
+				description: 'Limits search results to items within the given list of folders. Folders are defined as a comma-separated lists of folder IDs.',
 			},
 			{
 				displayName: 'Scope',
@@ -421,7 +421,7 @@ export const fileFields: INodeProperties[] = [
 				type: 'string',
 				default: '',
 				placeholder: '1000000,5000000',
-				description: `Limits search results to items within a given file size range. File size ranges are defined as comma separated byte sizes.`,
+				description: 'Limits search results to items within a given file size range. File size ranges are defined as comma-separated byte sizes.',
 			},
 			{
 				displayName: 'Sort',
@@ -492,7 +492,7 @@ export const fileFields: INodeProperties[] = [
 				name: 'owner_user_ids',
 				type: 'string',
 				default: '',
-				description: `Limits search results to items owned by the given list of owners. Owners are defined as a comma separated list of user IDs.`,
+				description: 'Limits search results to items owned by the given list of owners. Owners are defined as a comma-separated list of user IDs.',
 			},
 		],
 	},

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

@@ -279,7 +279,7 @@ export const folderFields: INodeProperties[] = [
 				name: 'contet_types',
 				type: 'string',
 				default: '',
-				description: `Limits search results to items with the given content types. Content types are defined as a comma separated lists of Box recognized content types.`,
+				description: 'Limits search results to items with the given content types. Content types are defined as a comma-separated lists of Box recognized content types.',
 			},
 			{
 				displayName: 'Created At Range',
@@ -348,7 +348,7 @@ export const folderFields: INodeProperties[] = [
 				name: 'ancestor_folder_ids',
 				type: 'string',
 				default: '',
-				description: `Limits search results to items within the given list of folders. Folders are defined as a comma separated lists of folder IDs.`,
+				description: 'Limits search results to items within the given list of folders. Folders are defined as a comma-separated lists of folder IDs.',
 			},
 			{
 				displayName: 'Scope',
@@ -373,7 +373,7 @@ export const folderFields: INodeProperties[] = [
 				type: 'string',
 				default: '',
 				placeholder: '1000000,5000000',
-				description: `Limits search results to items within a given file size range. File size ranges are defined as comma separated byte sizes.`,
+				description: 'Limits search results to items within a given file size range. File size ranges are defined as comma-separated byte sizes.',
 			},
 			{
 				displayName: 'Sort',
@@ -444,7 +444,7 @@ export const folderFields: INodeProperties[] = [
 				name: 'owner_user_ids',
 				type: 'string',
 				default: '',
-				description: `Limits search results to items owned by the given list of owners. Owners are defined as a comma separated list of user IDs.`,
+				description: 'Limits search results to items owned by the given list of owners. Owners are defined as a comma-separated list of user IDs.',
 			},
 		],
 	},

packages/nodes-base/nodes/Cockpit/CollectionDescription.ts

@@ -122,7 +122,7 @@ export const collectionFields: INodeProperties[] = [
 					alwaysOpenEditWindow: true,
 				},
 				placeholder: '_id,name',
-				description: 'Comma separated list of fields to get.',
+				description: 'Comma-separated list of fields to get.',
 			},
 			{
 				displayName: 'Filter Query',

packages/nodes-base/nodes/CoinGecko/CoinDescription.ts

@@ -275,7 +275,7 @@ export const coinFields: INodeProperties[] = [
 				],
 			},
 		},
-		description: 'The contract address of tokens, comma separated.',
+		description: 'The contract address of tokens, comma-separated.',
 	},
 	{
 		displayName: 'Base Currency',
@@ -488,7 +488,7 @@ export const coinFields: INodeProperties[] = [
 				type: 'string',
 				placeholder: 'bitcoin',
 				default: '',
-				description: 'Filter results by comma separated list of coin ID.',
+				description: 'Filter results by comma-separated list of coin ID.',
 			},
 			{
 				displayName: 'Category',

packages/nodes-base/nodes/Contentful/AssetDescription.ts

@@ -159,7 +159,7 @@ export const fields: INodeProperties[] = [
 				type: 'string',
 				placeholder: 'fields.title',
 				default: '',
-				description: 'The select operator allows you to choose what fields to return from an entity. You can choose multiple values by combining comma separated operators.',
+				description: 'The select operator allows you to choose what fields to return from an entity. You can choose multiple values by combining comma-separated operators.',
 			},
 			{
 				displayName: 'Include',

packages/nodes-base/nodes/Contentful/EntryDescription.ts

@@ -149,7 +149,7 @@ export const fields: INodeProperties[] = [
 				type: 'string',
 				placeholder: 'fields.title',
 				default: '',
-				description: 'The select operator allows you to choose what fields to return from an entity. You can choose multiple values by combining comma separated operators.',
+				description: 'The select operator allows you to choose what fields to return from an entity. You can choose multiple values by combining comma-separated operators.',
 			},
 			{
 				displayName: 'Include',

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

@@ -124,8 +124,7 @@ export class CrateDb implements INodeType {
 				},
 				default: '',
 				placeholder: 'id,name,description',
-				description:
+				description: 'Comma-separated list of the properties which should used as columns for the new rows.',
-					'Comma separated list of the properties which should used as columns for the new rows.',
 			},
 
 			// ----------------------------------
@@ -168,8 +167,7 @@ export class CrateDb implements INodeType {
 				},
 				default: 'id',
 				required: true,
-				description:
+				description: `Comma-separated list of the properties which decides which rows in the database should be updated. Normally that would be "id".`,
-					'Comma separated list of the properties which decides which rows in the database should be updated. Normally that would be "id".',
 			},
 			{
 				displayName: 'Columns',
@@ -182,8 +180,7 @@ export class CrateDb implements INodeType {
 				},
 				default: '',
 				placeholder: 'name,description',
-				description:
+				description: `Comma-separated list of the properties which should used as columns for rows to update.`,
-					'Comma separated list of the properties which should used as columns for rows to update.',
 			},
 
 			// ----------------------------------
@@ -199,7 +196,7 @@ export class CrateDb implements INodeType {
 					},
 				},
 				default: '*',
-				description: 'Comma separated list of the fields that the operation will return',
+				description: 'Comma-separated list of the fields that the operation will return',
 			},
 			// ----------------------------------
 			//         additional fields
@@ -243,7 +240,7 @@ export class CrateDb implements INodeType {
 						},
 						default: '',
 						placeholder: 'quantity,price',
-						description: 'Comma separated list of properties which should be used as query parameters.',
+						description: 'Comma-separated list of properties which should be used as query parameters.',
 					},
 				],
 			},

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

@@ -100,7 +100,7 @@ export class EmailSend implements INodeType {
 				name: 'attachments',
 				type: 'string',
 				default: '',
-				description: 'Name of the binary properties that contain data to add to email as attachment. Multiple ones can be comma separated.',
+				description: 'Name of the binary properties that contain data to add to email as attachment. Multiple ones can be comma-separated.',
 			},
 			{
 				displayName: 'Options',

packages/nodes-base/nodes/Git/descriptions/AddDescription.ts

@@ -16,7 +16,7 @@ export const addFields: INodeProperties[] = [
 		},
 		default: '',
 		placeholder: 'README.md',
-		description: 'Comma separated list of paths (absolute or relative to Repository Path) of files or folders to add.',
+		description: 'Comma-separated list of paths (absolute or relative to Repository Path) of files or folders to add.',
 		required: true,
 	},
 ];

packages/nodes-base/nodes/Git/descriptions/CommitDescription.ts

@@ -37,7 +37,7 @@ export const commitFields: INodeProperties[] = [
 				type: 'string',
 				default: '',
 				placeholder: '/data/file1.json',
-				description: `Comma separated list of paths (absolute or relative to Repository Path) of files or folders to commit. If not set will all "added" files and folders be committed.`,
+				description: 'Comma-separated list of paths (absolute or relative to Repository Path) of files or folders to commit. If not set will all "added" files and folders be committed.',
 			},
 		],
 	},

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

@@ -97,7 +97,7 @@ export class Mailgun implements INodeType {
 				name: 'attachments',
 				type: 'string',
 				default: '',
-				description: 'Name of the binary properties which contain data which should be added to email as attachment. Multiple ones can be comma separated.',
+				description: 'Name of the binary properties which contain data which should be added to email as attachment. Multiple ones can be comma-separated.',
 			},
 		],
 	};

packages/nodes-base/nodes/Microsoft/Sql/MicrosoftSql.node.ts

@@ -130,8 +130,7 @@ export class MicrosoftSql implements INodeType {
 				},
 				default: '',
 				placeholder: 'id,name,description',
-				description:
+				description: `Comma-separated list of the properties which should used as columns for the new rows.`,
-					'Comma separated list of the properties which should used as columns for the new rows.',
 			},
 
 			// ----------------------------------
@@ -175,8 +174,7 @@ export class MicrosoftSql implements INodeType {
 				},
 				default: '',
 				placeholder: 'name,description',
-				description:
+				description: `Comma-separated list of the properties which should used as columns for rows to update.`,
-					'Comma separated list of the properties which should used as columns for rows to update.',
 			},
 
 			// ----------------------------------

packages/nodes-base/nodes/MongoDb/mongo.node.options.ts

@@ -195,8 +195,7 @@ export const nodeDescription: INodeTypeDescription = {
 			},
 			default: '',
 			placeholder: 'name,description',
-			description:
+			description: `Comma-separated list of the fields to be included into the new document.`,
-				'Comma separated list of the fields to be included into the new document.',
 		},
 
 		// ----------------------------------
@@ -231,8 +230,7 @@ export const nodeDescription: INodeTypeDescription = {
 			},
 			default: '',
 			placeholder: 'name,description',
-			description:
+			description: `Comma-separated list of the fields to be included into the new document.`,
-				'Comma separated list of the fields to be included into the new document.',
 		},
 		{
 			displayName: 'Upsert',

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

@@ -111,7 +111,7 @@ export class MySql implements INodeType {
 				},
 				default: '',
 				placeholder: 'id,name,description',
-				description: 'Comma separated list of the properties which should used as columns for the new rows.',
+				description: 'Comma-separated list of the properties which should used as columns for the new rows.',
 			},
 			{
 				displayName: 'Options',
@@ -204,7 +204,7 @@ export class MySql implements INodeType {
 				},
 				default: '',
 				placeholder: 'name,description',
-				description: 'Comma separated list of the properties which should used as columns for rows to update.',
+				description: 'Comma-separated list of the properties which should used as columns for rows to update.',
 			},
 
 		],

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

@@ -3580,7 +3580,7 @@ export class Pipedrive implements INodeType {
 						name: 'exclude',
 						type: 'string',
 						default: '',
-						description: 'A comma separated Activity Ids, to exclude from result. Ex. 4, 9, 11, ...',
+						description: 'A comma-separated Activity Ids, to exclude from result. Ex. 4, 9, 11, ...',
 					},
 				],
 			},

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

@@ -117,8 +117,7 @@ export class Postgres implements INodeType {
 				},
 				default: '',
 				placeholder: 'id:int,name:text,description',
-				description:
+				description: `Comma-separated list of the properties which should used as columns for the new rows. You can use type casting with colons (:) like id:int.`,
-					'Comma separated list of the properties which should used as columns for the new rows. You can use type casting with colons (:) like id:int.',
 			},
 
 			// ----------------------------------
@@ -161,7 +160,7 @@ export class Postgres implements INodeType {
 				},
 				default: 'id',
 				required: true,
-				description: 'Comma separated list of the properties which decides which rows in the database should be updated. Normally that would be "id".',
+				description: 'Comma-separated list of the properties which decides which rows in the database should be updated. Normally that would be "id".',
 			},
 			{
 				displayName: 'Columns',
@@ -174,8 +173,7 @@ export class Postgres implements INodeType {
 				},
 				default: '',
 				placeholder: 'name:text,description',
-				description:
+				description: `Comma-separated list of the properties which should used as columns for rows to update. You can use type casting with colons (:) like id:int.`,
-					'Comma separated list of the properties which should used as columns for rows to update. You can use type casting with colons (:) like id:int.',
 			},
 
 			// ----------------------------------
@@ -191,7 +189,7 @@ export class Postgres implements INodeType {
 					},
 				},
 				default: '*',
-				description: 'Comma separated list of the fields that the operation will return',
+				description: 'Comma-separated list of the fields that the operation will return',
 			},
 			// ----------------------------------
 			//         Additional fields
@@ -240,7 +238,7 @@ export class Postgres implements INodeType {
 						},
 						default: '',
 						placeholder: 'quantity,price',
-						description: 'Comma separated list of properties which should be used as query parameters.',
+						description: 'Comma-separated list of properties which should be used as query parameters.',
 					},
 				],
 			},

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

@@ -120,8 +120,7 @@ export class QuestDb implements INodeType {
 				},
 				default: '',
 				placeholder: 'id,name,description',
-				description:
+				description: `Comma-separated list of the properties which should used as columns for the new rows.`,
-					'Comma separated list of the properties which should used as columns for the new rows.',
 			},
 			{
 				displayName: 'Return Fields',
@@ -133,7 +132,7 @@ export class QuestDb implements INodeType {
 					},
 				},
 				default: '*',
-				description: 'Comma separated list of the fields that the operation will return',
+				description: 'Comma-separated list of the fields that the operation will return',
 			},
 			// ----------------------------------
 			//         additional fields
@@ -184,7 +183,7 @@ export class QuestDb implements INodeType {
 						},
 						default: '',
 						placeholder: 'quantity,price',
-						description: 'Comma separated list of properties which should be used as query parameters.',
+						description: 'Comma-separated list of properties which should be used as query parameters.',
 					},
 				],
 			},

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

@@ -85,7 +85,7 @@ export const recordFields: INodeProperties[] = [
 		default: '',
 		required: true,
 		placeholder: 'Select Fields...',
-		description: 'Comma separated list of the properties which should used as columns for the new rows.',
+		description: 'Comma-separated list of the properties which should used as columns for the new rows.',
 	},
 	{
 		displayName: 'Simplify Response',
@@ -363,7 +363,7 @@ export const recordFields: INodeProperties[] = [
 		default: '',
 		required: true,
 		placeholder: 'id,name,description',
-		description: 'Comma separated list of the properties which should used as columns for the new rows.',
+		description: 'Comma-separated list of the properties which should used as columns for the new rows.',
 	},
 	{
 		displayName: 'Update Key',
@@ -488,7 +488,7 @@ export const recordFields: INodeProperties[] = [
 		default: '',
 		required: true,
 		placeholder: 'id,name,description',
-		description: 'Comma separated list of the properties which should used as columns for the new rows.',
+		description: 'Comma-separated list of the properties which should used as columns for the new rows.',
 	},
 	{
 		displayName: 'Update Key',

packages/nodes-base/nodes/Salesmate/ActivityDescription.ts

@@ -427,7 +427,7 @@ export const activityFields: INodeProperties[] = [
 				name: 'fields',
 				type: 'string',
 				default: '',
-				description: 'Comma separated list of fields to return.',
+				description: 'Comma-separated list of fields to return.',
 			},
 			{
 				displayName: 'Sort By',

packages/nodes-base/nodes/Salesmate/CompanyDescription.ts

@@ -520,7 +520,7 @@ export const companyFields: INodeProperties[] = [
 				name: 'fields',
 				type: 'string',
 				default: '',
-				description: 'Comma separated list of fields to return.',
+				description: 'Comma-separated list of fields to return.',
 			},
 			{
 				displayName: 'Sort By',

packages/nodes-base/nodes/Salesmate/DealDescription.ts

@@ -691,7 +691,7 @@ export const dealFields: INodeProperties[] = [
 				name: 'fields',
 				type: 'string',
 				default: '',
-				description: 'Comma separated list of fields to return.',
+				description: 'Comma-separated list of fields to return.',
 			},
 			{
 				displayName: 'Sort By',

packages/nodes-base/nodes/SecurityScorecard/descriptions/CompanyDescription.ts

@@ -180,7 +180,7 @@ export const companyFields: INodeProperties[] = [
 			},
 			{
 				displayName: 'Severity In',
-				description: 'Filter issues by comma separated severity list',
+				description: 'Filter issues by comma-separated severity list',
 				name: 'severity_in',
 				type: 'string',
 				default: '',

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

@@ -94,7 +94,7 @@ export const userGroupFields: INodeProperties[] = [
 					loadOptionsMethod: 'getChannels',
 				},
 				default: [],
-				description: 'A comma separated string of encoded channel IDs for which the User Group uses as a default.',
+				description: 'A comma-separated string of encoded channel IDs for which the User Group uses as a default.',
 			},
 			{
 				displayName: 'Description',
@@ -343,7 +343,7 @@ export const userGroupFields: INodeProperties[] = [
 					loadOptionsMethod: 'getChannels',
 				},
 				default: [],
-				description: 'A comma separated string of encoded channel IDs for which the User Group uses as a default.',
+				description: 'A comma-separated string of encoded channel IDs for which the User Group uses as a default.',
 			},
 			{
 				displayName: 'Description',

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

@@ -118,7 +118,7 @@ export class Snowflake implements INodeType {
 				},
 				default: '',
 				placeholder: 'id,name,description',
-				description: 'Comma separated list of the properties which should used as columns for the new rows.',
+				description: 'Comma-separated list of the properties which should used as columns for the new rows.',
 			},
 
 
@@ -168,7 +168,7 @@ export class Snowflake implements INodeType {
 				},
 				default: '',
 				placeholder: 'name,description',
-				description: 'Comma separated list of the properties which should used as columns for rows to update.',
+				description: 'Comma-separated list of the properties which should used as columns for rows to update.',
 			},
 
 		],

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

@@ -181,7 +181,7 @@ export class Stackby implements INodeType {
 				default: '',
 				required: true,
 				placeholder: 'id,name,description',
-				description: 'Comma separated list of the properties which should used as columns for the new rows.',
+				description: 'Comma-separated list of the properties which should used as columns for the new rows.',
 			},
 		],
 	};

packages/nodes-base/nodes/Strapi/EntryDescription.ts

@@ -85,7 +85,7 @@ export const entryFields: INodeProperties[] = [
 		},
 		default: '',
 		placeholder: 'id,name,description',
-		description: 'Comma separated list of the properties which should used as columns for the new rows',
+		description: 'Comma-separated list of the properties which should used as columns for the new rows',
 	},
 
 	/* -------------------------------------------------------------------------- */
@@ -344,6 +344,6 @@ export const entryFields: INodeProperties[] = [
 		},
 		default: '',
 		placeholder: 'id,name,description',
-		description: 'Comma separated list of the properties which should used as columns for the new rows',
+		description: 'Comma-separated list of the properties which should used as columns for the new rows',
 	},
 ];

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

@@ -130,8 +130,7 @@ export class TimescaleDb implements INodeType {
 				},
 				default: '',
 				placeholder: 'id,name,description',
-				description:
+				description: `Comma-separated list of the properties which should used as columns for the new rows.`,
-					'Comma separated list of the properties which should used as columns for the new rows.',
 			},
 
 			// ----------------------------------
@@ -196,8 +195,7 @@ export class TimescaleDb implements INodeType {
 				},
 				default: '',
 				placeholder: 'name,description',
-				description:
+				description: 'Comma-separated list of the properties which should used as columns for rows to update.',
-					'Comma separated list of the properties which should used as columns for rows to update.',
 			},
 			// ----------------------------------
 			//         insert,update
@@ -212,7 +210,7 @@ export class TimescaleDb implements INodeType {
 					},
 				},
 				default: '*',
-				description: 'Comma separated list of the fields that the operation will return',
+				description: 'Comma-separated list of the fields that the operation will return',
 			},
 			// ----------------------------------
 			//         additional fields
@@ -261,7 +259,7 @@ export class TimescaleDb implements INodeType {
 						},
 						default: '',
 						placeholder: 'quantity,price',
-						description: 'Comma separated list of properties which should be used as query parameters.',
+						description: 'Comma-separated list of properties which should be used as query parameters.',
 					},
 				],
 			},

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

@@ -379,7 +379,7 @@ export class Todoist implements INodeType {
 						name: 'ids',
 						type: 'string',
 						default: '',
-						description: 'A list of the task IDs to retrieve, this should be a comma separated list.',
+						description: 'A list of the task IDs to retrieve, this should be a comma-separated list.',
 					},
 					{
 						displayName: 'Label ID',

packages/nodes-base/nodes/Twitter/TweetDescription.ts

@@ -93,7 +93,7 @@ export const tweetFields: INodeProperties[] = [
 				name: 'attachments',
 				type: 'string',
 				default: 'data',
-				description: 'Name of the binary properties which contain data which should be added to tweet as attachment. Multiple ones can be comma separated.',
+				description: 'Name of the binary properties which contain data which should be added to tweet as attachment. Multiple ones can be comma-separated.',
 			},
 			{
 				displayName: 'Display Coordinates',

packages/nodes-base/nodes/Zulip/MessageDescription.ts

@@ -73,7 +73,7 @@ export const messageFields: INodeProperties[] = [
 				],
 			},
 		},
-		description: 'The destination stream, or a comma separated list containing the usernames (emails) of the recipients.',
+		description: 'The destination stream, or a comma-separated list containing the usernames (emails) of the recipients.',
 	},
 	{
 		displayName: 'Content',
@@ -118,7 +118,7 @@ export const messageFields: INodeProperties[] = [
 				],
 			},
 		},
-		description: 'The destination stream, or a comma separated list containing the usernames (emails) of the recipients.',
+		description: 'The destination stream, or a comma-separated list containing the usernames (emails) of the recipients.',
 	},
 	{
 		displayName: 'Topic',