jakerella / jakerella/booker

Add CLI script with parameters

Open
#2 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
CSS
Stars
23
Forks
0
PR merge metrics
No merged PRs in 30d

Description

While having this repo as a GH template is good for some use cases, at other times people might have an existing repo that they want to set up to use the Booker generation tools. To do this, we need a CLI script that has sufficient parameters that someone could use to generate the outputs from any source location (including CSS files, etc).

I'm thinking the options for the CLI command would allow for some basic inputs on the command line itself, but generally favor an option/input of a config file that a consumer would use to specify where everything is located in the repo. Doing this should also enable the tool's use in a CI pipeline.

Note that in this case, we should ensure this repo/tool can be pulled into a consuming repo via some dependency tooling... like via a known package manager. There needs to be a post-install script to install dependencies, which are not so easy because they aren't in a package manager like npm (pandoc and wkhtmltopdf). Of course, installing those requires knowledge of the target architecture to either pull the correct pre-built binary or to build from source.

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

The issue names no existing files, tests, or entry points. Start by mapping the current Booker generation flow and defining the CLI, config-file, consuming-repository, and dependency-installation requirements; done means generation works from arbitrary source locations and can run in CI.

Written by the indexing model from the issue text.

Assessment

Tech stack
css, markdown
Domain
build-system, ci-cd, cli
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.