add inline documentation with jsdoc

.eslintignore

@@ -1,3 +1,4 @@
 node_modules
 coverage
+docs
 /dist

.gitignore

@@ -1,5 +1,6 @@
 node_modules
 npm-debug.log*
+docs
 coverage
 .nyc_output
 /dist

.npmignore

@@ -1,5 +1,6 @@
 node_modules
 npm-debug.log*
+docs
 coverage
 .nyc_output
 .babelrc

jsdoc.json

@@ -0,0 +1,24 @@
+{
+	"plugins": [],
+	"recurseDepth": 10,
+	"source": {
+		"include": [
+			"./src"
+		],
+		"includePattern": ".+\\.js(doc|x)?$"
+	},
+	"sourceType": "module",
+	"tags": {
+		"allowUnknownTags": true,
+		"dictionaries": ["jsdoc", "closure"]
+	},
+	"templates": {
+		"cleverLinks": false,
+		"monospaceLinks": false
+	},
+	"opts": {
+		"encoding": "utf8",
+		"destination": "./docs",
+		"recurse": true
+	}
+}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elvoline/twig",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "twig.js renderer for elvoline",
   "module": "dist/es.js",
   "main": "dist/index.js",
@@ -16,7 +16,8 @@
     "posttest": "npm run coverage",
     "coverage": "nyc report --reporter=lcov",
     "codecov": "codecov",
-    "prepublish": "npm run build"
+    "prepublish": "npm run build",
+    "docs": "jsdoc -c jsdoc.json"
   },
   "author": "Elvoline S.à r.l.",
   "license": "ISC",
@@ -43,6 +44,7 @@
     "cross-env": "^5.1.1",
     "eslint": "^4.12.0",
     "jquery": "^3.2.1",
+    "jsdoc": "^3.5.5",
     "jsdom": "^11.5.1",
     "lodash": "^4.17.4",
     "mocha": "^5.0.0",

readme.md

@@ -7,7 +7,13 @@
 
 This is a Twig.js renderer customized for use on Elvoline.
 
-Added features include an always-on promise support, deferred template parsing, global variables, automatic DOM creation and i18n.
+Added features are:
+
+* always-on promise support
+* deferred template parsing
+* global variables
+* automatic DOM creation
+* i18n
 
 # Docs
 

rollup.config.js

@@ -31,6 +31,7 @@ export default [
 	getConfig({
 		'file': 'dist/index.js',
 		'format': 'cjs',
+		'exports': 'named',
 	}),
 	getConfig({
 		'file': 'dist/es.js',

src/globals.js

@@ -1,11 +1,32 @@
+/**
+ * Global variables module.
+ * @module
+ */
+
+/**
+ * Global variables to be added to render data.
+ * @type {Object}
+ */
+
 var globals = {};
+export default globals;
+
+/**
+ * Adds a new global variable.
+ * @param {string} - variable name
+ * @param {*} - variable value
+ * @return {*} The given variable value.
+ */
 
 export function addGlobal (key, value) {
 	return globals[key] = value;
 }
 
+/**
+ * Getter for the globals object.
+ * @return {Object} The globals object.
+ */
+
 export function getGlobals () {
 	return globals;
 }
-
-export default globals;

src/jsdoc.js

@@ -0,0 +1,13 @@
+/**
+ * Represents the eventual result of an asynchronous operation.
+ * @external Promise
+ * @global
+ * @see {@link https://promisesaplus.com/}
+ */
+
+/**
+ * jQuery instance.
+ * @external jQuery
+ * @global
+ * @see {@link http://api.jquery.com/}
+ */