Skip to content

Latest commit

 

History

History
112 lines (102 loc) · 2.97 KB

community-package-json-description-still-default.md

File metadata and controls

112 lines (102 loc) · 2.97 KB
Raw

community-package-json-description-still-default

The description value in the package.json of a community package must be different from the default value '' (empty string) or a user-defined default.

📋 This rule is part of the plugin:n8n-nodes-base/community config.

Examples

❌ Example of incorrect code:

{
	"name": "n8n-nodes-<...>",
	"version": "0.1.1",
	"description": "",
	"license": "MIT",
	"author": {
		"name": "John Smith",
		"email": "[email protected]"
	},
	"repository": {
		"type": "git",
		"url": "git+https://github.com/johnsmith/n8n-nodes-service.git"
	},
	"keywords": ["n8n-community-node-package"],
	"main": "index.js",
	"scripts": {
		"dev": "npm run watch",
		"build": "tsc && gulp",
		"lint": "tslint -p tsconfig.json -c tslint.json && node_modules/eslint/bin/eslint.js ./nodes",
		"lintfix": "tslint --fix -p tsconfig.json -c tslint.json && node_modules/eslint/bin/eslint.js --fix ./nodes",
		"watch": "tsc --watch",
		"test": "jest"
	},
	"files": ["dist"],
	"n8n": {
		"credentials": ["dist/credentials/ServiceApi.credentials.js"],
		"nodes": ["dist/nodes/Service/Service.node.js"]
	},
	"devDependencies": {
		"@types/express": "^4.17.6",
		"@types/request-promise-native": "~1.0.15",
		"@typescript-eslint/parser": "^5.29.0",
		"eslint-plugin-n8n-nodes-base": "^1.0.43",
		"gulp": "^4.0.2",
		"jest": "^26.4.2",
		"n8n-workflow": "~0.104.0",
		"ts-jest": "^26.3.0",
		"tslint": "^6.1.2",
		"typescript": "~4.3.5"
	},
	"dependencies": {
		"n8n-core": "~0.101.0"
	}
}

✅ Example of correct code:

{
	"name": "n8n-nodes-service",
	"version": "0.1.1",
	"description": "Consumes Service API",
	"license": "MIT",
	"author": {
		"name": "John Smith",
		"email": "[email protected]"
	},
	"repository": {
		"type": "git",
		"url": "git+https://github.com/johnsmith/n8n-nodes-service.git"
	},
	"keywords": ["n8n-community-node-package"],
	"main": "index.js",
	"scripts": {
		"dev": "npm run watch",
		"build": "tsc && gulp",
		"lint": "tslint -p tsconfig.json -c tslint.json && node_modules/eslint/bin/eslint.js ./nodes",
		"lintfix": "tslint --fix -p tsconfig.json -c tslint.json && node_modules/eslint/bin/eslint.js --fix ./nodes",
		"watch": "tsc --watch",
		"test": "jest"
	},
	"files": ["dist"],
	"n8n": {
		"credentials": ["dist/credentials/ServiceApi.credentials.js"],
		"nodes": ["dist/nodes/Service/Service.node.js"]
	},
	"devDependencies": {
		"@types/express": "^4.17.6",
		"@types/request-promise-native": "~1.0.15",
		"@typescript-eslint/parser": "^5.29.0",
		"eslint-plugin-n8n-nodes-base": "^1.0.43",
		"gulp": "^4.0.2",
		"jest": "^26.4.2",
		"n8n-workflow": "~0.104.0",
		"ts-jest": "^26.3.0",
		"tslint": "^6.1.2",
		"typescript": "~4.3.5"
	},
	"dependencies": {
		"n8n-core": "~0.101.0"
	}
}

Links