ballercat/walt

CLI 'wrap' command needs to build smaller files.

Open

#164 opened on Oct 14, 2018

View on GitHub
 (1 comment) (0 reactions) (0 assignees)JavaScript (4,637 stars) (155 forks)batch import
good first issuehelp wanted

Description

Problem

walt-cli package when linking multiple .walt files together can "wrap" the modules in a stand-alone JS module. The resulting module is too large because it serialized the dependency tree with the AST information encoded directly into the output, resulting in a massive amount of js.

Encoding the dependencies into the file is done to ensure the module can be used stand-alone in browser or node. Only the opcodes objects should be necessary for each module.

Goal

Patch the cli wrap function to result in a stripped down version of the modules (without AST information) which can still build but only include the bare minimum buffers in the resulting JS module.

Notes

Contributor guide

Tech stack
javascriptnodejs
Domain
clitooling
Issue type
feature
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-3 hours
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
Familiarity with Walt CLIUnderstanding of AST structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
Examine the wrap logic in packages/walt cli/src/wrap.js to understand how it serializes the dependency tree. Identify the non opcode AST information that is unnecessarily included. Modify the serialization to only include the opcodes for each module. Test that the standalone module can still be built using the build method in packages/walt buildtools/src/index.js. Review the existing comments on the issue for any maintainer guidance.