dojo / dojo/examples

Examples require CLI to be installed globally

Open
#334 0 comments 1 reaction 0 assignees View on GitHub
Dominant language
TypeScript
Stars
76
Forks
61
PR merge metrics
No merged PRs in 30d

Description

## Problem
The example READMEs are currently written with the expectation that `@dojo/cil` is installed globally. Some of the READMEs explicitly state this and others don't. Some of the READMEs say to run an npm script such as `npm run dev` without a dev dependency on the CLI and without instructions on installing the CLI.

## Recommendation
Update the examples to include npm scripts for the primary run commands and add the CLI as a dev dependency. If additional CLI commands are referenced, instructions should be given for how to install the CLI.

## Alternate Recommendation
Update all the READMEs to explicitly state that the CLI is required and add install instructions.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.