trivago/melody

Export only ES modules

Open

#89 opened on Jan 13, 2019

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)JavaScript (37 forks)auto 404
good first issue

Repository metrics

Stars
 (216 stars)
PR merge metrics
 (PR metrics pending)

Description

By now ES modules are a well supported standard and can be used by the browser as well as Webpack, Rollup and other bundlers. Melody itself doesn't benefit from being exported as CJS.

We can simplify our tooling and avoid mistakes for our users by switching to ES modules and ignoring the CJS use case.

This is a breaking change.

Contributor guide

Research direction
Investigate the current CJS exports, then configure the build system (e.g., Babel, Webpack) to output only ES modules. Update package.json 'type' field and ensure all imports/exports use ESM syntax. Remove CJS specific files and update documentation.
Tech stack
javascript
Domain
build system
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScriptNode.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40