From 9e573a932f91a052c11db51adde546b886043daa Mon Sep 17 00:00:00 2001 From: Ben Beltran Date: Wed, 9 Nov 2016 22:21:36 -0600 Subject: Add basic package.json --- package.json | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 package.json (limited to 'package.json') diff --git a/package.json b/package.json new file mode 100644 index 0000000..c922b56 --- /dev/null +++ b/package.json @@ -0,0 +1,28 @@ +{ + "name": "heart", + "version": "0.0.0", + "description": "The heart", + "main": "index.js", + "scripts": { + "lint": "eslint .", + "document": "jsdoc ." + "test": "echo \"Error: no test specified\" && exit 1" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/rbdr/heart.git" + }, + "author": "Rubén Beltrán del Río ", + "license": "MIT", + "bugs": { + "url": "https://github.com/rbdr/heart/issues" + }, + "homepage": "https://github.com/rbdr/heart#readme", + "devDependencies": { + "docdash": "^0.4.0", + "eslint": "^3.9.1", + "eslint-config-hapi": "^10.0.0", + "eslint-plugin-hapi": "^4.0.0", + "jsdoc": "^3.4.3" + } +} -- cgit From 6d2907fa68138d48a343200d10b6a400a2055566 Mon Sep 17 00:00:00 2001 From: Ben Beltran Date: Wed, 9 Nov 2016 22:23:58 -0600 Subject: Configure jsdoc + fix package.json --- .gitignore | 3 +++ config/jsdoc.json | 9 +++++++++ package.json | 2 +- 3 files changed, 13 insertions(+), 1 deletion(-) create mode 100644 config/jsdoc.json (limited to 'package.json') diff --git a/.gitignore b/.gitignore index 5148e52..88d9795 100644 --- a/.gitignore +++ b/.gitignore @@ -35,3 +35,6 @@ jspm_packages # Optional REPL history .node_repl_history + +# Documentation +doc diff --git a/config/jsdoc.json b/config/jsdoc.json new file mode 100644 index 0000000..9e05753 --- /dev/null +++ b/config/jsdoc.json @@ -0,0 +1,9 @@ +{ + "plugins": ["plugins/markdown"], + "opts": { + "destination": "doc", + "readme": "README.md", + "template": "node_modules/docdash", + "recurse": true + } +} diff --git a/package.json b/package.json index c922b56..e9e53a6 100644 --- a/package.json +++ b/package.json @@ -5,7 +5,7 @@ "main": "index.js", "scripts": { "lint": "eslint .", - "document": "jsdoc ." + "document": "jsdoc ./js -c config/jsdoc.json", "test": "echo \"Error: no test specified\" && exit 1" }, "repository": { -- cgit From 0e4a069f3faaa736089b9857dd249aacd863fa44 Mon Sep 17 00:00:00 2001 From: Ben Beltran Date: Wed, 9 Nov 2016 23:51:37 -0600 Subject: Make empty test pass --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'package.json') diff --git a/package.json b/package.json index e9e53a6..0c8fc9e 100644 --- a/package.json +++ b/package.json @@ -6,7 +6,7 @@ "scripts": { "lint": "eslint .", "document": "jsdoc ./js -c config/jsdoc.json", - "test": "echo \"Error: no test specified\" && exit 1" + "test": "echo \"No tests yet, just linting.\"" }, "repository": { "type": "git", -- cgit