Timo Kissing tkissing

Directory structure for JavaScript/Node Projects

While the following structure is not an absolute requirement or enforced by the tools, it is a recommendation based mostly on what the JavaScript and in particular Node community at large have been following by convention.

Beyond a suggested structure, no tooling recommendations, or sub-module structure is outlined here.

Directories

src/ is for the code you write manually independent of the module format
lib/ is for modules compiled from src/ into a format compatible with standard require in the node versions indicated by engines in your package.json (UMD, CommonJS)
dist/ is for modules or scripts compiled from src/ into formats not compatible with standard require in the node versions indicated by engines in your package.json (AMD, browser globals/IIFE)

	function A() {
	function privateA() {}
	function privateB() {}

	function publicA() {
	// now this.publicB() here, just publicB() - safes typing and even if someone overrides publicB we still use the implementation from here
	// of course that latter might not be desired, in which case you'd write this.publicB() here
	return publicB() ? privateA() : privateB();
	}
	this.publicA = publicA;

	<!DOCTYPE html>
	<html lang="en">
	<head>
	<meta charset="utf-8">
	<title>Hello World</title>
	</head>
	<body>
	Hello World
	</body>
	</html>

	// using AMD syntax here to avoid confusion about scope and file boundaries,
	// but the concept translates 1:1 to CommonJS (node/io) modules

	define('badSingleton', function(require, exports, module) {
	var dependency = require('dependency');

	var privateState;

	module.exports = {
	foo: function() {

	function startInterval(func, freq) {
	var id = setInterval(func, freq);
	return function() {
	if (id) {
	clearInterval(id);
	id = null;
	return true;
	}
	return false;
	}

	(function() {
	p = Promise.resolve(3);

	p.then(function() { throw Error('e'); }, console.warn.bind(console, 'You will not see this one'));
	p.then(function() { throw Error('e'); }).then(null, console.warn.bind(console, 'You will see this one'));
	}());

	cat node_modules/chai-as-promised/package.json \| grep version
	"version": "4.3.2",

	define(function(require) {
	var ko = require('knockout');

	function observeEvent(pubsub, options) {
	var o = ko.observable();

	Object.keys(options).forEach(function(evt) {
	var value = options[evt];

	pubsub.on(evt, function() {

	// promise code
	function add5 (x) {
	return x + 5
	}

	function add5Promise (x) {
	return Promise.resolve(x).then(function (x) {
	return add5(x)
	})
	}

	new Promise((resolve, reject) => {
	resolve(someArr.map(e => {
	if (e.foo) {
	reject(Error('Found a foo!'));
	// the .map will continue to loop
	// even resolve will still be called although it won't have any more effect
	}
	return e.bar;
	}));
	});