sourcejs/Source

SourceJS CLI

Open

#144 opened on May 16, 2015

View on GitHub
 (3 comments) (0 reactions) (0 assignees)JavaScript (552 stars) (49 forks)batch import
good first contributionhelp wantednew feature

Description

Create a helper CLI tools, for managing SourceJS installation as an npm package.

Proposed commands

  • sourcejs run - searches sourcejs in current projects node_modules and runs the engine. Could be used for running regular setup within configured Style Guide platform, or light setup, when SourceJS is used to describe one standalone component (or bundle)
  • sourcejs install - installs sourcejs plugin
  • sourcejs list - lists available sourcejs plugins
  • sourcejs init - init new user folder config
  • sourcejs generate - generate specs and plugins

Essential requirement for CLI is the ability to install SourceJS as npm package (dependency), which will be partly supported in 0.5.3 and will get official support in 0.6.0.

Contributor guide

Tech stack
javascriptnodejs
Domain
clitoolingdeveloper experience
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-2 days
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
Node.jsnpmCLI development basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
The issue proposes a CLI tool for SourceJS with four commands (run, install, list, init, generate). The repository description indicates it's on hold, and the issue has been open since 2015 with no recent activity. First time contributors should verify maintainer interest and check if the project is still maintained. Look at the repository's current state and any recent commits or issues to determine if this feature is still desired. The CLI commands are clearly specified, but implementation details such as command structure and integration with npm package installation require additional research.