sourcejs/Source

Move HTML parsing module from core to plugin

Open

#187 opened on Oct 4, 2015

View on GitHub
 (2 comments) (0 reactions) (1 assignee)JavaScript (552 stars) (49 forks)batch import
help wantedplugins

Description

In 0.4.0 SourceJS got a HTML API and parsing module, that allowed to automatically cache all code examples in API storage (using phantomjs script). This was specifically done to support tools like Lego, as a showcase of what components library could give to your team.

Since Lego was just proof of concept, HTML parsing feature is not required in core, especially because it's fetching heavy dependencies like PhantomJS, we decided to move this feature to separate plugin.

If you wan't to use Lego, or similar tools, you'll be able to use it the same way as in 0.4.x and 0.5.x through plugin. HTML Sync action from navigation menu in Specs will be also moved to plugin, so if you want to use Clarify with cached examples, plugin will solve the need.

Contributor guide

Tech stack
javascript
Domain
frontend
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.
half day
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.
mostly clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
25
Research direction
This issue involves moving the HTML parsing module from the core of SourceJS to a separate plugin. The module currently depends on PhantomJS and is used for caching code examples in the API storage. To proceed, investigate the core structure to locate the HTML parsing code and understand the existing plugin system. Check if the assignee has any ongoing work or if the issue is still open for contribution. Consider how the HTML Sync action from the navigation menu will be migrated as well.