feat: add optional --access option

.release-it.json

@@ -8,7 +8,7 @@
 		"release": true,
 		"releaseName": "v${version}"
 	},
-	"npm": { "publishArgs": ["--provenance"] },
+	"npm": { "publishArgs": ["--access public", "--provenance"] },
 	"plugins": {
 		"@release-it/conventional-changelog": {
 			"infile": "CHANGELOG.md",

docs/Options.md

@@ -49,6 +49,7 @@ That script will run completely autonomously, no prompted inputs required. ✨
 
 The setup scripts also allow for optional overrides of the following inputs whose defaults are based on other options:
 
+- `--access` _(`"public" | "restricted`)_: Which [`npm publish --access`](https://docs.npmjs.com/cli/commands/npm-publish#access) to release npm packages with (by default, `"public"`)
 - `--author` _(`string`)_: Username on npm to publish packages under (by default, an existing npm author, or the currently logged in npm user, or `owner.toLowerCase()`)
 - `--email` _(`string`)_: Email address to be listed as the point of contact in docs and packages (e.g. `[email protected]`)
   - Optionally, `--email-github` _(`string`)_ and/or `--email-npm` _(`string`)_ may be provided to use different emails in `.md` files and `package.json`, respectively

src/create/createRerunSuggestion.test.ts

@@ -4,6 +4,7 @@ import { Options } from "../shared/types.js";
 import { createRerunSuggestion } from "./createRerunSuggestion.js";
 
 const options = {
+	access: "public",
 	author: "TestAuthor",
 	base: "everything",
 	createRepository: true,
@@ -43,7 +44,7 @@ describe("createRerunSuggestion", () => {
 		const actual = createRerunSuggestion("initialize", options);
 
 		expect(actual).toMatchInlineSnapshot(
-			'"npx create-typescript-app --mode initialize --base everything --author TestAuthor --create-repository true --description \\"Test description.\\" --email-github [email protected] --email-npm [email protected] --exclude-compliance true --exclude-contributors true --exclude-lint-jsdoc true --exclude-lint-json true --exclude-lint-knip true --exclude-lint-package-json true --exclude-lint-perfectionist true --owner TestOwner --repository test-repository --skip-github-api true --skip-install true --skip-removal true --title \\"Test Title\\""',
+			'"npx create-typescript-app --mode initialize --base everything --access public --author TestAuthor --create-repository true --description \\"Test description.\\" --email-github [email protected] --email-npm [email protected] --exclude-compliance true --exclude-contributors true --exclude-lint-jsdoc true --exclude-lint-json true --exclude-lint-knip true --exclude-lint-package-json true --exclude-lint-perfectionist true --owner TestOwner --repository test-repository --skip-github-api true --skip-install true --skip-removal true --title \\"Test Title\\""',
 		);
 	});
 
@@ -57,7 +58,7 @@ describe("createRerunSuggestion", () => {
 		});
 
 		expect(actual).toMatchInlineSnapshot(
-			'"npx create-typescript-app --mode initialize --base everything --author TestAuthor --create-repository true --description \\"Test description.\\" --email-github [email protected] --email-npm [email protected] --exclude-compliance true --exclude-contributors true --exclude-lint-jsdoc true --exclude-lint-json true --exclude-lint-knip true --exclude-lint-package-json true --exclude-lint-perfectionist true --logo test/src.png --logo-alt \\"Test alt.\\" --owner TestOwner --repository test-repository --skip-github-api true --skip-install true --skip-removal true --title \\"Test Title\\""',
+			'"npx create-typescript-app --mode initialize --base everything --access public --author TestAuthor --create-repository true --description \\"Test description.\\" --email-github [email protected] --email-npm [email protected] --exclude-compliance true --exclude-contributors true --exclude-lint-jsdoc true --exclude-lint-json true --exclude-lint-knip true --exclude-lint-package-json true --exclude-lint-perfectionist true --logo test/src.png --logo-alt \\"Test alt.\\" --owner TestOwner --repository test-repository --skip-github-api true --skip-install true --skip-removal true --title \\"Test Title\\""',
 		);
 	});
 
@@ -70,7 +71,7 @@ describe("createRerunSuggestion", () => {
 		});
 
 		expect(actual).toMatchInlineSnapshot(
-			'"npx create-typescript-app --mode initialize --base everything --author TestAuthor --create-repository true --description \\"Test description.\\" --email-github [email protected] --email-npm [email protected] --exclude-compliance true --exclude-contributors true --exclude-lint-jsdoc true --exclude-lint-json true --exclude-lint-knip true --exclude-lint-md true --exclude-lint-package-json true --exclude-lint-perfectionist true --exclude-lint-spelling true --owner TestOwner --repository test-repository --skip-github-api true --skip-install true --skip-removal true --title \\"Test Title\\""',
+			'"npx create-typescript-app --mode initialize --base everything --access public --author TestAuthor --create-repository true --description \\"Test description.\\" --email-github [email protected] --email-npm [email protected] --exclude-compliance true --exclude-contributors true --exclude-lint-jsdoc true --exclude-lint-json true --exclude-lint-knip true --exclude-lint-md true --exclude-lint-package-json true --exclude-lint-perfectionist true --exclude-lint-spelling true --owner TestOwner --repository test-repository --skip-github-api true --skip-install true --skip-removal true --title \\"Test Title\\""',
 		);
 	});
 });

