elldritch / elldritch/broccoli-pug

Specify which files to process, versus which are only for inclusion

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

Nobody has claimed this yet.

Dominant language
CoffeeScript
Stars
0
Forks
2
PR merge metrics
No merged PRs in 30d

Description

This plug-in requires (as described in the readme) that all the files it includes are included in the input tree. I believe that is a very correct design for a broccoli plug-in, thank you.

However, it runs straight into a problem: it means that all of my additional pug files which exist only so that they may be included in other pug files, are caught in the plug-ins attempt to compile all pug files. I don't want those inclusion files compiled, and in fact in some cases they are unable to compile since they don't have some variable passed by a "root" pug file.

I don't see any way to fix this from the outside. It's not clear with the proper design would be to accommodate this. Perhaps relaxing the requirement that all files (root and include) arrive via a single tree? The plug-in could take one tree for the files to compile, and the second tree of files available for inclusion but not themselves directly compiled.

Contributor guide

No contributing guide indexed for this repository

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 the README's description of the input-tree requirement and trace how the plug-in distinguishes files to compile from files available for inclusion. Compare the requested separate treatment of root and include Pug files with the current behavior. Done means the project has an agreed, documented design for selecting compilable files without breaking included templates.

Written by the indexing model from the issue text.

Assessment

Tech stack
coffeescript, pug
Domain
build-system
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.