Skip to content

Commit bfcd795

Browse files
JoshuaKGoldbergJoshuaKGoldberg
authored
feat: add optional --access option (#871)
## PR Checklist - [x] Addresses an existing open issue: fixes #665 - [x] That issue was marked as [`status: accepting prs`](https://github.com/JoshuaKGoldberg/create-typescript-app/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22) - [x] Steps in [CONTRIBUTING.md](https://github.com/JoshuaKGoldberg/create-typescript-app/blob/main/.github/CONTRIBUTING.md) were taken ## Overview Defaults to `--access public`, but provides an escape hatch for private packages.
1 parent f124518 commit bfcd795

18 files changed

+35
-16
lines changed

‎.release-it.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"release": true,
99
"releaseName": "v${version}"
1010
},
11-
"npm": { "publishArgs": ["--provenance"] },
11+
"npm": { "publishArgs": ["--access public", "--provenance"] },
1212
"plugins": {
1313
"@release-it/conventional-changelog": {
1414
"infile": "CHANGELOG.md",

‎docs/Options.md

+1
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ That script will run completely autonomously, no prompted inputs required. ✨
4949

5050
The setup scripts also allow for optional overrides of the following inputs whose defaults are based on other options:
5151

52+
- `--access` _(`"public" | "restricted`)_: Which [`npm publish --access`](https://docs.npmjs.com/cli/commands/npm-publish#access) to release npm packages with (by default, `"public"`)
5253
- `--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()`)
5354
- `--email` _(`string`)_: Email address to be listed as the point of contact in docs and packages (e.g. `[email protected]`)
5455
- 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-3
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ import { Options } from "../shared/types.js";
44
import { createRerunSuggestion } from "./createRerunSuggestion.js";
55

66
const options = {
7+
access: "public",
78
author: "TestAuthor",
89
base: "everything",
910
createRepository: true,
@@ -43,7 +44,7 @@ describe("createRerunSuggestion", () => {
4344
const actual = createRerunSuggestion("initialize", options);
4445

4546
expect(actual).toMatchInlineSnapshot(
46-
'"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\\""',
47+
'"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\\""',
4748
);
4849
});
4950

@@ -57,7 +58,7 @@ describe("createRerunSuggestion", () => {
5758
});
5859

5960
expect(actual).toMatchInlineSnapshot(
60-
'"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\\""',
61+
'"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\\""',
6162
);
6263
});
6364

@@ -70,7 +71,7 @@ describe("createRerunSuggestion", () => {
7071
});
7172

7273
expect(actual).toMatchInlineSnapshot(
73-
'"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\\""',
74+
'"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\\""',
7475
);
7576
});
7677
});

