Jiri Sifalda jsifalda

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.

Possible solutions

Description

This simple script will take a picture of a whiteboard and use parts of the ImageMagick library with sane defaults to clean it up tremendously.

The script is here:

#!/bin/bash
convert "$1" -morphology Convolve DoG:15,100,0 -negate -normalize -blur 0x1 -channel RBG -level 60%,91%,0.1 "$2"

Results

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.

Code is clean if it can be understood easily – by everyone on the team. Clean code can be read and enhanced by a developer other than its original author. With understandability comes readability, changeability, extensibility and maintainability.

General rules

Follow standard conventions.
Keep it simple stupid. Simpler is always better. Reduce complexity as much as possible.
Boy scout rule. Leave the campground cleaner than you found it.
Always find root cause. Always look for the root cause of a problem.

	<?php

	class AdminerColors
	{

	function head()
	{
	static $colors = array(
	'127.0.0.1' => '#ED1C24',
	'localhost' => '#009245',

	➜ receipts php run.php
	Tesseract Open Source OCR Engine v3.02.02 with Leptonica
	EEE!

	BILLA, SPOL. S R.U., MODLETICE 67
	251 01 ŘÍČANY U PRAHY
	FIL. PRAHA 2, KARLOVO NAMESTI
	DIC:CZ00685976 IČ:00B85976
	WWW.BILLA.CZ

	//sample entry file
	require('./node_modules/riot/dist/riot.js');
	require('./timer.tag')
	require('./todo.tag')
	require('./todo.css')


	riot.mount('todo', {
	title: 'I want to behave!',
	items: [

	/* bling.js */
	window.$ = document.querySelector.bind(document);
	window.$$ = document.querySelectorAll.bind(document);
	Node.prototype.on = window.on = function(name, fn) { this.addEventListener(name, fn); };
	NodeList.prototype.__proto__ = Array.prototype;
	NodeList.prototype.on = function(name, fn) { this.forEach((elem) => elem.on(name, fn)); };

	// ------------
	// counterStore.js
	// ------------

	import {
	INCREMENT_COUNTER,
	DECREMENT_COUNTER
	} from '../constants/ActionTypes';

	const initialState = { counter: 0 };

	import * as React from 'react';
	import { Component } from 'react';

	export default function HOCBaseRender<Props, State, ComponentState>(
	Comp: new() => Component<Props & State, ComponentState>) {
	return class HOCBase extends Component<Props, State> {
	render() {
	return <Comp {...this.props} {...this.state}/>;
	}
	}