alexjoverm/typescript-library-starter

Suggestion: separated starter script form codebase

Open

#135 opened on Nov 24, 2017

View on GitHub
 (4 comments) (1 reaction) (0 assignees)TypeScript (4,362 stars) (481 forks)user submission
enhancementhelp wanted

Description

Initially based on the script you have that runs after installing the dependencies, I've created a script that simplifies the process in only one step (it clones the repo and runs the script) and has also the benefit of being outside the codebase.

You can run the script with:

npx github:gimenete/create-typescript-library <dirname>

Repo here: https://github.com/gimenete/create-typescript-library

Besides the library name it also asks for a few other things:

  • What do you want the library to be called?
  • Is this a web app or a Node.js app? Node.js / Webapp
  • Is this a library? Standalone application? Yes / No
  • Do you want to use travis? Yes / No
  • Do you want to use commitizen? Yes / No

Maybe we can remove the embedded script you have in the project and promote using this one. My suggestion is to put this script in your repo in a different branch. Then it will be run like this:

npx github:alexjoverm/typescript-library-starter#script <dirname>

Where script is the branch name.

Contributor guide

Tech stack
typescriptnodejs
Domain
toolingdeveloper 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-3 hours
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.
mostly clear
Prerequisites
basic knowledge of TypeScript library starterunderstanding of npx and GitHub branches
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
The issue suggests replacing the existing starter script with an external one run via npx. Review the current script in the repository (likely in a 'scripts' directory) and compare it with the external script at https://github.com/gimenete/create typescript library. Check the comments for any maintainer feedback or concerns. Evaluate the impact on the project's workflow and whether this change aligns with the starter's goals.