‎src/shared/options/args.ts

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
export const allArgOptions = {
2+
access: { type: "string" },
23
author: { type: "string" },
34
base: { type: "string" },
45
"create-repository": { type: "boolean" },

‎src/shared/options/augmentOptionsWithExcludes.test.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ import { Options } from "../types.js";
44
import { augmentOptionsWithExcludes } from "./augmentOptionsWithExcludes.js";
55

66
const optionsBase = {
7+
access: "public",
78
author: undefined,
89
base: undefined,
910
createRepository: undefined,
@@ -41,7 +42,7 @@ const optionsBase = {
4142
skipRestore: undefined,
4243
skipUninstall: undefined,
4344
title: "",
44-
};
45+
} satisfies Options;
4546

4647
describe("augmentOptionsWithExcludes", () => {
4748
it("returns options without exclusions and skips prompting when exclusions are provided manually", async () => {

‎src/shared/options/augmentOptionsWithExcludes.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import * as prompts from "@clack/prompts";
22
import chalk from "chalk";
33

44
import { filterPromptCancel } from "../prompts.js";
5-
import { InputBase, Options } from "../types.js";
5+
import { Options, OptionsBase } from "../types.js";
66

77
interface ExclusionDescription {
88
hint: string;
@@ -134,9 +134,9 @@ export async function augmentOptionsWithExcludes(
134134

135135
const base =
136136
options.base ??
137-
filterPromptCancel<InputBase | symbol>(
137+
filterPromptCancel<OptionsBase | symbol>(
138138
await prompts.select({
139-
initialValue: "common" as InputBase,
139+
initialValue: "common" as OptionsBase,
140140
message: `How much tooling would you like the template to set up for you?`,
141141
options: [
142142
{

‎src/shared/options/optionsSchema.ts

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
import { z } from "zod";
22

33
export const optionsSchemaShape = {
4+
access: z.union([z.literal("public"), z.literal("restricted")]).optional(),
45
author: z.string().optional(),
56
base: z
67
.union([

‎src/shared/options/readOptions.test.ts

+1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ import { optionsSchemaShape } from "./optionsSchema.js";
55
import { readOptions } from "./readOptions.js";
66

77
const emptyOptions = {
8+
access: undefined,
89
author: undefined,
910
base: undefined,
1011
createRepository: undefined,

‎src/shared/options/readOptions.ts

+2
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ export async function readOptions(args: string[]): Promise<OptionsParseResult> {
4040
});
4141

4242
const mappedOptions = {
43+
access: values.access,
4344
author: values.author,
4445
base: values.base,
4546
createRepository: values["create-repository"],
@@ -186,6 +187,7 @@ export async function readOptions(args: string[]): Promise<OptionsParseResult> {
186187

187188
const augmentedOptions = await augmentOptionsWithExcludes({
188189
...options,
190+
access: options.access ?? "public",
189191
author: options.author ?? (await defaults.owner()),
190192
description: options.description,
191193
email: typeof email === "string" ? { github: email, npm: email } : email,

‎src/shared/types.ts

+9-6
Original file line numberDiff line numberDiff line change
@@ -17,21 +17,24 @@ export interface PartialPackageData {
1717
repository?: { type: string; url: string } | string;
1818
}
1919

20-
export type InputBase = "common" | "everything" | "minimum" | "prompt";
20+
export type OptionsAccess = "public" | "restricted";
2121

22-
export interface OptionsLogo {
23-
alt: string;
24-
src: string;
25-
}
22+
export type OptionsBase = "common" | "everything" | "minimum" | "prompt";
2623

2724
export interface OptionsEmail {
2825
github: string;
2926
npm: string;
3027
}
3128

29+
export interface OptionsLogo {
30+
alt: string;
31+
src: string;
32+
}
33+
3234
export interface Options {
35+
access: OptionsAccess;
3336
author?: string;
34-
base?: InputBase;
37+
base?: OptionsBase;
3538
createRepository?: boolean;
3639
description: string;
3740
email: OptionsEmail;

‎src/steps/finalizeDependencies.test.ts

+1
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ vi.mock("../shared/packages.js", () => ({
1717
}));
1818

1919
const options = {
20+
access: "public",
2021
author: undefined,
2122
base: "everything",
2223
createRepository: undefined,

‎src/steps/updateLocalFiles.test.ts

+1
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ vi.mock("../shared/readFileSafeAsJson.js", () => ({
2020
}));
2121

2222
const options = {
23+
access: "public",
2324
author: undefined,
2425
base: "everything",
2526
createRepository: undefined,

‎src/steps/writeReadme/generateTopContent.test.ts

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
import { describe, expect, it } from "vitest";
22

3+
import { Options } from "../../shared/types.js";
34
import { generateTopContent } from "./generateTopContent.js";
45

56
const optionsBase = {
7+
access: "public",
68
author: undefined,
79
base: undefined,
810
createRepository: undefined,
@@ -34,7 +36,7 @@ const optionsBase = {
3436
skipRestore: undefined,
3537
skipUninstall: undefined,
3638
title: "",
37-
};
39+
} satisfies Options;
3840

3941
describe("findExistingBadges", () => {
4042
it("generates full contents when there are no existing badges", () => {

‎src/steps/writeReadme/index.test.ts

+1
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ vi.mock("../../shared/readFileSafe.js", () => ({
2424
}));
2525

2626
const options = {
27+
access: "public",
2728
author: "Test Author",
2829
base: "everything",
2930
createRepository: false,

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

+1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ import { createESLintRC } from "./createESLintRC.js";
55

66
function fakeOptions(getExcludeValue: (exclusionName: string) => boolean) {
77
return {
8+
access: "public",
89
author: "TestAuthor",
910
base: "everything",
1011
createRepository: true,

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

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ import { Options } from "../../../../shared/types.js";
44
import { createDevelopment } from "./createDevelopment.js";
55

66
const options = {
7+
access: "public",
78
author: "Test Author",
89
base: "everything",
910
createRepository: false,

‎src/steps/writing/creation/rootFiles.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ export async function createRootFiles(options: Options) {
8080
releaseName: "v${version}",
8181
},
8282
npm: {
83-
publishArgs: ["--provenance"],
83+
publishArgs: [`--access ${options.access}`, "--provenance"],
8484
},
8585
plugins: {
8686
"@release-it/conventional-changelog": {

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

+1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ vi.mock("../../../shared/readFileSafeAsJson.js", () => ({
1212
}));
1313

1414
const options = {
15+
access: "public",
1516
author: "test-author",
1617
base: "everything",
1718
createRepository: undefined,

0 commit comments

Comments
 (0)