create-typescript-thing

Create Typescript Thing

Create a typescript project with formatting, linting, testing, debugging, git and publishing in under 2 minutes.

The interactive setup will lead you through the process of picking a name, creating a github repository, and setting up a project.

Quick overview

npx create-typescript-thing
# Interactive setup
cd your-new-project
yarn start

Philosophy

• No magic single dependency: Create typescript thing just creates config files for you. After creating your project you will not have to use create-typescript-thing again.

• Reducing complexity: The created projects try to be as default as possible. Additional complexity is only added when it is needed to add simplicity somewhere else.
• Opinionated: This project is opinionated. It is opinionated about what tools to use, and how to use them. The choices are for the most part based on what is mainstream.
• Creating familiar environments: You can use this to create many different types of projects that all feel similar to work with. The folder structure should be familiar, the linting and formatting should be familiar, the testing should be familiar, how debugging works should be familiar and so on.
• Ask only necessary questions: The interactive setup will ask you only the questions that are necessary to create your project. It will not ask you questions about things that can be guessed or inferred.

What's included

• TypeScript
• Prettier
• ESLint
• Jest
• husky/lint-staged
• vscode presets
• nix shell

Features that you maybe don't expect

• Import things relative to the source directory. No more ../../../ in your imports. Just do import { thing } from 'foo' to import from src/foo.ts.
• Unused imports are removed automatically.
• Cli applications get bundled using ncc.

Some other things that belong in another section

This repo is only the interactive setup. If you want to use the setup directly from javascript, have a look at create-typescript-thing-lib.

Debugging is done via the vscode debugger. You can debug your tests with the vscode jest extension.