+## Getting Started
+
+First make sure you have the following installed:
+
+- [GitHub CLI](https://cli.github.com) _(you'll need to be logged in)_
+- [Node.js](https://nodejs.org)
+- [pnpm](https://pnpm.io)
+
+This repository comes with two scripts to set up an existing or new repository with tooling.
+Use the corresponding docs page to get started:
+
+- [Initializing from the template](./docs/Initialization.md): creating a new repository with the [_Use this template_](https://github.com/JoshuaKGoldberg/template-typescript-node-package/generate) button on GitHub
+- [Migrating an existing repository](./docs/Migration.md): adding this template's tooling on top of an existing repository
+
## Explainer
-This template is available for anybody who wants to set up a basic Node application using TypeScript.
+This template is available for anybody who wants to set up a Node application using TypeScript.
It sets up the following tooling for you:
- [**All Contributors**](https://allcontributors.org): Tracks various kinds of contributions and displays them in a nicely formatted table in the README.md.
@@ -44,112 +58,6 @@ It sets up the following tooling for you:
- [**TypeScript**](https://typescriptlang.org): A typed superset of JavaScript, configured with strict compiler options.
- [**Vitest**](https://vitest.dev): Fast unit tests, configured with coverage tracking and [console-fail-test](https://github.com/JoshuaKGoldberg/console-fail-test).
-## Setup
-
-This package comes with a bootstrap/initialization setup script that fills out your repository's details, installs necessary packages, then removes itself and uninstalls setup dependencies.
-
-First make sure you have the following installed:
-
-- [GitHub CLI](https://cli.github.com) _(you'll need to be logged in)_
-- [Node.js](https://nodejs.org)
-- [pnpm](https://pnpm.io)
-
-To use this template:
-
-1. Click the [_Use this template_](https://github.com/JoshuaKGoldberg/template-typescript-node-package/generate) button to create a new repository with the same Git history
-2. Open that repository, such as by [cloning it locally](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) or [developing in a codespace](https://docs.github.com/en/codespaces/developing-in-codespaces/developing-in-a-codespace)
-3. Create two tokens in [repository secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets):
- - `ACCESS_TOKEN`: A [GitHub PAT](https://github.com/settings/tokens/new) with _repo_ and _workflow_ permissions
- - `NPM_TOKEN`: An [npm access token](https://docs.npmjs.com/creating-and-viewing-access-tokens/) with _Automation_ permissions
-4. `pnpm install`
-5. `pnpm run setup` to run the setup script
-6. Install the [Codecov GitHub App](https://github.com/marketplace/codecov) and [Renovate GitHub App](https://github.com/marketplace/renovate)
-
-> The setup script removes the `## Explainer`, `## Setup`, and `## Repository Hydration` sections from this README.md.
-
-### Setup Options
-
-The setup script requires four options to fill out repository details.
-It will interactively prompt for any that are not provided as a string CLI flag:
-
-1. `repository`: The kebab-case name of the repository (e.g. `template-typescript-node-package`)
-2. `title`: Title Case title for the repository to be used in documentation (e.g. `Template TypeScript Node Package`)
-3. `owner`: GitHub organization or user the repository is underneath (e.g. `JoshuaKGoldberg`)
-4. `description`: Sentence case description of the repository (e.g. `A quickstart-friendly TypeScript package with lots of great repository tooling. ✨`)
-
-Additionally, a `--skip-api` boolean CLI flag may be specified to prevent the setup script from calling to GitHub APIs for repository hydration.
-The script normally posts to GitHub APIs to set information such as repository description and branch protections on github.com.
-Specifying `--skip-api` prevents those API calls, effectively limiting setup changes to local files in Git.
-Doing so can be useful to preview what running setup does.
-
-For example, pre-populating all values and skipping API calls:
-
-```shell
-pnpm run setup --repository "testing-repository" --title "Testing Title" --owner "TestingOwner" --description "Test Description" --skip-api
-```
-
-> Tip: after running `pnpm run setup` with `--skip-api`, you can always `git add -A; git reset --hard HEAD` to completely reset all changes.
-
-## Repository Hydration
-
-> **Warning**
-> Hydration will override many files in your repository.
-> You'll want to review each of the changes and make sure nothing important is removed.
-
-Alternately, if you have an existing repository that you'd like to give the files from this repository, you can run `template-typescript-node-package` in a repository to "hydrate" it.
-
-```shell
-npx template-typescript-node-package
-```
-
-Repository settings will be auto-filled from the repository's files if possible, but can be provided manually as well:
-
-- `author` _(`string`)_: e.g. `"Josh Goldberg"`
-- `description` _(`string`)_: e.g. `"A quickstart-friendly TypeScript template with comprehensive formatting, linting, releases, testing, and other great tooling built-in. ✨"`
-- `email` _(`string`)_: e.g. `"git@joshuakgoldberg.com"`
-- `funding` _(`string`, optional)_: e.g. `"JoshuaKGoldberg"`
-- `owner` _(`string`)_: e.g. `"JoshuaKGoldberg"`
-- `repository` _(`string`)_: e.g. `"template-typescript-node-package"`
-- `title` _(`string`)_: e.g. `"Template TypeScript Node Package"`
-
-For example, providing a `funding` value different from the `author`:
-
-```shell
-npx template-typescript-node-package --funding MyOrganization
-```
-
-The hydration script by default will include all the features in this template.
-You can disable some of them on the command-line:
-
-- `releases` _(`boolean`)_: Whether to include automated package publishing
-- `unitTests` _(`boolean`)_: Whether to include unit tests with code coverage tracking
-
-```shell
-npx template-typescript-node-package --releases false --unitTests false
-```
-
-You can prevent the hydration script from making network-based changes using either or both of the following CLI flags:
-
-- `--skip-contributors` _(`boolean`)_: Skips detecting existing contributors with [`all-contributors-for-repository`](https://github.com/JoshuaKGoldberg/all-contributors-for-repository)
-- `--skip-install` _(`boolean`)_: Skips installing all the new template packages with `pnpm`
-- `--skip-setup` _(`boolean`)_: Skips running the setup script at the end of hydration
-
-```shell
-npx template-typescript-node-package --skip-install --skip-setup
-```
-
-## Usage
-
-```shell
-npm i template-typescript-node-package
-```
-
-```ts
-import { greet } from "template-typescript-node-package";
-
-greet("Hello, world!");
-```
-
## Development
See [`.github/CONTRIBUTING.md`](./.github/CONTRIBUTING.md), then [`.github/DEVELOPMENT.md`](./.github/DEVELOPMENT.md).
diff --git a/bin/hydrate.js b/bin/hydrate.js
deleted file mode 100644
index 7331e50d2..000000000
--- a/bin/hydrate.js
+++ /dev/null
@@ -1,4 +0,0 @@
-#!/usr/bin/env node
-import { hydrate } from "../lib/hydrate/index.js";
-
-process.exitCode = await hydrate(process.argv.slice(2));
diff --git a/bin/migrate.js b/bin/migrate.js
new file mode 100755
index 000000000..4b4ec80b9
--- /dev/null
+++ b/bin/migrate.js
@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+import { migrate } from "../lib/migrate/index.js";
+
+process.exitCode = await migrate(process.argv.slice(2));
diff --git a/docs/FAQs.md b/docs/FAQs.md
new file mode 100644
index 000000000..ddfa62ea2
--- /dev/null
+++ b/docs/FAQs.md
@@ -0,0 +1,22 @@
+# FAQs
+
+## Can I use <insert tool here> with this template?
+
+Yes!
+After you set up a repository, you can substitute in any tools you'd like.
+
+If you think the tool would be broadly useful to most consumers of this template, feel free to [file a feature request](https://github.com/JoshuaKGoldberg/template-typescript-node-package/issues/new?assignees=&labels=type%3A+feature&projects=&template=03-feature.yml&title=%F0%9F%9A%80+Feature%3A+%3Cshort+description+of+the+feature%3E) to add it in.
+
+## Is there a way to pull in template updates to previously created repositories?
+
+Not yet.
+You can always copy & paste them in manually.
+
+See [🚀 Feature: Add a script to sync the tooling updates from forked template repo #498](https://github.com/JoshuaKGoldberg/template-typescript-node-package/issues/498): it will likely eventually be possible.
+
+## Why does this package include so many tools?
+
+This repository is meant to serve as a starter that includes all the general tooling a modern TypeScript/Node repository could possibly need.
+Each of the included tools exists for a good reason and provides real value.
+
+If you don't want to use any particular tool, you can always remove it manually.
diff --git a/docs/Initialization.md b/docs/Initialization.md
new file mode 100644
index 000000000..a8a2d839a
--- /dev/null
+++ b/docs/Initialization.md
@@ -0,0 +1,58 @@
+# Initializing from the Template
+
+The [_Use this template_](https://github.com/JoshuaKGoldberg/template-typescript-node-package/generate) button on GitHub can be used to quickly create a new repository.
+After creating the new repository, you can set it up locally by cloning it and installing packages:
+
+```shell
+git clone https://github.com/YourUsername/YourRepositoryName
+cd YourRepositoryName
+pnpm i
+```
+
+> 💡 If you don't want to `git clone` it locally, you can always [develop in a codespace](https://docs.github.com/en/codespaces/developing-in-codespaces/developing-in-a-codespace) instead.
+
+## The Initialization Script
+
+Once the repository's packages are installed, you can run `pnpm run initialize` to fill out your repository's details and install necessary packages.
+It will then remove itself and uninstall dependencies only used for initialization.
+
+```shell
+pnpm run initialize
+```
+
+The initialization script will interactively prompt for values to be used in creating the new repository.
+Each may provided as a string CLI flag as well:
+
+- `--description`: Sentence case description of the repository (e.g. `A quickstart-friendly TypeScript package with lots of great repository tooling. ✨`)
+- `--owner`: GitHub organization or user the repository is underneath (e.g. `JoshuaKGoldberg`)
+- `--repository`: The kebab-case name of the repository (e.g. `template-typescript-node-package`)
+- `--title`: Title Case title for the repository to be used in documentation (e.g. `Template TypeScript Node Package`)
+
+For example, pre-populating all values:
+
+```shell
+pnpm run initialize --repository "testing-repository" --title "Testing Title" --owner "TestingOwner" --description "Test Description"
+```
+
+Then, go through the following two steps to set up required repository tooling on GitHub:
+
+1. Create two tokens in [repository secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets):
+ - `ACCESS_TOKEN`: A [GitHub PAT](https://github.com/settings/tokens/new) with _repo_ and _workflow_ permissions
+ - `NPM_TOKEN`: An [npm access token](https://docs.npmjs.com/creating-and-viewing-access-tokens/) with _Automation_ permissions
+2. Install the [Codecov GitHub App](https://github.com/marketplace/codecov) and [Renovate GitHub App](https://github.com/marketplace/renovate)
+
+At this point, your new repository should be ready for development! 🥳
+
+### Skipping API Calls
+
+The initialization script normally posts to GitHub APIs to set repository information such as repository description and branch protections on github.com.
+You can skip those API calls by specifying `--skip-github-api`.
+
+For example, pre-populating all values and skipping API calls:
+
+```shell
+pnpm run initialize --repository "testing-repository" --title "Testing Title" --owner "TestingOwner" --description "Test Description" --skip-github-api
+```
+
+> Tip: the `--skip-github-api` flag will cause all changes to be limited to your local repository.
+> That means you can test out the script with `pnpm run initialize --skip-github-api`, then `git add -A; git reset --hard HEAD` to completely reset all changes.
diff --git a/docs/Migration.md b/docs/Migration.md
new file mode 100644
index 000000000..8d7628de4
--- /dev/null
+++ b/docs/Migration.md
@@ -0,0 +1,59 @@
+# Migrating an Existing Repository
+
+If you have an existing repository that you'd like to give the files from this repository, you can run `npx template-typescript-node-package` in it to "hydrate" its tooling with this template's.
+
+```shell
+npx template-typescript-node-package
+```
+
+> **Warning**
+> Migration will override many files in your repository.
+> You'll want to review each of the changes.
+> There will almost certainly be some incorrect changes you'll need to fix.
+
+## Values
+
+Repository settings will be auto-filled from the repository's files if possible, but can be provided manually as well:
+
+- `--author` _(`string`)_: e.g. `"Josh Goldberg"`
+- `--description` _(`string`)_: e.g. `"A quickstart-friendly TypeScript template with comprehensive formatting, linting, releases, testing, and other great tooling built-in. ✨"`
+- `--email` _(`string`)_: e.g. `"git@joshuakgoldberg.com"`
+- `--funding` _(`string`, optional)_: e.g. `"JoshuaKGoldberg"`
+- `--owner` _(`string`)_: e.g. `"JoshuaKGoldberg"`
+- `--repository` _(`string`)_: e.g. `"template-typescript-node-package"`
+- `--title` _(`string`)_: e.g. `"Template TypeScript Node Package"`
+
+For example, providing a `funding` value different from the `author`:
+
+```shell
+npx template-typescript-node-package --funding MyOrganization
+```
+
+The migration script by default will include all the features in this template.
+You can disable some of them on the command-line:
+
+- `releases` _(`boolean`)_: Whether to include automated package publishing
+- `unitTests` _(`boolean`)_: Whether to include unit tests with code coverage tracking
+
+```shell
+npx template-typescript-node-package --releases false --unitTests false
+```
+
+After the migration script finishes aligning your repository's contents to the templates, it will call the [Initialization](./Initialization.md) script as well.
+It will forward any values you provided or it inferred from the repository.
+
+### Skipping API Calls
+
+You can prevent the migration script from making some network-based changes using any or all of the following CLI flags:
+
+- `--skip-contributors` _(`boolean`)_: Skips detecting existing contributors with [`all-contributors-for-repository`](https://github.com/JoshuaKGoldberg/all-contributors-for-repository)
+- `--skip-github-api` _(`boolean`)_: Skips calling to GitHub APIs
+- `--skip-install` _(`boolean`)_: Skips installing all the new template packages with `pnpm`
+- `--skip-initialize` _(`boolean`)_: Skips running the initialize script at the end of migration
+
+```shell
+npx template-typescript-node-package --skip-github-api --skip-initialize --skip-install
+```
+
+> Tip: the `--skip-github-api` flag will cause all changes to be limited to your local repository.
+> That means you can test out the script with `npx template-typescript-node-package --skip-github-api`, then `git add -A; git reset --hard HEAD` to completely reset all changes.
diff --git a/knip.jsonc b/knip.jsonc
index 5a6ffc7db..6cae45405 100644
--- a/knip.jsonc
+++ b/knip.jsonc
@@ -2,8 +2,8 @@
"$schema": "https://unpkg.com/knip@latest/schema.json",
"entry": [
"src/index.ts!",
- "src/hydrate/index.ts",
- "src/setup/index.ts",
+ "src/initialize/index.ts",
+ "src/migrate/index.ts",
"script/*e2e.js"
],
"ignoreBinaries": ["gh"],
diff --git a/package.json b/package.json
index c45871cc7..135648c58 100644
--- a/package.json
+++ b/package.json
@@ -13,7 +13,7 @@
},
"type": "module",
"main": "./lib/index.js",
- "bin": "./bin/hydrate.js",
+ "bin": "./bin/migrate.js",
"files": [
"bin/",
"lib/",
@@ -25,16 +25,16 @@
"build": "tsup",
"format": "prettier \"**/*\" --ignore-unknown",
"format:write": "pnpm format --write",
- "hydrate:test": "node script/hydrate-test-e2e.js",
+ "initialize": "tsx src/initialize/index.ts",
+ "initialize:test": "node script/initialize-test-e2e.js",
"lint": "eslint . .*js --max-warnings 0 --report-unused-disable-directives",
"lint:knip": "knip",
"lint:md": "markdownlint \"**/*.md\" \".github/**/*.md\" --rules sentences-per-line",
"lint:package": "npmPkgJsonLint .",
"lint:packages": "pnpm dedupe --check",
"lint:spelling": "cspell \"**\" \".github/**/*\"",
+ "migrate:test": "node script/migrate-test-e2e.js",
"prepare": "husky install",
- "setup": "tsx src/setup/index.ts",
- "setup:test": "node script/setup-test-e2e.js",
"should-semantic-release": "should-semantic-release --verbose",
"test": "vitest"
},
diff --git a/script/setup-test-e2e.js b/script/initialize-test-e2e.js
similarity index 69%
rename from script/setup-test-e2e.js
rename to script/initialize-test-e2e.js
index ecc83663f..ba252e336 100644
--- a/script/setup-test-e2e.js
+++ b/script/initialize-test-e2e.js
@@ -8,10 +8,10 @@ const owner = "RNR1";
const title = "New Title Test";
const repository = "new-repository-test";
-// First we run setup to modifies the local repo, so we can test the changes
+// First we run initialize to modifies the local repo, so we can test the changes
await $({
stdio: "inherit",
-})`node ./lib/setup/index.js --description ${description} --owner ${owner} --title ${title} --repository ${repository} --skip-api --skip-restore`;
+})`node ./lib/initialize/index.js --description ${description} --owner ${owner} --title ${title} --repository ${repository} --skip-github-api --skip-restore`;
const newPackageJson = JSON.parse(
(await fs.readFile("./package.json")).toString(),
@@ -23,7 +23,7 @@ assert.equal(newPackageJson.name, repository);
const files = await globby(["*.*", "**/*.*"], {
gitignore: true,
- ignoreFiles: ["script/setup.js", "script/setup-test-e2e.js"],
+ ignoreFiles: ["script/initialize-test-e2e.js"],
});
for (const search of [
@@ -44,7 +44,7 @@ try {
process.exitCode = 1;
}
-// Now that setup has passed normal steps, we reset everything,
+// Now that initialize has passed normal steps, we reset everything,
// then run again without removing files - so we can capture test coverage
await $`git add -A`;
await $`git reset --hard HEAD`;
@@ -52,4 +52,4 @@ await $`pnpm i`;
await $`pnpm run build`;
await $({
stdio: "inherit",
-})`c8 -o ./coverage-setup -r html -r lcov node ./lib/setup/index.js --description ${description} --owner ${owner} --title ${title} --repository ${repository} --skip-api --skip-removal --skip-restore`;
+})`c8 -o ./coverage-initialize -r html -r lcov node ./lib/initialize/index.js --description ${description} --owner ${owner} --title ${title} --repository ${repository} --skip-github-api --skip-removal --skip-restore`;
diff --git a/script/hydrate-test-e2e.js b/script/migrate-test-e2e.js
similarity index 82%
rename from script/hydrate-test-e2e.js
rename to script/migrate-test-e2e.js
index 6d1484057..5056cc2a4 100644
--- a/script/hydrate-test-e2e.js
+++ b/script/migrate-test-e2e.js
@@ -9,7 +9,7 @@ const title = "Template TypeScript Node Package";
await $({
stdio: "inherit",
-})`c8 -o ./coverage-hydrate -r html -r lcov node ./bin/hydrate.js --description ${description} --owner ${owner} --title ${title} --repository ${repository} --skip-api --skip-contributors --skip-install --skip-setup`;
+})`c8 -o ./coverage-migrate -r html -r lcov node ./bin/migrate.js --description ${description} --owner ${owner} --title ${title} --repository ${repository} --skip-github-api --skip-contributors --skip-initialize --skip-install`;
const { stdout: gitStatus } = await $`git status`;
console.log(`Stdout from running \`git status\`:\n${gitStatus}`);
@@ -19,7 +19,7 @@ const indexOfUnstagedFilesMessage = gitStatus.indexOf(
);
if (indexOfUnstagedFilesMessage === -1) {
throw new Error(
- `Looks like hydrate didn't cause any file changes? That's ...probably incorrect? 😬`,
+ `Looks like migrate didn't cause any file changes? That's ...probably incorrect? 😬`,
);
}
@@ -60,13 +60,13 @@ if (unstagedModifiedFiles.length) {
console.error(
[
"",
- "Oh no! Running the hydrate script modified some files:",
+ "Oh no! Running the migrate script modified some files:",
...unstagedModifiedFiles.map((filePath) => ` - ${filePath}`),
"",
"That likely indicates changes made to the repository without",
- "corresponding updates to templates in src/hydrate/creation.",
+ "corresponding updates to templates in src/migrate/creation.",
"",
- "Please search for those file(s)' name(s) under src/hydrate for",
+ "Please search for those file(s)' name(s) under src/migrate for",
"the corresponding template and update those as well.",
]
.map((line) => chalk.red(line))
diff --git a/src/initialize/index.ts b/src/initialize/index.ts
new file mode 100644
index 000000000..4bad0282f
--- /dev/null
+++ b/src/initialize/index.ts
@@ -0,0 +1,3 @@
+import { initialize } from "./initialize.js";
+
+process.exitCode = await initialize(process.argv.slice(2));
diff --git a/src/initialize/initialize.ts b/src/initialize/initialize.ts
new file mode 100644
index 000000000..67f25c3e1
--- /dev/null
+++ b/src/initialize/initialize.ts
@@ -0,0 +1,10 @@
+import { runOrRestore } from "../shared/runOrRestore.js";
+import { initializeWithInformation } from "./initializeWithInformation.js";
+
+export async function initialize(args: string[]) {
+ return await runOrRestore({
+ args,
+ label: "initialization",
+ run: initializeWithInformation,
+ });
+}
diff --git a/src/setup/setupWithInformation.ts b/src/initialize/initializeWithInformation.ts
similarity index 73%
rename from src/setup/setupWithInformation.ts
rename to src/initialize/initializeWithInformation.ts
index e843df7fe..0a94ca016 100644
--- a/src/setup/setupWithInformation.ts
+++ b/src/initialize/initializeWithInformation.ts
@@ -7,9 +7,9 @@ import { getNpmAuthor } from "../shared/getNpmAuthor.js";
import { InputValuesAndOctokit } from "../shared/inputs.js";
import { addOwnerAsAllContributor } from "./settings/addOwnerAsAllContributor.js";
import { clearChangelog } from "./steps/clearChangelog.js";
-import { hydrateBranchProtectionSettings } from "./steps/hydrateBranchProtectionSettings.js";
-import { hydrateRepositorySettings } from "./steps/hydrateRepositorySettings.js";
-import { hydrateRepositoryLabels } from "./steps/labels/hydrateRepositoryLabels.js";
+import { migrateRepositoryLabels } from "./steps/labels/migrateRepositoryLabels.js";
+import { migrateBranchProtectionSettings } from "./steps/migrateBranchProtectionSettings.js";
+import { migrateRepositorySettings } from "./steps/migrateRepositorySettings.js";
import { removeSetupScripts } from "./steps/removeSetupScripts.js";
import { resetGitTags } from "./steps/resetGitTags.js";
import { uninstallPackages } from "./steps/uninstallPackages.js";
@@ -17,11 +17,11 @@ import { updateAllContributorsTable } from "./steps/updateAllContributorsTable.j
import { updateLocalFiles } from "./steps/updateLocalFiles.js";
import { updateReadme } from "./steps/updateReadme.js";
-export async function setupWithInformation({
+export async function initializeWithInformation({
octokit,
values,
}: InputValuesAndOctokit) {
- successSpinnerBlock("Started hydrating package metadata locally.");
+ successSpinnerBlock("Started migrating package metadata locally.");
await withSpinner(async () => {
await addOwnerAsAllContributor(values.owner);
@@ -38,7 +38,7 @@ export async function setupWithInformation({
"Appending template-typescript-node-package notice to 'README.md'",
);
- successSpinnerBlock(`Finished hydrating package metadata locally.`);
+ successSpinnerBlock(`Finished migrating package metadata locally.`);
await withSpinner(clearChangelog, "clearing CHANGELOG.md");
@@ -49,23 +49,23 @@ export async function setupWithInformation({
await withSpinner(resetGitTags, "deleting local git tags...");
if (!octokit) {
- skipSpinnerBlock(`Skipping API hydration.`);
+ skipSpinnerBlock(`Skipping API migration.`);
} else {
- successSpinnerBlock(`Starting API hydration.`);
+ successSpinnerBlock(`Starting API migration.`);
- await withSpinner(hydrateRepositoryLabels, "hydrating repository labels");
+ await withSpinner(migrateRepositoryLabels, "migrating repository labels");
await withSpinner(async () => {
- await hydrateRepositorySettings(octokit, values);
- }, "hydrating initial repository settings");
+ await migrateRepositorySettings(octokit, values);
+ }, "migrating initial repository settings");
await withSpinner(
- () => hydrateBranchProtectionSettings(octokit, values),
- "hydrating branch protection settings",
+ () => migrateBranchProtectionSettings(octokit, values),
+ "migrating branch protection settings",
"private repositories require GitHub Pro for that API.",
);
- successSpinnerBlock(`Finished API hydration.`);
+ successSpinnerBlock(`Finished API migration.`);
}
if (values.skipRemoval) {
diff --git a/src/setup/settings/addOwnerAsAllContributor.ts b/src/initialize/settings/addOwnerAsAllContributor.ts
similarity index 100%
rename from src/setup/settings/addOwnerAsAllContributor.ts
rename to src/initialize/settings/addOwnerAsAllContributor.ts
diff --git a/src/setup/steps/clearChangelog.ts b/src/initialize/steps/clearChangelog.ts
similarity index 100%
rename from src/setup/steps/clearChangelog.ts
rename to src/initialize/steps/clearChangelog.ts
diff --git a/src/setup/steps/labels/getExistingEquivalentLabel.test.ts b/src/initialize/steps/labels/getExistingEquivalentLabel.test.ts
similarity index 100%
rename from src/setup/steps/labels/getExistingEquivalentLabel.test.ts
rename to src/initialize/steps/labels/getExistingEquivalentLabel.test.ts
diff --git a/src/setup/steps/labels/getExistingEquivalentLabel.ts b/src/initialize/steps/labels/getExistingEquivalentLabel.ts
similarity index 100%
rename from src/setup/steps/labels/getExistingEquivalentLabel.ts
rename to src/initialize/steps/labels/getExistingEquivalentLabel.ts
diff --git a/src/setup/steps/labels/hydrateRepositoryLabels.test.ts b/src/initialize/steps/labels/migrateRepositoryLabels.test.ts
similarity index 87%
rename from src/setup/steps/labels/hydrateRepositoryLabels.test.ts
rename to src/initialize/steps/labels/migrateRepositoryLabels.test.ts
index b7d2e2ad8..ba3190bb0 100644
--- a/src/setup/steps/labels/hydrateRepositoryLabels.test.ts
+++ b/src/initialize/steps/labels/migrateRepositoryLabels.test.ts
@@ -1,6 +1,6 @@
import { describe, expect, it, vi } from "vitest";
-import { hydrateRepositoryLabels } from "./hydrateRepositoryLabels.js";
+import { migrateRepositoryLabels } from "./migrateRepositoryLabels.js";
const mock$ = vi.fn();
@@ -20,7 +20,7 @@ vi.mock("./outcomeLabels.js", () => ({
],
}));
-describe("hydrateRepositoryLabels", () => {
+describe("migrateRepositoryLabels", () => {
it("creates a setup label when it doesn't already exist", async () => {
mock$.mockResolvedValue({
stdout: JSON.stringify([
@@ -32,7 +32,7 @@ describe("hydrateRepositoryLabels", () => {
]),
});
- await hydrateRepositoryLabels();
+ await migrateRepositoryLabels();
expect(mock$).toHaveBeenCalledWith(
["gh label ", " ", " --color ", " --description ", ""],
@@ -54,7 +54,7 @@ describe("hydrateRepositoryLabels", () => {
]),
});
- await hydrateRepositoryLabels();
+ await migrateRepositoryLabels();
expect(mock$).toHaveBeenCalledWith(
["gh label ", " ", " --color ", " --description ", ""],
@@ -76,7 +76,7 @@ describe("hydrateRepositoryLabels", () => {
]),
});
- await hydrateRepositoryLabels();
+ await migrateRepositoryLabels();
expect(mock$).toHaveBeenCalledWith(
["gh label delete ", " --yes"],
@@ -96,7 +96,7 @@ describe("hydrateRepositoryLabels", () => {
]),
});
- await hydrateRepositoryLabels();
+ await migrateRepositoryLabels();
expect(mock$).not.toHaveBeenCalledWith(
["gh label delete ", " --yes"],
diff --git a/src/setup/steps/labels/hydrateRepositoryLabels.ts b/src/initialize/steps/labels/migrateRepositoryLabels.ts
similarity index 95%
rename from src/setup/steps/labels/hydrateRepositoryLabels.ts
rename to src/initialize/steps/labels/migrateRepositoryLabels.ts
index 80ae535ad..ec2991b08 100644
--- a/src/setup/steps/labels/hydrateRepositoryLabels.ts
+++ b/src/initialize/steps/labels/migrateRepositoryLabels.ts
@@ -7,7 +7,7 @@ interface GhLabelData {
name: string;
}
-export async function hydrateRepositoryLabels() {
+export async function migrateRepositoryLabels() {
const getLabelName = (label: { name: string }) => label.name;
const existingLabels = (
diff --git a/src/setup/steps/labels/outcomeLabels.ts b/src/initialize/steps/labels/outcomeLabels.ts
similarity index 100%
rename from src/setup/steps/labels/outcomeLabels.ts
rename to src/initialize/steps/labels/outcomeLabels.ts
diff --git a/src/setup/steps/hydrateBranchProtectionSettings.test.ts b/src/initialize/steps/migrateBranchProtectionSettings.test.ts
similarity index 79%
rename from src/setup/steps/hydrateBranchProtectionSettings.test.ts
rename to src/initialize/steps/migrateBranchProtectionSettings.test.ts
index 08f8b1bee..c3dea9c74 100644
--- a/src/setup/steps/hydrateBranchProtectionSettings.test.ts
+++ b/src/initialize/steps/migrateBranchProtectionSettings.test.ts
@@ -1,7 +1,7 @@
import { Octokit } from "octokit";
import { SpyInstance, describe, expect, it, vi } from "vitest";
-import { hydrateBranchProtectionSettings } from "./hydrateBranchProtectionSettings.js";
+import { migrateBranchProtectionSettings } from "./migrateBranchProtectionSettings.js";
const createMockOctokit = (request: SpyInstance) =>
({
@@ -10,11 +10,11 @@ const createMockOctokit = (request: SpyInstance) =>
const stubValues = { owner: "", repository: "" };
-describe("hydrateBranchProtectionSettings", () => {
+describe("migrateBranchProtectionSettings", () => {
it("returns false when the request receives a 403 response", async () => {
const mockRequest = vi.fn().mockRejectedValue({ status: 403 });
- const actual = await hydrateBranchProtectionSettings(
+ const actual = await migrateBranchProtectionSettings(
createMockOctokit(mockRequest),
stubValues,
);
@@ -27,7 +27,7 @@ describe("hydrateBranchProtectionSettings", () => {
const mockRequest = vi.fn().mockRejectedValue(error);
await expect(() =>
- hydrateBranchProtectionSettings(
+ migrateBranchProtectionSettings(
createMockOctokit(mockRequest),
stubValues,
),
diff --git a/src/setup/steps/hydrateBranchProtectionSettings.ts b/src/initialize/steps/migrateBranchProtectionSettings.ts
similarity index 95%
rename from src/setup/steps/hydrateBranchProtectionSettings.ts
rename to src/initialize/steps/migrateBranchProtectionSettings.ts
index 0798a5c13..13a62e8c6 100644
--- a/src/setup/steps/hydrateBranchProtectionSettings.ts
+++ b/src/initialize/steps/migrateBranchProtectionSettings.ts
@@ -3,7 +3,7 @@ import { Octokit } from "octokit";
import { InputValues } from "../../shared/inputs.js";
-export async function hydrateBranchProtectionSettings(
+export async function migrateBranchProtectionSettings(
octokit: Octokit,
{ owner, repository }: Pick${values.description}
diff --git a/src/hydrate/steps/writing/creation/dotGitHub/actions.test.ts b/src/migrate/steps/writing/creation/dotGitHub/actions.test.ts similarity index 100% rename from src/hydrate/steps/writing/creation/dotGitHub/actions.test.ts rename to src/migrate/steps/writing/creation/dotGitHub/actions.test.ts diff --git a/src/hydrate/steps/writing/creation/dotGitHub/actions.ts b/src/migrate/steps/writing/creation/dotGitHub/actions.ts similarity index 100% rename from src/hydrate/steps/writing/creation/dotGitHub/actions.ts rename to src/migrate/steps/writing/creation/dotGitHub/actions.ts diff --git a/src/hydrate/steps/writing/creation/dotGitHub/createWorkflowFile.test.ts b/src/migrate/steps/writing/creation/dotGitHub/createWorkflowFile.test.ts similarity index 100% rename from src/hydrate/steps/writing/creation/dotGitHub/createWorkflowFile.test.ts rename to src/migrate/steps/writing/creation/dotGitHub/createWorkflowFile.test.ts diff --git a/src/hydrate/steps/writing/creation/dotGitHub/createWorkflowFile.ts b/src/migrate/steps/writing/creation/dotGitHub/createWorkflowFile.ts similarity index 100% rename from src/hydrate/steps/writing/creation/dotGitHub/createWorkflowFile.ts rename to src/migrate/steps/writing/creation/dotGitHub/createWorkflowFile.ts diff --git a/src/hydrate/steps/writing/creation/dotGitHub/index.ts b/src/migrate/steps/writing/creation/dotGitHub/index.ts similarity index 76% rename from src/hydrate/steps/writing/creation/dotGitHub/index.ts rename to src/migrate/steps/writing/creation/dotGitHub/index.ts index b1d6b0763..f057fbc51 100644 --- a/src/hydrate/steps/writing/creation/dotGitHub/index.ts +++ b/src/migrate/steps/writing/creation/dotGitHub/index.ts @@ -1,10 +1,10 @@ -import { HydrationInputValues } from "../../../../values/types.js"; +import { MigrationInputValues } from "../../../../values/types.js"; import { createDotGitHubActions } from "./actions.js"; import { createDotGitHubIssueTemplate } from "./issueTemplate.js"; import { createDotGitHubFiles } from "./rootFiles.js"; import { createWorkflows } from "./workflows.js"; -export function createDotGitHub(values: HydrationInputValues) { +export function createDotGitHub(values: MigrationInputValues) { return { ISSUE_TEMPLATE: createDotGitHubIssueTemplate(values), actions: createDotGitHubActions(), diff --git a/src/hydrate/steps/writing/creation/dotGitHub/issueTemplate.ts b/src/migrate/steps/writing/creation/dotGitHub/issueTemplate.ts similarity index 97% rename from src/hydrate/steps/writing/creation/dotGitHub/issueTemplate.ts rename to src/migrate/steps/writing/creation/dotGitHub/issueTemplate.ts index 50ab41c8f..387ab74e5 100644 --- a/src/hydrate/steps/writing/creation/dotGitHub/issueTemplate.ts +++ b/src/migrate/steps/writing/creation/dotGitHub/issueTemplate.ts @@ -1,10 +1,10 @@ -import { HydrationInputValues } from "../../../../values/types.js"; +import { MigrationInputValues } from "../../../../values/types.js"; import { formatYaml } from "../formatters/formatYaml.js"; export function createDotGitHubIssueTemplate({ owner, repository, -}: Pick