newts

NEWTS

literally: "new ts"

Bootstraps a TypeScript npm module project

Why?

Because I'm making enough of them that:

• I see a pattern
• I'm tired of manually repeating that pattern

Why not just a yeoman (or other) generator?

I wanted full control over the pipeline and newts doesn't just dump out some pre-formatted files -- it:

• gives you some choices (eg licensing)
• verifies that the new project name you chose is available at npmjs.com
• actually runs npm install and git init (where appropriate)

Status

• try npx newts --help for all options
• easiest use: npx newts
  • will run interactive
• specify some options and add --interactive,
  • eg npx newts --output /path/to/code --interactive
    • sets output and prompts for other config
• also simple: npx newts --defaults
  • will ask for a project name
  • may ask for an output folder (if the current one is under git control)
  • will run with defaults:
    • initialize git
      • with relevant .gitignore
    • dev-packages
      • typescript
      • jest
      • faker
      • npm-run-all
      • tslint (for now, until eslint behaves as expected)
      • zarro (for build)
      • relevant @types packages
    • tsconfig.json
      • outputs to dist
      • includes types
    • tslint.json
    • license: BSD-3-Clause
    • skeleton README.md
    • package.json
      • scripts
        • build
        • release
        • release-beta
        • lint
      • author info (according to git)
      • set up files from dist folder
      • set version to 0.0.1

Show me!

TODO

• create a target repo at GitHub on request
• add a GitHub workflow to automatically test when you push
• ??? make a request on the Issues Page