# mattdesl/module-best-practices

:books: some best practices for JS modules

Repository: https://github.com/mattdesl/module-best-practices
Canonical: https://ross.abutalabs.com/products/module-best-practices
Language: JavaScript
License Family: other
Last push: 2018-03-30T15:58:34+00:00

## Health v2 (maintenance only)
Score: 32/100 (v2, computed 2026-09-02T17:46:02.011165+00:00)
- activity 0, release rhythm 35, longevity 100
- inputs: {"age_days": 4340, "days_push": 3078, "days_rel": null, "gap_med": null, "n_releases_24m": 0}
- flags: no_releases, no_license
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 1543, forks 89 (observed 2026-08-28T04:05:01.265407+00:00)

## What it is
A written guide of best practices for authoring small, focused JavaScript modules for npm (CommonJS, front- and back-end). It covers naming conventions, API design, testing, versioning, and packaging conventions.

## Use cases
- how to structure a new npm module
- naming conventions for javascript packages
- best practices for writing small focused node modules
- how to design a module api
- npm package publishing checklist
- when to prefer dependencies over writing utilities

## When to choose
- you are publishing a new npm package and want conventions for naming, API design, and packaging
- you are transitioning from large frameworks to small composable modules
- you want a concise style guide for CommonJS module authorship

## When to avoid
- you need up-to-date guidance covering ESM, modern tooling, or TypeScript
- you need an executable tool or linter rather than prose advice
- you need framework-specific best practices

## Facets
- artifact type: learning-resource
- maturity: abandoned
- function: documentation, developer-tools
- domain: developer-tools, programming-languages, tutorials, web-development
- platform: -
- tags: npm-modules, best-practices, guide, commonjs, module-design, nodejs, javascript

## Member repositories
- mattdesl/module-best-practices (main) score 32

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:05:01.265407+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-30T04:30:41.884873+00:00, confidence not recorded.
  - readme: https://github.com/mattdesl/module-best-practices (fetched 2026-08-28T04:05:01.265407+00:00, sha a5f27b6445da)
  - registry_npm: https://registry.npmjs.org/module-best-practices (fetched 2026-08-29T11:32:06.080130+00:00, sha fb41e626c50b)
- Data as of 2026-08-30T08:39:29.467469+00:00.