jpillora/xhook

Refactor: Remove CoffeeScript, Cleanup resulting JavaScript

Open

#38 opened on Nov 29, 2015

View on GitHub
 (1 comment) (2 reactions) (0 assignees)HTML (866 stars) (154 forks)batch import
enhancementhelp wanted

Description

Things we need to do to ensure this transition will go on smoothly as possible with no breaking changes:

  • Refactor to ES6
  • Choose a new build system
  • Refactor to separate modules instead of 1 large file with everything
  • Convert all existing test cases to actual tests #32
  • Make sure all test cases pass on all supported browsers
  • Confirm there are no breaking changes

Contributor guide

Tech stack
javascript
Domain
frontendbuild systemdeveloper experience
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
ES6 experiencebuild system knowledgeCoffeeScript familiarity
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
25
Research direction
Examine the existing CoffeeScript files in the repository to understand the xhook library's functionality. Identify all .coffee files and plan a conversion to ES6 JavaScript. Research modern build systems (e.g., Webpack, Rollup) suitable for a browser library. Also review the existing test cases (if any) to ensure they are converted along with the code. The goal is to produce a clean ES6 module structure without breaking the existing API.