Stevie Huh stephenhuh

Folder Structure

Please note

While this gist has been shared and followed for years, I regret not giving more background. It was originally a gist for the engineering org I was in, not a "general suggestion" for any React app.

Typically I avoid folders altogether. Heck, I even avoid new files. If I can build an app with one 2000 line file I will. New files and folders are a pain.

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 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

lib/ is intended for code that can run as-is
src/ is intended for code that needs to be manipulated before it can be used

OBSOLETE

This entire guide is based on an old version of Homebrew/Node and no longer applies. It was only ever intended to fix a specific error message which has since been fixed. I've kept it here for historical purposes, but it should no longer be used. Homebrew maintainers have fixed things and the options mentioned don't exist and won't work.

I still believe it is better to manually install npm separately since having a generic package manager maintain another package manager is a bad idea, but the instructions below don't explain how to do that.

Fixing npm On Mac OS X for Homebrew Users

Installing node through Homebrew can cause problems with npm for globally installed packages. To fix it quickly, use the solution below. An explanation is also included at the end of this document.

A lot of these are outright stolen from Edward O'Campo-Gooding's list of questions. I really like his list.

I'm having some trouble paring this down to a manageable list of questions -- I realistically want to know all of these things before starting to work at a company, but it's a lot to ask all at once. My current game plan is to pick 6 before an interview and ask those.

I'd love comments and suggestions about any of these.

I've found questions like "do you have smart people? Can I learn a lot at your company?" to be basically totally useless -- everybody will say "yeah, definitely!" and it's hard to learn anything from them. So I'm trying to make all of these questions pretty concrete -- if a team doesn't have an issue tracker, they don't have an issue tracker.

I'm also mostly not asking about principles, but the way things are -- not "do you think code review is important?", but "Does all code get reviewed?".

Better local require() paths for Node.js

Problem

When the directory structure of your Node.js application (not library!) has some depth, you end up with a lot of annoying relative paths in your require calls like:

const Article = require('../../../../app/models/article');

Those suck for maintenance and they're ugly.

	doctype html5
	html
	head
	title Test Page

	body
	.error #{message}
	form(action='/login' method='POST')
	label Email
	input(type='email' name='email')

	'use strict';

	// simple express server
	var express = require('express');
	var app = express();
	var router = express.Router();

	app.use(express.static('public'));
	app.get('/', function(req, res) {
	res.sendfile('./public/index.html');

	/**
	* World's simplest express server
	* - used to serve index.html from /public
	*/

	var express = require('express');
	var serveStatic = require('serve-static');
	var app = express();

	app.use(serveStatic(__dirname + '/public'));

	var DIR = '/tmp/test',
	FILE_PATTERN = /test/,
	fs = require('q-io/fs');

	fs.list(DIR)
	.then(function (files) {
	var matched = files.filter(function (item) {
	return item.match(FILE_PATTERN);
	});
	if (matched.length !== 1) {

	{-# LANGUAGE TemplateHaskell #-}

	import Control.Lens

	data Point = Point {
	_x :: Double,
	_y :: Double
	} deriving (Show)

	data Mario = Mario { _location :: Point } deriving (Show)