max-mapper / max-mapper/requirebin

Feature proposal: "preferTransform" option in package.json

Open
#48 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
389
Forks
73
PR merge metrics
No merged PRs in 30d

Description

I am thinking about what it would take to make glslify work reliably in requirebin. Ideally I would like to be able to write shaders and inline them without having to manually add glslify as a transform in the package.json. To do this though, it seems that when a user types require("glslify") into requirebin, requirebin needs to be smart enough to figure out that it should install and apply glslify as a transform.

Related to this how to figure out which dependencies are required by glslify, which I don't really have any great ideas for yet.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with package.json and the require("glslify") flow in requirebin. Investigate how transforms are currently selected and how dependencies are discovered. The work is complete when the expected preferTransform behavior, including installing and applying glslify and handling its dependencies, is defined and implemented.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.