src/shared/options/args.ts

@@ -1,4 +1,5 @@
 export const allArgOptions = {
+	access: { type: "string" },
 	author: { type: "string" },
 	base: { type: "string" },
 	"create-repository": { type: "boolean" },

src/shared/options/augmentOptionsWithExcludes.test.ts

@@ -4,6 +4,7 @@ import { Options } from "../types.js";
 import { augmentOptionsWithExcludes } from "./augmentOptionsWithExcludes.js";
 
 const optionsBase = {
+	access: "public",
 	author: undefined,
 	base: undefined,
 	createRepository: undefined,
@@ -41,7 +42,7 @@ const optionsBase = {
 	skipRestore: undefined,
 	skipUninstall: undefined,
 	title: "",
-};
+} satisfies Options;
 
 describe("augmentOptionsWithExcludes", () => {
 	it("returns options without exclusions and skips prompting when exclusions are provided manually", async () => {

src/shared/options/augmentOptionsWithExcludes.ts

@@ -2,7 +2,7 @@ import * as prompts from "@clack/prompts";
 import chalk from "chalk";
 
 import { filterPromptCancel } from "../prompts.js";
-import { InputBase, Options } from "../types.js";
+import { Options, OptionsBase } from "../types.js";
 
 interface ExclusionDescription {
 	hint: string;
@@ -134,9 +134,9 @@ export async function augmentOptionsWithExcludes(
 
 	const base =
 		options.base ??
-		filterPromptCancel<InputBase | symbol>(
+		filterPromptCancel<OptionsBase | symbol>(
 			await prompts.select({
-				initialValue: "common" as InputBase,
+				initialValue: "common" as OptionsBase,
 				message: `How much tooling would you like the template to set up for you?`,
 				options: [
 					{

src/shared/options/optionsSchema.ts

@@ -1,6 +1,7 @@
 import { z } from "zod";
 
 export const optionsSchemaShape = {
+	access: z.union([z.literal("public"), z.literal("restricted")]).optional(),
 	author: z.string().optional(),
 	base: z
 		.union([

src/shared/options/readOptions.test.ts

@@ -5,6 +5,7 @@ import { optionsSchemaShape } from "./optionsSchema.js";
 import { readOptions } from "./readOptions.js";
 
 const emptyOptions = {
+	access: undefined,
 	author: undefined,
 	base: undefined,
 	createRepository: undefined,

src/shared/options/readOptions.ts

@@ -40,6 +40,7 @@ export async function readOptions(args: string[]): Promise<OptionsParseResult> {
 	});
 
 	const mappedOptions = {
+		access: values.access,
 		author: values.author,
 		base: values.base,
 		createRepository: values["create-repository"],
@@ -186,6 +187,7 @@ export async function readOptions(args: string[]): Promise<OptionsParseResult> {
 
 	const augmentedOptions = await augmentOptionsWithExcludes({
 		...options,
+		access: options.access ?? "public",
 		author: options.author ?? (await defaults.owner()),
 		description: options.description,
 		email: typeof email === "string" ? { github: email, npm: email } : email,

src/shared/types.ts

@@ -17,21 +17,24 @@ export interface PartialPackageData {
 	repository?: { type: string; url: string } | string;
 }
 
-export type InputBase = "common" | "everything" | "minimum" | "prompt";
+export type OptionsAccess = "public" | "restricted";
 
-export interface OptionsLogo {
-	alt: string;
-	src: string;
-}
+export type OptionsBase = "common" | "everything" | "minimum" | "prompt";
 
 export interface OptionsEmail {
 	github: string;
 	npm: string;
 }
 
+export interface OptionsLogo {
+	alt: string;
+	src: string;
+}
+
 export interface Options {
+	access: OptionsAccess;
 	author?: string;
-	base?: InputBase;
+	base?: OptionsBase;
 	createRepository?: boolean;
 	description: string;
 	email: OptionsEmail;

src/steps/finalizeDependencies.test.ts

@@ -17,6 +17,7 @@ vi.mock("../shared/packages.js", () => ({
 }));
 
 const options = {
+	access: "public",
 	author: undefined,
 	base: "everything",
 	createRepository: undefined,

src/steps/updateLocalFiles.test.ts

@@ -20,6 +20,7 @@ vi.mock("../shared/readFileSafeAsJson.js", () => ({
 }));
 
 const options = {
+	access: "public",
 	author: undefined,
 	base: "everything",
 	createRepository: undefined,

src/steps/writeReadme/generateTopContent.test.ts

@@ -1,8 +1,10 @@
 import { describe, expect, it } from "vitest";
 
+import { Options } from "../../shared/types.js";
 import { generateTopContent } from "./generateTopContent.js";
 
 const optionsBase = {
+	access: "public",
 	author: undefined,
 	base: undefined,
 	createRepository: undefined,
@@ -34,7 +36,7 @@ const optionsBase = {
 	skipRestore: undefined,
 	skipUninstall: undefined,
 	title: "",
-};
+} satisfies Options;
 
 describe("findExistingBadges", () => {
 	it("generates full contents when there are no existing badges", () => {

src/steps/writeReadme/index.test.ts

@@ -24,6 +24,7 @@ vi.mock("../../shared/readFileSafe.js", () => ({
 }));
 
 const options = {
+	access: "public",
 	author: "Test Author",
 	base: "everything",
 	createRepository: false,

src/steps/writing/creation/createESLintRC.test.ts

@@ -5,6 +5,7 @@ import { createESLintRC } from "./createESLintRC.js";
 
 function fakeOptions(getExcludeValue: (exclusionName: string) => boolean) {
 	return {
+		access: "public",
 		author: "TestAuthor",
 		base: "everything",
 		createRepository: true,

src/steps/writing/creation/dotGitHub/createDevelopment.test.ts

@@ -4,6 +4,7 @@ import { Options } from "../../../../shared/types.js";
 import { createDevelopment } from "./createDevelopment.js";
 
 const options = {
+	access: "public",
 	author: "Test Author",
 	base: "everything",
 	createRepository: false,

src/steps/writing/creation/rootFiles.ts

@@ -80,7 +80,7 @@ export async function createRootFiles(options: Options) {
 					releaseName: "v${version}",
 				},
 				npm: {
-					publishArgs: ["--provenance"],
+					publishArgs: [`--access ${options.access}`, "--provenance"],
 				},
 				plugins: {
 					"@release-it/conventional-changelog": {

src/steps/writing/creation/writePackageJson.test.ts

@@ -12,6 +12,7 @@ vi.mock("../../../shared/readFileSafeAsJson.js", () => ({
 }));
 
 const options = {
+	access: "public",
 	author: "test-author",
 	base: "everything",
 	createRepository: undefined,