Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 1 addition & 5 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,7 @@ jobs:
- env:
GITHUB_TOKEN: ${{ secrets.ACCESS_TOKEN }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
run: |
git config --global user.email "[email protected]"
git config --global user.name "Josh Goldberg"
npm config set //registry.npmjs.org/:_authToken $NPM_TOKEN
- run: npx release-it --preRelease=beta
uses: JoshuaKGoldberg/[email protected]

name: Release

Expand Down
14 changes: 5 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,6 @@ It includes options not just for building and testing but also automated release

## Usage

> **Note:** create-typescript-app is preparing to promote the 2.0 beta version to stable soon.
> The repository's `main` branch shows commands for the `beta` version.
> The published package's 1.x versions still show commands for the 1.x version.

First make sure you have the following installed:

- [Node.js](https://nodejs.org)
Expand All @@ -38,14 +34,14 @@ First make sure you have the following installed:
Then in an existing repository or in your directory where you'd like to make a new repository:

```shell
npx create-typescript-app@beta
npx create-typescript-app
```

You can read more about the supported setup modes in their docs pages:
You can read more about the supported runtime modes in their docs pages:

- [**Creating from the terminal**](./docs/Creation.md): creating a new repository locally on the command-line _(recommended)_
- [**Initializing from the template**](./docs/Initialization.md): creating a new repository with the [_Use this template_](https://github.com/JoshuaKGoldberg/create-typescript-app/generate) button on GitHub
- [**Migrating an existing repository**](./docs/Migration.md): adding this template's tooling on top of an existing repository
- [**Setting up from the terminal**](./docs/Setup.md): creating a new repository locally on the command-line _(recommended)_
- [**Transitioning an existing repository**](./docs/Transition.md): adding this template's tooling on top of an existing repository
- [**Using the template repository**](./docs/UseThisTemplate.md): creating a new repository with the [_Use this template_](https://github.com/JoshuaKGoldberg/create-typescript-app/generate) button on GitHub

## Documentation

Expand Down
10 changes: 5 additions & 5 deletions docs/Options.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
`create-typescript-app` is built on top of [Bingo](https://create.bingo).
It supports all the flags supported by [Bingo CLIs](https://www.create.bingo/cli).

`npx create-typescript-app@beta` provides three `--preset` options:
`npx create-typescript-app` provides three `--preset` options:

1. **Minimal**: Just bare starter tooling: building, formatting, linting, and type checking.
2. **Common**: Bare starters plus testing and automation for all-contributors and releases.
Expand All @@ -12,7 +12,7 @@ It supports all the flags supported by [Bingo CLIs](https://www.create.bingo/cli
For example, to create a new repository with the _Everything_ preset:

```shell
npx create-typescript-app@beta --preset everything
npx create-typescript-app --preset everything
```

`create-typescript-app` itself adds in two sections of flags:
Expand All @@ -35,7 +35,7 @@ Each will be prompted for when creating a new repository if not explicitly provi
For example, pre-populating all required base options:

```shell
npx create-typescript-app@beta --directory my-typescript-app --description "My awesome TypeScript app! 💖" --preset everything
npx create-typescript-app --directory my-typescript-app --description "My awesome TypeScript app! 💖" --preset everything
```

That script will run completely autonomously, no prompted inputs required. ✨
Expand All @@ -58,7 +58,7 @@ They will be inferred from the running user, and if migrating an existing reposi
For example, customizing the npm author and funding source:

```shell
npx create-typescript-app@beta --author my-npm-username --funding MyGitHubOrganization
npx create-typescript-app --author my-npm-username --funding MyGitHubOrganization
```

## Block Exclusions
Expand All @@ -67,7 +67,7 @@ Per [Bingo > Stratum > Configurations > `blocks`](https://www.create.bingo/engin
For example, initializing with all tooling except for Renovate:

```shell
npx create-typescript-app@beta --exclude-renovate
npx create-typescript-app --exclude-renovate
```

See [Blocks.md](./Blocks.md) for the list of blocks and their corresponding presets.
10 changes: 5 additions & 5 deletions docs/Creation.md → docs/Setup.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Creating from the Terminal
# Setup Mode

You can run `npx create-typescript-app@beta` in your terminal to interactively create a new repository:
You can run `npx create-typescript-app` in your terminal to interactively create a new repository:

```shell
npx create-typescript-app@beta
npx create-typescript-app
```

The creation script will by default:
The setup script will by default:

1. Prompt you for a directory, which template preset to run with, and some starting information
2. Initialize new directory as a local Git repository
Expand Down Expand Up @@ -34,7 +34,7 @@ See [Options.md](./Options.md).
For example, skipping the _"This package was templated with..."_ block:

```shell
npx create-typescript-app@beta --mode create --exclude-templated-with
npx create-typescript-app --mode create --exclude-templated-with
```

See [Blocks.md](./Blocks.md) for details on the tooling pieces and which presets they're included in.
10 changes: 5 additions & 5 deletions docs/Migration.md → docs/Transition.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Migrating an Existing Repository
# Transition Mode

If you have an existing repository that you'd like to give the files from this repository, you can run `npx create-typescript-app@beta` in it to "migrate" its tooling to this template's.
If you have an existing repository that you'd like to migrate to the files from this template, you can run `npx create-typescript-app` in it to "migrate" its tooling to this template's.

```shell
npx create-typescript-app@beta
npx create-typescript-app
```

The migration script will:
The transition script will:

- Uninstall any known old packages that conflict with this template's tooling
- Delete configuration files used with those old packages
Expand Down Expand Up @@ -46,7 +46,7 @@ See [Options.md](./Options.md).
For example, skipping the _"This package was templated with..."_ block:

```shell
npx create-typescript-app@beta --exclude-templated-with
npx create-typescript-app --exclude-templated-with
```

See [Blocks.md](./Blocks.md) for details on the tooling pieces and which presets they're included in.
8 changes: 4 additions & 4 deletions docs/Initialization.md → docs/UseThisTemplate.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Initializing from the Template
# Using the Template Repository

As an alternative to [creating with `npx create-typescript-app@beta`](./Creation.md), the [_Use this template_](https://github.com/JoshuaKGoldberg/create-typescript-app/generate) button on GitHub can be used to quickly create a new repository from the template.
As an alternative to [creating with `npx create-typescript-app`](./Setup.md), the [_Use this template_](https://github.com/JoshuaKGoldberg/create-typescript-app/generate) button on GitHub can be used to quickly create a new repository from the template.
You can set up the new repository locally by cloning it and installing packages:

```shell
git clone https://github.com/YourUsername/YourRepositoryName
cd YourRepositoryName
npx create-typescript-app@beta
npx create-typescript-app
```

You'll then need to manually go through the following two steps to set up tooling on GitHub:
Expand All @@ -29,7 +29,7 @@ See [Options.md](./Options.md).
For example, skipping the _"This package was templated with..."_ block:

```shell
npx create-typescript-app@beta --exclude-templated-with
npx create-typescript-app --exclude-templated-with
```

See [Blocks.md](./Blocks.md) for details on the tooling pieces and which presets they're included in.
16 changes: 8 additions & 8 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "create-typescript-app",
"version": "2.0.0-beta.27",
"version": "2.0.0",
"description": "Quickstart-friendly TypeScript template with comprehensive, configurable, opinionated tooling. 🎁",
"repository": {
"type": "git",
Expand Down Expand Up @@ -37,18 +37,18 @@
"*": "prettier --ignore-unknown --write"
},
"dependencies": {
"bingo": "^0.5.3",
"bingo-fs": "^0.5.3",
"bingo": "^0.5.4",
"bingo-fs": "^0.5.4",
"bingo-stratum": "^0.5.4",
"cspell-populate-words": "^0.3.0",
"execa": "^9.5.2",
"git-remote-origin-url": "^4.0.0",
"git-url-parse": "^16.0.1",
"html-to-text": "^9.0.5",
"image-size": "^1.2.0",
"input-from-file": "^0.5.3",
"input-from-file-json": "^0.5.3",
"input-from-script": "^0.5.3",
"input-from-file": "^0.5.4",
"input-from-file-json": "^0.5.4",
"input-from-script": "^0.5.4",
"js-yaml": "^4.1.0",
"lazy-value": "^3.0.0",
"lodash": "^4.17.21",
Expand Down Expand Up @@ -78,8 +78,8 @@
"@vitest/coverage-v8": "3.0.7",
"@vitest/eslint-plugin": "1.1.36",
"all-contributors-cli": "6.26.1",
"bingo-stratum-testers": "0.5.3",
"bingo-testers": "0.5.3",
"bingo-stratum-testers": "0.5.4",
"bingo-testers": "0.5.4",
"console-fail-test": "0.5.0",
"cspell": "8.17.5",
"eslint": "9.21.0",
Expand Down
Loading