Question 1

How do I make a JavaScript module work in both Node.js and the browser?

Accepted Answer

The guide recommends writing environment-agnostic code by avoiding DOM-specific dependencies and using CommonJS patterns. For browser-specific builds, it suggests using the 'browser' field in package.json or tools like browserify for UMD bundles, but cautions against bloating the module with unnecessary builds.

Question 2

What's the best way to name an npm package for discoverability?

Accepted Answer

Use lower-case, dash-separated names that are clear and descriptive, like 'point-in-circle' instead of vague terms. Add relevant keywords and a concise description in package.json to improve searchability on npm and Google, as outlined in the discoverability section.

Question 3

How to avoid global state in JavaScript modules?

Accepted Answer

Avoid static fields or singletons; instead, pass configuration via options objects or use closures to encapsulate state. For example, use instance members like 'maxChunk' in an options object rather than modifying global properties, ensuring modules don't interfere with each other.

Question 4

module-best-practices guide vs airbnb/javascript style guide?

Accepted Answer

This guide focuses specifically on module authoring for npm, covering design, dependencies, and ecosystem practices, while Airbnb's style guide is broader, covering general JavaScript coding conventions. Choose this if you need targeted advice on building reusable packages; use Airbnb's for overall code style and linting rules.

Question 5

What tools are recommended for testing small JavaScript modules?

Accepted Answer

The guide suggests using tape for simplicity and integrates with tools like budo or smokestack for browser testing. It also recommends adding tests as devDependencies and using npm scripts for task running, but notes that these are older tools and might need adaptation for modern setups.

Question 6

Is it better to have many small modules or a few large ones?

Accepted Answer

The guide strongly advocates for small, focused modules that do one thing well, promoting reusability and easier maintenance. However, it acknowledges that over-splitting can lead to dependency management overhead, so balance is key based on the project's scope and composition needs.

module-best-practices

What is module-best-practices?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions