create-typescript-app 1.30.0 → 1.32.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +35 -32
- package/lib/bin/index.js +8 -7
- package/lib/bin/index.js.map +1 -1
- package/lib/bin/promptForMode.d.ts +11 -0
- package/lib/bin/promptForMode.js +102 -0
- package/lib/bin/promptForMode.js.map +1 -0
- package/lib/create/createAndEnterGitDirectory.d.ts +3 -0
- package/lib/create/createAndEnterGitDirectory.js +19 -0
- package/lib/create/createAndEnterGitDirectory.js.map +1 -0
- package/lib/create/createRerunSuggestion.d.ts +1 -2
- package/lib/create/createRerunSuggestion.js +18 -5
- package/lib/create/createRerunSuggestion.js.map +1 -1
- package/lib/create/createWithOptions.d.ts +1 -0
- package/lib/create/createWithOptions.js +6 -9
- package/lib/create/createWithOptions.js.map +1 -1
- package/lib/create/index.d.ts +2 -3
- package/lib/create/index.js +16 -19
- package/lib/create/index.js.map +1 -1
- package/lib/initialize/index.d.ts +1 -2
- package/lib/initialize/index.js +7 -7
- package/lib/initialize/index.js.map +1 -1
- package/lib/initialize/initializeWithOptions.d.ts +1 -0
- package/lib/initialize/initializeWithOptions.js +4 -4
- package/lib/initialize/initializeWithOptions.js.map +1 -1
- package/lib/migrate/index.d.ts +1 -2
- package/lib/migrate/index.js +8 -5
- package/lib/migrate/index.js.map +1 -1
- package/lib/migrate/migrateWithOptions.d.ts +1 -0
- package/lib/migrate/migrateWithOptions.js +3 -3
- package/lib/migrate/migrateWithOptions.js.map +1 -1
- package/lib/shared/cli/outro.d.ts +4 -3
- package/lib/shared/cli/outro.js +2 -2
- package/lib/shared/cli/outro.js.map +1 -1
- package/lib/shared/generateNextSteps.d.ts +8 -0
- package/lib/shared/generateNextSteps.js +60 -0
- package/lib/shared/generateNextSteps.js.map +1 -0
- package/lib/shared/getGitHubUserAsAllContributor.d.ts +5 -1
- package/lib/shared/getGitHubUserAsAllContributor.js +11 -3
- package/lib/shared/getGitHubUserAsAllContributor.js.map +1 -1
- package/lib/shared/options/args.d.ts +44 -4
- package/lib/shared/options/args.js +15 -2
- package/lib/shared/options/args.js.map +1 -1
- package/lib/shared/options/augmentOptionsWithExcludes.d.ts +2 -0
- package/lib/shared/options/augmentOptionsWithExcludes.js +33 -3
- package/lib/shared/options/augmentOptionsWithExcludes.js.map +1 -1
- package/lib/shared/options/{readOptionDefaults → createOptionDefaults}/index.d.ts +10 -3
- package/lib/shared/options/{readOptionDefaults → createOptionDefaults}/index.js +14 -9
- package/lib/shared/options/createOptionDefaults/index.js.map +1 -0
- package/lib/shared/options/{readOptionDefaults → createOptionDefaults}/parsePackageAuthor.d.ts +2 -0
- package/lib/shared/options/createOptionDefaults/parsePackageAuthor.js.map +1 -0
- package/lib/shared/options/createOptionDefaults/readDefaultsFromReadme.js.map +1 -0
- package/lib/shared/options/detectEmailRedundancy.d.ts +8 -0
- package/lib/shared/options/detectEmailRedundancy.js +16 -0
- package/lib/shared/options/detectEmailRedundancy.js.map +1 -0
- package/lib/shared/options/ensureRepositoryExists.d.ts +3 -1
- package/lib/shared/options/ensureRepositoryExists.js +2 -1
- package/lib/shared/options/ensureRepositoryExists.js.map +1 -1
- package/lib/shared/options/getPrefillOrPromptedOption.d.ts +1 -1
- package/lib/shared/options/getPrefillOrPromptedOption.js +1 -4
- package/lib/shared/options/getPrefillOrPromptedOption.js.map +1 -1
- package/lib/shared/options/optionsSchema.d.ts +194 -0
- package/lib/shared/options/optionsSchema.js +57 -0
- package/lib/shared/options/optionsSchema.js.map +1 -0
- package/lib/shared/options/readOptions.d.ts +4 -3
- package/lib/shared/options/readOptions.js +46 -58
- package/lib/shared/options/readOptions.js.map +1 -1
- package/lib/shared/packages.d.ts +2 -0
- package/lib/shared/runOrRestore.d.ts +1 -1
- package/lib/shared/types.d.ts +49 -7
- package/lib/steps/addOwnerAsAllContributor.d.ts +5 -1
- package/lib/steps/addOwnerAsAllContributor.js +8 -3
- package/lib/steps/addOwnerAsAllContributor.js.map +1 -1
- package/lib/steps/addToolAllContributors.d.ts +5 -1
- package/lib/steps/addToolAllContributors.js +2 -2
- package/lib/steps/addToolAllContributors.js.map +1 -1
- package/lib/steps/detectExistingContributors.d.ts +2 -0
- package/lib/steps/finalizeDependencies.d.ts +2 -0
- package/lib/steps/finalizeDependencies.js +8 -6
- package/lib/steps/finalizeDependencies.js.map +1 -1
- package/lib/steps/initializeGitHubRepository/index.d.ts +2 -0
- package/lib/steps/initializeGitHubRepository/initializeBranchProtectionSettings.d.ts +2 -0
- package/lib/steps/initializeGitHubRepository/labels/outcomeLabels.js +5 -0
- package/lib/steps/initializeGitHubRepository/labels/outcomeLabels.js.map +1 -1
- package/lib/steps/initializeGitRemote.d.ts +2 -0
- package/lib/steps/initializeRepositorySettings.d.ts +2 -0
- package/lib/steps/uninstallPackages.d.ts +1 -1
- package/lib/steps/uninstallPackages.js +3 -2
- package/lib/steps/uninstallPackages.js.map +1 -1
- package/lib/steps/updateAllContributorsTable.d.ts +2 -0
- package/lib/steps/updateLocalFiles.d.ts +1 -2
- package/lib/steps/updateLocalFiles.js +4 -7
- package/lib/steps/updateLocalFiles.js.map +1 -1
- package/lib/steps/writeReadme/findIntroSectionClose.js +1 -1
- package/lib/steps/writeReadme/findIntroSectionClose.js.map +1 -1
- package/lib/steps/writeReadme/generateTopContent.d.ts +2 -0
- package/lib/steps/writeReadme/generateTopContent.js +17 -2
- package/lib/steps/writeReadme/generateTopContent.js.map +1 -1
- package/lib/steps/writeReadme/index.d.ts +2 -0
- package/lib/steps/writeReadme/index.js +1 -1
- package/lib/steps/writeReadme/index.js.map +1 -1
- package/lib/steps/writing/creation/createESLintRC.d.ts +2 -0
- package/lib/steps/writing/creation/createESLintRC.js +35 -42
- package/lib/steps/writing/creation/createESLintRC.js.map +1 -1
- package/lib/steps/writing/creation/dotGitHub/createDevelopment.d.ts +2 -0
- package/lib/steps/writing/creation/dotGitHub/createDevelopment.js +1 -1
- package/lib/steps/writing/creation/dotGitHub/createDevelopment.js.map +1 -1
- package/lib/steps/writing/creation/dotGitHub/createDotGitHubFiles.d.ts +2 -0
- package/lib/steps/writing/creation/dotGitHub/createDotGitHubFiles.js +9 -9
- package/lib/steps/writing/creation/dotGitHub/createDotGitHubFiles.js.map +1 -1
- package/lib/steps/writing/creation/dotGitHub/createWorkflowFile.d.ts +1 -1
- package/lib/steps/writing/creation/dotGitHub/createWorkflowFile.js.map +1 -1
- package/lib/steps/writing/creation/dotGitHub/{workflows.d.ts → createWorkflows.d.ts} +2 -0
- package/lib/steps/writing/creation/dotGitHub/{workflows.js → createWorkflows.js} +11 -89
- package/lib/steps/writing/creation/dotGitHub/createWorkflows.js.map +1 -0
- package/lib/steps/writing/creation/dotGitHub/index.d.ts +2 -0
- package/lib/steps/writing/creation/dotGitHub/index.js +1 -1
- package/lib/steps/writing/creation/dotGitHub/index.js.map +1 -1
- package/lib/steps/writing/creation/dotGitHub/issueTemplate.d.ts +2 -0
- package/lib/steps/writing/creation/dotVSCode.d.ts +2 -0
- package/lib/steps/writing/creation/index.d.ts +1 -2
- package/lib/steps/writing/creation/index.js +2 -2
- package/lib/steps/writing/creation/index.js.map +1 -1
- package/lib/steps/writing/creation/rootFiles.d.ts +2 -0
- package/lib/steps/writing/creation/rootFiles.js +4 -3
- package/lib/steps/writing/creation/rootFiles.js.map +1 -1
- package/lib/steps/writing/creation/src.d.ts +2 -0
- package/lib/steps/writing/creation/writeAllContributorsRC.d.ts +2 -0
- package/lib/steps/writing/creation/writeAllContributorsRC.js +1 -1
- package/lib/steps/writing/creation/writeAllContributorsRC.js.map +1 -1
- package/lib/steps/writing/creation/writePackageJson.d.ts +2 -0
- package/lib/steps/writing/creation/writePackageJson.js +3 -3
- package/lib/steps/writing/creation/writePackageJson.js.map +1 -1
- package/lib/steps/writing/writeStructure.d.ts +1 -2
- package/lib/steps/writing/writeStructure.js +2 -2
- package/lib/steps/writing/writeStructure.js.map +1 -1
- package/package.json +5 -8
- package/lib/bin/mode.d.ts +0 -14
- package/lib/bin/mode.js +0 -50
- package/lib/bin/mode.js.map +0 -1
- package/lib/create/createAndEnterRepository.d.ts +0 -3
- package/lib/create/createAndEnterRepository.js +0 -15
- package/lib/create/createAndEnterRepository.js.map +0 -1
- package/lib/shared/options/readOptionDefaults/index.js.map +0 -1
- package/lib/shared/options/readOptionDefaults/parsePackageAuthor.js.map +0 -1
- package/lib/shared/options/readOptionDefaults/readDefaultsFromReadme.js.map +0 -1
- package/lib/steps/writing/creation/dotGitHub/workflows.js.map +0 -1
- /package/lib/shared/options/{readOptionDefaults → createOptionDefaults}/parsePackageAuthor.js +0 -0
- /package/lib/shared/options/{readOptionDefaults → createOptionDefaults}/readDefaultsFromReadme.d.ts +0 -0
- /package/lib/shared/options/{readOptionDefaults → createOptionDefaults}/readDefaultsFromReadme.js +0 -0
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
import { z } from "zod";
|
|
2
|
+
const optionsSchemaShape = {
|
|
3
|
+
access: z.union([z.literal("public"), z.literal("restricted")]).optional(),
|
|
4
|
+
author: z.string().optional(),
|
|
5
|
+
base: z.union([
|
|
6
|
+
z.literal("common"),
|
|
7
|
+
z.literal("everything"),
|
|
8
|
+
z.literal("minimum"),
|
|
9
|
+
z.literal("prompt")
|
|
10
|
+
]).optional(),
|
|
11
|
+
description: z.string().optional(),
|
|
12
|
+
directory: z.string().optional(),
|
|
13
|
+
email: z.object({
|
|
14
|
+
github: z.string().email(),
|
|
15
|
+
npm: z.string().email()
|
|
16
|
+
}).optional(),
|
|
17
|
+
excludeAllContributors: z.boolean().optional(),
|
|
18
|
+
excludeCompliance: z.boolean().optional(),
|
|
19
|
+
excludeLintDeprecation: z.boolean().optional(),
|
|
20
|
+
excludeLintESLint: z.boolean().optional(),
|
|
21
|
+
excludeLintJSDoc: z.boolean().optional(),
|
|
22
|
+
excludeLintJson: z.boolean().optional(),
|
|
23
|
+
excludeLintKnip: z.boolean().optional(),
|
|
24
|
+
excludeLintMd: z.boolean().optional(),
|
|
25
|
+
excludeLintPackageJson: z.boolean().optional(),
|
|
26
|
+
excludeLintPackages: z.boolean().optional(),
|
|
27
|
+
excludeLintPerfectionist: z.boolean().optional(),
|
|
28
|
+
excludeLintRegex: z.boolean().optional(),
|
|
29
|
+
excludeLintSpelling: z.boolean().optional(),
|
|
30
|
+
excludeLintStrict: z.boolean().optional(),
|
|
31
|
+
excludeLintStylistic: z.boolean().optional(),
|
|
32
|
+
excludeLintYml: z.boolean().optional(),
|
|
33
|
+
excludeReleases: z.boolean().optional(),
|
|
34
|
+
excludeRenovate: z.boolean().optional(),
|
|
35
|
+
excludeTests: z.boolean().optional(),
|
|
36
|
+
funding: z.string().optional(),
|
|
37
|
+
keywords: z.array(z.string()).optional(),
|
|
38
|
+
logo: z.string().optional(),
|
|
39
|
+
logoAlt: z.string().optional(),
|
|
40
|
+
mode: z.union([z.literal("create"), z.literal("initialize"), z.literal("migrate")]).optional(),
|
|
41
|
+
offline: z.boolean().optional(),
|
|
42
|
+
owner: z.string().optional(),
|
|
43
|
+
repository: z.string().optional(),
|
|
44
|
+
skipAllContributorsApi: z.boolean().optional(),
|
|
45
|
+
skipGitHubApi: z.boolean().optional(),
|
|
46
|
+
skipInstall: z.boolean().optional(),
|
|
47
|
+
skipRemoval: z.boolean().optional(),
|
|
48
|
+
skipRestore: z.boolean().optional(),
|
|
49
|
+
skipUninstall: z.boolean().optional(),
|
|
50
|
+
title: z.string().optional()
|
|
51
|
+
};
|
|
52
|
+
const optionsSchema = z.object(optionsSchemaShape);
|
|
53
|
+
export {
|
|
54
|
+
optionsSchema,
|
|
55
|
+
optionsSchemaShape
|
|
56
|
+
};
|
|
57
|
+
//# sourceMappingURL=optionsSchema.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../../src/shared/options/optionsSchema.ts"],"sourcesContent":["import { z } from \"zod\";\n\nexport const optionsSchemaShape = {\n\taccess: z.union([z.literal(\"public\"), z.literal(\"restricted\")]).optional(),\n\tauthor: z.string().optional(),\n\tbase: z\n\t\t.union([\n\t\t\tz.literal(\"common\"),\n\t\t\tz.literal(\"everything\"),\n\t\t\tz.literal(\"minimum\"),\n\t\t\tz.literal(\"prompt\"),\n\t\t])\n\t\t.optional(),\n\tdescription: z.string().optional(),\n\tdirectory: z.string().optional(),\n\temail: z\n\t\t.object({\n\t\t\tgithub: z.string().email(),\n\t\t\tnpm: z.string().email(),\n\t\t})\n\t\t.optional(),\n\texcludeAllContributors: z.boolean().optional(),\n\texcludeCompliance: z.boolean().optional(),\n\texcludeLintDeprecation: z.boolean().optional(),\n\texcludeLintESLint: z.boolean().optional(),\n\texcludeLintJSDoc: z.boolean().optional(),\n\texcludeLintJson: z.boolean().optional(),\n\texcludeLintKnip: z.boolean().optional(),\n\texcludeLintMd: z.boolean().optional(),\n\texcludeLintPackageJson: z.boolean().optional(),\n\texcludeLintPackages: z.boolean().optional(),\n\texcludeLintPerfectionist: z.boolean().optional(),\n\texcludeLintRegex: z.boolean().optional(),\n\texcludeLintSpelling: z.boolean().optional(),\n\texcludeLintStrict: z.boolean().optional(),\n\texcludeLintStylistic: z.boolean().optional(),\n\texcludeLintYml: z.boolean().optional(),\n\texcludeReleases: z.boolean().optional(),\n\texcludeRenovate: z.boolean().optional(),\n\texcludeTests: z.boolean().optional(),\n\tfunding: z.string().optional(),\n\tkeywords: z.array(z.string()).optional(),\n\tlogo: z.string().optional(),\n\tlogoAlt: z.string().optional(),\n\tmode: z\n\t\t.union([z.literal(\"create\"), z.literal(\"initialize\"), z.literal(\"migrate\")])\n\t\t.optional(),\n\toffline: z.boolean().optional(),\n\towner: z.string().optional(),\n\trepository: z.string().optional(),\n\tskipAllContributorsApi: z.boolean().optional(),\n\tskipGitHubApi: z.boolean().optional(),\n\tskipInstall: z.boolean().optional(),\n\tskipRemoval: z.boolean().optional(),\n\tskipRestore: z.boolean().optional(),\n\tskipUninstall: z.boolean().optional(),\n\ttitle: z.string().optional(),\n};\n\nexport const optionsSchema = z.object(optionsSchemaShape);\n"],"mappings":"AAAA,SAAS,SAAS;AAEX,MAAM,qBAAqB;AAAA,EACjC,QAAQ,EAAE,MAAM,CAAC,EAAE,QAAQ,QAAQ,GAAG,EAAE,QAAQ,YAAY,CAAC,CAAC,EAAE,SAAS;AAAA,EACzE,QAAQ,EAAE,OAAO,EAAE,SAAS;AAAA,EAC5B,MAAM,EACJ,MAAM;AAAA,IACN,EAAE,QAAQ,QAAQ;AAAA,IAClB,EAAE,QAAQ,YAAY;AAAA,IACtB,EAAE,QAAQ,SAAS;AAAA,IACnB,EAAE,QAAQ,QAAQ;AAAA,EACnB,CAAC,EACA,SAAS;AAAA,EACX,aAAa,EAAE,OAAO,EAAE,SAAS;AAAA,EACjC,WAAW,EAAE,OAAO,EAAE,SAAS;AAAA,EAC/B,OAAO,EACL,OAAO;AAAA,IACP,QAAQ,EAAE,OAAO,EAAE,MAAM;AAAA,IACzB,KAAK,EAAE,OAAO,EAAE,MAAM;AAAA,EACvB,CAAC,EACA,SAAS;AAAA,EACX,wBAAwB,EAAE,QAAQ,EAAE,SAAS;AAAA,EAC7C,mBAAmB,EAAE,QAAQ,EAAE,SAAS;AAAA,EACxC,wBAAwB,EAAE,QAAQ,EAAE,SAAS;AAAA,EAC7C,mBAAmB,EAAE,QAAQ,EAAE,SAAS;AAAA,EACxC,kBAAkB,EAAE,QAAQ,EAAE,SAAS;AAAA,EACvC,iBAAiB,EAAE,QAAQ,EAAE,SAAS;AAAA,EACtC,iBAAiB,EAAE,QAAQ,EAAE,SAAS;AAAA,EACtC,eAAe,EAAE,QAAQ,EAAE,SAAS;AAAA,EACpC,wBAAwB,EAAE,QAAQ,EAAE,SAAS;AAAA,EAC7C,qBAAqB,EAAE,QAAQ,EAAE,SAAS;AAAA,EAC1C,0BAA0B,EAAE,QAAQ,EAAE,SAAS;AAAA,EAC/C,kBAAkB,EAAE,QAAQ,EAAE,SAAS;AAAA,EACvC,qBAAqB,EAAE,QAAQ,EAAE,SAAS;AAAA,EAC1C,mBAAmB,EAAE,QAAQ,EAAE,SAAS;AAAA,EACxC,sBAAsB,EAAE,QAAQ,EAAE,SAAS;AAAA,EAC3C,gBAAgB,EAAE,QAAQ,EAAE,SAAS;AAAA,EACrC,iBAAiB,EAAE,QAAQ,EAAE,SAAS;AAAA,EACtC,iBAAiB,EAAE,QAAQ,EAAE,SAAS;AAAA,EACtC,cAAc,EAAE,QAAQ,EAAE,SAAS;AAAA,EACnC,SAAS,EAAE,OAAO,EAAE,SAAS;AAAA,EAC7B,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,SAAS;AAAA,EACvC,MAAM,EAAE,OAAO,EAAE,SAAS;AAAA,EAC1B,SAAS,EAAE,OAAO,EAAE,SAAS;AAAA,EAC7B,MAAM,EACJ,MAAM,CAAC,EAAE,QAAQ,QAAQ,GAAG,EAAE,QAAQ,YAAY,GAAG,EAAE,QAAQ,SAAS,CAAC,CAAC,EAC1E,SAAS;AAAA,EACX,SAAS,EAAE,QAAQ,EAAE,SAAS;AAAA,EAC9B,OAAO,EAAE,OAAO,EAAE,SAAS;AAAA,EAC3B,YAAY,EAAE,OAAO,EAAE,SAAS;AAAA,EAChC,wBAAwB,EAAE,QAAQ,EAAE,SAAS;AAAA,EAC7C,eAAe,EAAE,QAAQ,EAAE,SAAS;AAAA,EACpC,aAAa,EAAE,QAAQ,EAAE,SAAS;AAAA,EAClC,aAAa,EAAE,QAAQ,EAAE,SAAS;AAAA,EAClC,aAAa,EAAE,QAAQ,EAAE,SAAS;AAAA,EAClC,eAAe,EAAE,QAAQ,EAAE,SAAS;AAAA,EACpC,OAAO,EAAE,OAAO,EAAE,SAAS;AAC5B;AAEO,MAAM,gBAAgB,EAAE,OAAO,kBAAkB;","names":[]}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { z } from 'zod';
|
|
2
|
-
import { Options } from '../types.js';
|
|
2
|
+
import { Options, Mode, PromptedOptions } from '../types.js';
|
|
3
3
|
import { GitHub } from './getGitHub.js';
|
|
4
|
+
import '../codes.js';
|
|
4
5
|
import 'octokit';
|
|
5
6
|
|
|
6
7
|
interface GitHubAndOptions {
|
|
@@ -9,13 +10,13 @@ interface GitHubAndOptions {
|
|
|
9
10
|
}
|
|
10
11
|
interface OptionsParseCancelled {
|
|
11
12
|
cancelled: true;
|
|
13
|
+
error?: string | z.ZodError<object>;
|
|
12
14
|
options: object;
|
|
13
|
-
zodError?: z.ZodError<object>;
|
|
14
15
|
}
|
|
15
16
|
interface OptionsParseSuccess extends GitHubAndOptions {
|
|
16
17
|
cancelled: false;
|
|
17
18
|
}
|
|
18
19
|
type OptionsParseResult = OptionsParseCancelled | OptionsParseSuccess;
|
|
19
|
-
declare function readOptions(args: string[]): Promise<OptionsParseResult>;
|
|
20
|
+
declare function readOptions(args: string[], mode: Mode, promptedOptions?: PromptedOptions): Promise<OptionsParseResult>;
|
|
20
21
|
|
|
21
22
|
export { GitHubAndOptions, OptionsParseCancelled, OptionsParseResult, OptionsParseSuccess, readOptions };
|
|
@@ -1,15 +1,16 @@
|
|
|
1
1
|
import { parseArgs } from "node:util";
|
|
2
2
|
import { titleCase } from "title-case";
|
|
3
|
-
import { z } from "zod";
|
|
4
3
|
import { withSpinner } from "../cli/spinners.js";
|
|
5
4
|
import { allArgOptions } from "./args.js";
|
|
6
5
|
import { augmentOptionsWithExcludes } from "./augmentOptionsWithExcludes.js";
|
|
6
|
+
import { createOptionDefaults } from "./createOptionDefaults/index.js";
|
|
7
|
+
import { detectEmailRedundancy } from "./detectEmailRedundancy.js";
|
|
7
8
|
import { ensureRepositoryExists } from "./ensureRepositoryExists.js";
|
|
8
9
|
import { getGitHub } from "./getGitHub.js";
|
|
9
10
|
import { getPrefillOrPromptedOption } from "./getPrefillOrPromptedOption.js";
|
|
10
|
-
import {
|
|
11
|
-
async function readOptions(args) {
|
|
12
|
-
const defaults =
|
|
11
|
+
import { optionsSchema } from "./optionsSchema.js";
|
|
12
|
+
async function readOptions(args, mode, promptedOptions = {}) {
|
|
13
|
+
const defaults = createOptionDefaults(promptedOptions);
|
|
13
14
|
const { values } = parseArgs({
|
|
14
15
|
args,
|
|
15
16
|
options: allArgOptions,
|
|
@@ -17,45 +18,63 @@ async function readOptions(args) {
|
|
|
17
18
|
tokens: true
|
|
18
19
|
});
|
|
19
20
|
const mappedOptions = {
|
|
21
|
+
access: values.access,
|
|
20
22
|
author: values.author,
|
|
21
23
|
base: values.base,
|
|
22
|
-
createRepository: values["create-repository"],
|
|
23
24
|
description: values.description,
|
|
24
|
-
|
|
25
|
+
directory: values.directory,
|
|
26
|
+
email: values.email ?? values["email-github"] ?? values["email-npm"] ? {
|
|
27
|
+
github: values.email ?? values["email-github"],
|
|
28
|
+
npm: values.email ?? values["email-npm"]
|
|
29
|
+
} : void 0,
|
|
30
|
+
excludeAllContributors: values["exclude-all-contributors"],
|
|
25
31
|
excludeCompliance: values["exclude-compliance"],
|
|
26
|
-
|
|
32
|
+
excludeLintDeprecation: values["exclude-lint-deprecation"],
|
|
33
|
+
excludeLintESLint: values["exclude-lint-eslint"],
|
|
34
|
+
excludeLintJSDoc: values["exclude-lint-jsdoc"],
|
|
27
35
|
excludeLintJson: values["exclude-lint-json"],
|
|
28
36
|
excludeLintKnip: values["exclude-lint-knip"],
|
|
29
37
|
excludeLintMd: values["exclude-lint-md"],
|
|
30
38
|
excludeLintPackageJson: values["exclude-lint-package-json"],
|
|
31
39
|
excludeLintPackages: values["exclude-lint-packages"],
|
|
32
40
|
excludeLintPerfectionist: values["exclude-lint-perfectionist"],
|
|
41
|
+
excludeLintRegex: values["exclude-lint-regex"],
|
|
33
42
|
excludeLintSpelling: values["exclude-lint-spelling"],
|
|
43
|
+
excludeLintStrict: values["exclude-lint-strict"],
|
|
34
44
|
excludeLintYml: values["exclude-lint-yml"],
|
|
35
45
|
excludeReleases: values["exclude-releases"],
|
|
36
46
|
excludeRenovate: values["exclude-renovate"],
|
|
37
47
|
excludeTests: values["unit-tests"],
|
|
38
48
|
funding: values.funding,
|
|
49
|
+
offline: values.offline,
|
|
39
50
|
owner: values.owner,
|
|
40
51
|
repository: values.repository,
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
52
|
+
skipAllContributorsApi: values["skip-all-contributors-api"] ?? values.offline,
|
|
53
|
+
skipGitHubApi: values["skip-github-api"] ?? values.offline,
|
|
54
|
+
skipInstall: values["skip-install"],
|
|
55
|
+
skipRemoval: values["skip-removal"],
|
|
44
56
|
skipRestore: values["skip-restore"],
|
|
45
|
-
skipUninstall:
|
|
57
|
+
skipUninstall: values["skip-uninstall"],
|
|
46
58
|
title: values.title
|
|
47
59
|
};
|
|
60
|
+
const emailError = detectEmailRedundancy(values);
|
|
61
|
+
if (emailError) {
|
|
62
|
+
return {
|
|
63
|
+
cancelled: true,
|
|
64
|
+
error: emailError,
|
|
65
|
+
options: mappedOptions
|
|
66
|
+
};
|
|
67
|
+
}
|
|
48
68
|
const optionsParseResult = optionsSchema.safeParse(mappedOptions);
|
|
49
69
|
if (!optionsParseResult.success) {
|
|
50
70
|
return {
|
|
51
71
|
cancelled: true,
|
|
52
|
-
|
|
53
|
-
|
|
72
|
+
error: optionsParseResult.error,
|
|
73
|
+
options: mappedOptions
|
|
54
74
|
};
|
|
55
75
|
}
|
|
56
76
|
const options = optionsParseResult.data;
|
|
57
77
|
options.owner ??= await getPrefillOrPromptedOption(
|
|
58
|
-
options.owner,
|
|
59
78
|
"What organization or user will the repository be under?",
|
|
60
79
|
defaults.owner
|
|
61
80
|
);
|
|
@@ -66,7 +85,6 @@ async function readOptions(args) {
|
|
|
66
85
|
};
|
|
67
86
|
}
|
|
68
87
|
options.repository ??= await getPrefillOrPromptedOption(
|
|
69
|
-
options.repository,
|
|
70
88
|
"What will the kebab-case name of the repository be?",
|
|
71
89
|
defaults.repository
|
|
72
90
|
);
|
|
@@ -77,9 +95,9 @@ async function readOptions(args) {
|
|
|
77
95
|
};
|
|
78
96
|
}
|
|
79
97
|
const { github, repository } = await ensureRepositoryExists(
|
|
80
|
-
|
|
98
|
+
options.skipGitHubApi ? void 0 : await withSpinner("Checking GitHub authentication", getGitHub),
|
|
81
99
|
{
|
|
82
|
-
|
|
100
|
+
mode,
|
|
83
101
|
owner: options.owner,
|
|
84
102
|
repository: options.repository
|
|
85
103
|
}
|
|
@@ -88,7 +106,6 @@ async function readOptions(args) {
|
|
|
88
106
|
return { cancelled: true, options };
|
|
89
107
|
}
|
|
90
108
|
options.description ??= await getPrefillOrPromptedOption(
|
|
91
|
-
options.description,
|
|
92
109
|
"How would you describe the new package?",
|
|
93
110
|
async () => await defaults.description() ?? "A very lovely package. Hooray!"
|
|
94
111
|
);
|
|
@@ -96,7 +113,6 @@ async function readOptions(args) {
|
|
|
96
113
|
return { cancelled: true, options };
|
|
97
114
|
}
|
|
98
115
|
options.title ??= await getPrefillOrPromptedOption(
|
|
99
|
-
options.title,
|
|
100
116
|
"What will the Title Case title of the repository be?",
|
|
101
117
|
async () => await defaults.title() ?? titleCase(repository).replaceAll("-", " ")
|
|
102
118
|
);
|
|
@@ -105,8 +121,7 @@ async function readOptions(args) {
|
|
|
105
121
|
}
|
|
106
122
|
let logo;
|
|
107
123
|
if (options.logo) {
|
|
108
|
-
const alt = await getPrefillOrPromptedOption(
|
|
109
|
-
options.logoAlt,
|
|
124
|
+
const alt = options.logoAlt ?? await getPrefillOrPromptedOption(
|
|
110
125
|
"What is the alt text (non-visual description) of the logo?"
|
|
111
126
|
);
|
|
112
127
|
if (!alt) {
|
|
@@ -114,13 +129,22 @@ async function readOptions(args) {
|
|
|
114
129
|
}
|
|
115
130
|
logo = { alt, src: options.logo };
|
|
116
131
|
}
|
|
132
|
+
const email = options.email ?? await defaults.email() ?? await getPrefillOrPromptedOption(
|
|
133
|
+
"What email should be used in package.json and .md files?"
|
|
134
|
+
);
|
|
135
|
+
if (!email) {
|
|
136
|
+
return { cancelled: true, options };
|
|
137
|
+
}
|
|
117
138
|
const augmentedOptions = await augmentOptionsWithExcludes({
|
|
118
139
|
...options,
|
|
140
|
+
access: options.access ?? "public",
|
|
119
141
|
author: options.author ?? await defaults.owner(),
|
|
120
142
|
description: options.description,
|
|
121
|
-
|
|
143
|
+
directory: options.directory ?? promptedOptions.directory ?? options.repository,
|
|
144
|
+
email: typeof email === "string" ? { github: email, npm: email } : email,
|
|
122
145
|
funding: options.funding ?? await defaults.funding(),
|
|
123
146
|
logo,
|
|
147
|
+
mode,
|
|
124
148
|
owner: options.owner,
|
|
125
149
|
repository,
|
|
126
150
|
title: options.title
|
|
@@ -137,42 +161,6 @@ async function readOptions(args) {
|
|
|
137
161
|
options: augmentedOptions
|
|
138
162
|
};
|
|
139
163
|
}
|
|
140
|
-
const optionsSchema = z.object({
|
|
141
|
-
author: z.string().optional(),
|
|
142
|
-
base: z.union([
|
|
143
|
-
z.literal("common"),
|
|
144
|
-
z.literal("everything"),
|
|
145
|
-
z.literal("minimum"),
|
|
146
|
-
z.literal("prompt")
|
|
147
|
-
]).optional(),
|
|
148
|
-
createRepository: z.boolean().optional(),
|
|
149
|
-
description: z.string().optional(),
|
|
150
|
-
email: z.string().email().optional(),
|
|
151
|
-
excludeCompliance: z.boolean().optional(),
|
|
152
|
-
excludeContributors: z.boolean().optional(),
|
|
153
|
-
excludeLintJson: z.boolean().optional(),
|
|
154
|
-
excludeLintKnip: z.boolean().optional(),
|
|
155
|
-
excludeLintMd: z.boolean().optional(),
|
|
156
|
-
excludeLintPackageJson: z.boolean().optional(),
|
|
157
|
-
excludeLintPackages: z.boolean().optional(),
|
|
158
|
-
excludeLintPerfectionist: z.boolean().optional(),
|
|
159
|
-
excludeLintSpelling: z.boolean().optional(),
|
|
160
|
-
excludeLintYml: z.boolean().optional(),
|
|
161
|
-
excludeReleases: z.boolean().optional(),
|
|
162
|
-
excludeRenovate: z.boolean().optional(),
|
|
163
|
-
excludeTests: z.boolean().optional(),
|
|
164
|
-
funding: z.string().optional(),
|
|
165
|
-
logo: z.string().optional(),
|
|
166
|
-
logoAlt: z.string().optional(),
|
|
167
|
-
owner: z.string().optional(),
|
|
168
|
-
repository: z.string().optional(),
|
|
169
|
-
skipGitHubApi: z.boolean(),
|
|
170
|
-
skipInstall: z.boolean(),
|
|
171
|
-
skipRemoval: z.boolean(),
|
|
172
|
-
skipRestore: z.boolean().optional(),
|
|
173
|
-
skipUninstall: z.boolean(),
|
|
174
|
-
title: z.string().optional()
|
|
175
|
-
});
|
|
176
164
|
export {
|
|
177
165
|
readOptions
|
|
178
166
|
};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../src/shared/options/readOptions.ts"],"sourcesContent":["import { parseArgs } from \"node:util\";\nimport { titleCase } from \"title-case\";\nimport { z } from \"zod\";\n\nimport { withSpinner } from \"../cli/spinners.js\";\nimport { Options, OptionsLogo } from \"../types.js\";\nimport { allArgOptions } from \"./args.js\";\nimport { augmentOptionsWithExcludes } from \"./augmentOptionsWithExcludes.js\";\nimport { ensureRepositoryExists } from \"./ensureRepositoryExists.js\";\nimport { GitHub, getGitHub } from \"./getGitHub.js\";\nimport { getPrefillOrPromptedOption } from \"./getPrefillOrPromptedOption.js\";\nimport { getGitAndNpmDefaults } from \"./readOptionDefaults/index.js\";\n\nexport interface GitHubAndOptions {\n\tgithub: GitHub | undefined;\n\toptions: Options;\n}\n\nexport interface OptionsParseCancelled {\n\tcancelled: true;\n\toptions: object;\n\tzodError?: z.ZodError<object>;\n}\n\nexport interface OptionsParseSuccess extends GitHubAndOptions {\n\tcancelled: false;\n}\n\nexport type OptionsParseResult = OptionsParseCancelled | OptionsParseSuccess;\n\nexport async function readOptions(args: string[]): Promise<OptionsParseResult> {\n\tconst defaults = getGitAndNpmDefaults();\n\tconst { values } = parseArgs({\n\t\targs,\n\t\toptions: allArgOptions,\n\t\tstrict: false,\n\t\ttokens: true,\n\t});\n\n\tconst mappedOptions = {\n\t\tauthor: values.author,\n\t\tbase: values.base,\n\t\tcreateRepository: values[\"create-repository\"],\n\t\tdescription: values.description,\n\t\temail: values.email,\n\t\texcludeCompliance: values[\"exclude-compliance\"],\n\t\texcludeContributors: values[\"exclude-contributors\"],\n\t\texcludeLintJson: values[\"exclude-lint-json\"],\n\t\texcludeLintKnip: values[\"exclude-lint-knip\"],\n\t\texcludeLintMd: values[\"exclude-lint-md\"],\n\t\texcludeLintPackageJson: values[\"exclude-lint-package-json\"],\n\t\texcludeLintPackages: values[\"exclude-lint-packages\"],\n\t\texcludeLintPerfectionist: values[\"exclude-lint-perfectionist\"],\n\t\texcludeLintSpelling: values[\"exclude-lint-spelling\"],\n\t\texcludeLintYml: values[\"exclude-lint-yml\"],\n\t\texcludeReleases: values[\"exclude-releases\"],\n\t\texcludeRenovate: values[\"exclude-renovate\"],\n\t\texcludeTests: values[\"unit-tests\"],\n\t\tfunding: values.funding,\n\t\towner: values.owner,\n\t\trepository: values.repository,\n\t\tskipGitHubApi: !!values[\"skip-github-api\"],\n\t\tskipInstall: !!values[\"skip-install\"],\n\t\tskipRemoval: !!values[\"skip-removal\"],\n\t\tskipRestore: values[\"skip-restore\"],\n\t\tskipUninstall: !!values[\"skip-uninstall\"],\n\t\ttitle: values.title,\n\t};\n\n\tconst optionsParseResult = optionsSchema.safeParse(mappedOptions);\n\n\tif (!optionsParseResult.success) {\n\t\treturn {\n\t\t\tcancelled: true,\n\t\t\toptions: mappedOptions,\n\t\t\tzodError: optionsParseResult.error,\n\t\t};\n\t}\n\n\tconst options = optionsParseResult.data;\n\n\toptions.owner ??= await getPrefillOrPromptedOption(\n\t\toptions.owner,\n\t\t\"What organization or user will the repository be under?\",\n\t\tdefaults.owner,\n\t);\n\tif (!options.owner) {\n\t\treturn {\n\t\t\tcancelled: true,\n\t\t\toptions,\n\t\t};\n\t}\n\n\toptions.repository ??= await getPrefillOrPromptedOption(\n\t\toptions.repository,\n\t\t\"What will the kebab-case name of the repository be?\",\n\t\tdefaults.repository,\n\t);\n\tif (!options.repository) {\n\t\treturn {\n\t\t\tcancelled: true,\n\t\t\toptions,\n\t\t};\n\t}\n\n\tconst { github, repository } = await ensureRepositoryExists(\n\t\tvalues[\"skip-github-api\"]\n\t\t\t? undefined\n\t\t\t: await withSpinner(\"Checking GitHub authentication\", getGitHub),\n\t\t{\n\t\t\tcreateRepository: options.createRepository,\n\t\t\towner: options.owner,\n\t\t\trepository: options.repository,\n\t\t},\n\t);\n\tif (!repository) {\n\t\treturn { cancelled: true, options };\n\t}\n\n\toptions.description ??= await getPrefillOrPromptedOption(\n\t\toptions.description,\n\t\t\"How would you describe the new package?\",\n\t\tasync () =>\n\t\t\t(await defaults.description()) ?? \"A very lovely package. Hooray!\",\n\t);\n\tif (!options.description) {\n\t\treturn { cancelled: true, options };\n\t}\n\n\toptions.title ??= await getPrefillOrPromptedOption(\n\t\toptions.title,\n\t\t\"What will the Title Case title of the repository be?\",\n\t\tasync () =>\n\t\t\t(await defaults.title()) ?? titleCase(repository).replaceAll(\"-\", \" \"),\n\t);\n\tif (!options.title) {\n\t\treturn { cancelled: true, options };\n\t}\n\n\tlet logo: OptionsLogo | undefined;\n\n\tif (options.logo) {\n\t\tconst alt = await getPrefillOrPromptedOption(\n\t\t\toptions.logoAlt,\n\t\t\t\"What is the alt text (non-visual description) of the logo?\",\n\t\t);\n\t\tif (!alt) {\n\t\t\treturn { cancelled: true, options };\n\t\t}\n\n\t\tlogo = { alt, src: options.logo };\n\t}\n\n\tconst augmentedOptions = await augmentOptionsWithExcludes({\n\t\t...options,\n\t\tauthor: options.author ?? (await defaults.owner()),\n\t\tdescription: options.description,\n\t\temail: options.email ?? (await defaults.email()),\n\t\tfunding: options.funding ?? (await defaults.funding()),\n\t\tlogo,\n\t\towner: options.owner,\n\t\trepository,\n\t\ttitle: options.title,\n\t});\n\n\tif (!augmentedOptions) {\n\t\treturn {\n\t\t\tcancelled: true,\n\t\t\toptions,\n\t\t};\n\t}\n\n\treturn {\n\t\tcancelled: false,\n\t\tgithub,\n\t\toptions: augmentedOptions,\n\t};\n}\n\nconst optionsSchema = z.object({\n\tauthor: z.string().optional(),\n\tbase: z\n\t\t.union([\n\t\t\tz.literal(\"common\"),\n\t\t\tz.literal(\"everything\"),\n\t\t\tz.literal(\"minimum\"),\n\t\t\tz.literal(\"prompt\"),\n\t\t])\n\t\t.optional(),\n\tcreateRepository: z.boolean().optional(),\n\tdescription: z.string().optional(),\n\temail: z.string().email().optional(),\n\texcludeCompliance: z.boolean().optional(),\n\texcludeContributors: z.boolean().optional(),\n\texcludeLintJson: z.boolean().optional(),\n\texcludeLintKnip: z.boolean().optional(),\n\texcludeLintMd: z.boolean().optional(),\n\texcludeLintPackageJson: z.boolean().optional(),\n\texcludeLintPackages: z.boolean().optional(),\n\texcludeLintPerfectionist: z.boolean().optional(),\n\texcludeLintSpelling: z.boolean().optional(),\n\texcludeLintYml: z.boolean().optional(),\n\texcludeReleases: z.boolean().optional(),\n\texcludeRenovate: z.boolean().optional(),\n\texcludeTests: z.boolean().optional(),\n\tfunding: z.string().optional(),\n\tlogo: z.string().optional(),\n\tlogoAlt: z.string().optional(),\n\towner: z.string().optional(),\n\trepository: z.string().optional(),\n\tskipGitHubApi: z.boolean(),\n\tskipInstall: z.boolean(),\n\tskipRemoval: z.boolean(),\n\tskipRestore: z.boolean().optional(),\n\tskipUninstall: z.boolean(),\n\ttitle: z.string().optional(),\n});\n"],"mappings":"AAAA,SAAS,iBAAiB;AAC1B,SAAS,iBAAiB;AAC1B,SAAS,SAAS;AAElB,SAAS,mBAAmB;AAE5B,SAAS,qBAAqB;AAC9B,SAAS,kCAAkC;AAC3C,SAAS,8BAA8B;AACvC,SAAiB,iBAAiB;AAClC,SAAS,kCAAkC;AAC3C,SAAS,4BAA4B;AAmBrC,eAAsB,YAAY,MAA6C;AAC9E,QAAM,WAAW,qBAAqB;AACtC,QAAM,EAAE,OAAO,IAAI,UAAU;AAAA,IAC5B;AAAA,IACA,SAAS;AAAA,IACT,QAAQ;AAAA,IACR,QAAQ;AAAA,EACT,CAAC;AAED,QAAM,gBAAgB;AAAA,IACrB,QAAQ,OAAO;AAAA,IACf,MAAM,OAAO;AAAA,IACb,kBAAkB,OAAO,mBAAmB;AAAA,IAC5C,aAAa,OAAO;AAAA,IACpB,OAAO,OAAO;AAAA,IACd,mBAAmB,OAAO,oBAAoB;AAAA,IAC9C,qBAAqB,OAAO,sBAAsB;AAAA,IAClD,iBAAiB,OAAO,mBAAmB;AAAA,IAC3C,iBAAiB,OAAO,mBAAmB;AAAA,IAC3C,eAAe,OAAO,iBAAiB;AAAA,IACvC,wBAAwB,OAAO,2BAA2B;AAAA,IAC1D,qBAAqB,OAAO,uBAAuB;AAAA,IACnD,0BAA0B,OAAO,4BAA4B;AAAA,IAC7D,qBAAqB,OAAO,uBAAuB;AAAA,IACnD,gBAAgB,OAAO,kBAAkB;AAAA,IACzC,iBAAiB,OAAO,kBAAkB;AAAA,IAC1C,iBAAiB,OAAO,kBAAkB;AAAA,IAC1C,cAAc,OAAO,YAAY;AAAA,IACjC,SAAS,OAAO;AAAA,IAChB,OAAO,OAAO;AAAA,IACd,YAAY,OAAO;AAAA,IACnB,eAAe,CAAC,CAAC,OAAO,iBAAiB;AAAA,IACzC,aAAa,CAAC,CAAC,OAAO,cAAc;AAAA,IACpC,aAAa,CAAC,CAAC,OAAO,cAAc;AAAA,IACpC,aAAa,OAAO,cAAc;AAAA,IAClC,eAAe,CAAC,CAAC,OAAO,gBAAgB;AAAA,IACxC,OAAO,OAAO;AAAA,EACf;AAEA,QAAM,qBAAqB,cAAc,UAAU,aAAa;AAEhE,MAAI,CAAC,mBAAmB,SAAS;AAChC,WAAO;AAAA,MACN,WAAW;AAAA,MACX,SAAS;AAAA,MACT,UAAU,mBAAmB;AAAA,IAC9B;AAAA,EACD;AAEA,QAAM,UAAU,mBAAmB;AAEnC,UAAQ,UAAU,MAAM;AAAA,IACvB,QAAQ;AAAA,IACR;AAAA,IACA,SAAS;AAAA,EACV;AACA,MAAI,CAAC,QAAQ,OAAO;AACnB,WAAO;AAAA,MACN,WAAW;AAAA,MACX;AAAA,IACD;AAAA,EACD;AAEA,UAAQ,eAAe,MAAM;AAAA,IAC5B,QAAQ;AAAA,IACR;AAAA,IACA,SAAS;AAAA,EACV;AACA,MAAI,CAAC,QAAQ,YAAY;AACxB,WAAO;AAAA,MACN,WAAW;AAAA,MACX;AAAA,IACD;AAAA,EACD;AAEA,QAAM,EAAE,QAAQ,WAAW,IAAI,MAAM;AAAA,IACpC,OAAO,iBAAiB,IACrB,SACA,MAAM,YAAY,kCAAkC,SAAS;AAAA,IAChE;AAAA,MACC,kBAAkB,QAAQ;AAAA,MAC1B,OAAO,QAAQ;AAAA,MACf,YAAY,QAAQ;AAAA,IACrB;AAAA,EACD;AACA,MAAI,CAAC,YAAY;AAChB,WAAO,EAAE,WAAW,MAAM,QAAQ;AAAA,EACnC;AAEA,UAAQ,gBAAgB,MAAM;AAAA,IAC7B,QAAQ;AAAA,IACR;AAAA,IACA,YACE,MAAM,SAAS,YAAY,KAAM;AAAA,EACpC;AACA,MAAI,CAAC,QAAQ,aAAa;AACzB,WAAO,EAAE,WAAW,MAAM,QAAQ;AAAA,EACnC;AAEA,UAAQ,UAAU,MAAM;AAAA,IACvB,QAAQ;AAAA,IACR;AAAA,IACA,YACE,MAAM,SAAS,MAAM,KAAM,UAAU,UAAU,EAAE,WAAW,KAAK,GAAG;AAAA,EACvE;AACA,MAAI,CAAC,QAAQ,OAAO;AACnB,WAAO,EAAE,WAAW,MAAM,QAAQ;AAAA,EACnC;AAEA,MAAI;AAEJ,MAAI,QAAQ,MAAM;AACjB,UAAM,MAAM,MAAM;AAAA,MACjB,QAAQ;AAAA,MACR;AAAA,IACD;AACA,QAAI,CAAC,KAAK;AACT,aAAO,EAAE,WAAW,MAAM,QAAQ;AAAA,IACnC;AAEA,WAAO,EAAE,KAAK,KAAK,QAAQ,KAAK;AAAA,EACjC;AAEA,QAAM,mBAAmB,MAAM,2BAA2B;AAAA,IACzD,GAAG;AAAA,IACH,QAAQ,QAAQ,UAAW,MAAM,SAAS,MAAM;AAAA,IAChD,aAAa,QAAQ;AAAA,IACrB,OAAO,QAAQ,SAAU,MAAM,SAAS,MAAM;AAAA,IAC9C,SAAS,QAAQ,WAAY,MAAM,SAAS,QAAQ;AAAA,IACpD;AAAA,IACA,OAAO,QAAQ;AAAA,IACf;AAAA,IACA,OAAO,QAAQ;AAAA,EAChB,CAAC;AAED,MAAI,CAAC,kBAAkB;AACtB,WAAO;AAAA,MACN,WAAW;AAAA,MACX;AAAA,IACD;AAAA,EACD;AAEA,SAAO;AAAA,IACN,WAAW;AAAA,IACX;AAAA,IACA,SAAS;AAAA,EACV;AACD;AAEA,MAAM,gBAAgB,EAAE,OAAO;AAAA,EAC9B,QAAQ,EAAE,OAAO,EAAE,SAAS;AAAA,EAC5B,MAAM,EACJ,MAAM;AAAA,IACN,EAAE,QAAQ,QAAQ;AAAA,IAClB,EAAE,QAAQ,YAAY;AAAA,IACtB,EAAE,QAAQ,SAAS;AAAA,IACnB,EAAE,QAAQ,QAAQ;AAAA,EACnB,CAAC,EACA,SAAS;AAAA,EACX,kBAAkB,EAAE,QAAQ,EAAE,SAAS;AAAA,EACvC,aAAa,EAAE,OAAO,EAAE,SAAS;AAAA,EACjC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS;AAAA,EACnC,mBAAmB,EAAE,QAAQ,EAAE,SAAS;AAAA,EACxC,qBAAqB,EAAE,QAAQ,EAAE,SAAS;AAAA,EAC1C,iBAAiB,EAAE,QAAQ,EAAE,SAAS;AAAA,EACtC,iBAAiB,EAAE,QAAQ,EAAE,SAAS;AAAA,EACtC,eAAe,EAAE,QAAQ,EAAE,SAAS;AAAA,EACpC,wBAAwB,EAAE,QAAQ,EAAE,SAAS;AAAA,EAC7C,qBAAqB,EAAE,QAAQ,EAAE,SAAS;AAAA,EAC1C,0BAA0B,EAAE,QAAQ,EAAE,SAAS;AAAA,EAC/C,qBAAqB,EAAE,QAAQ,EAAE,SAAS;AAAA,EAC1C,gBAAgB,EAAE,QAAQ,EAAE,SAAS;AAAA,EACrC,iBAAiB,EAAE,QAAQ,EAAE,SAAS;AAAA,EACtC,iBAAiB,EAAE,QAAQ,EAAE,SAAS;AAAA,EACtC,cAAc,EAAE,QAAQ,EAAE,SAAS;AAAA,EACnC,SAAS,EAAE,OAAO,EAAE,SAAS;AAAA,EAC7B,MAAM,EAAE,OAAO,EAAE,SAAS;AAAA,EAC1B,SAAS,EAAE,OAAO,EAAE,SAAS;AAAA,EAC7B,OAAO,EAAE,OAAO,EAAE,SAAS;AAAA,EAC3B,YAAY,EAAE,OAAO,EAAE,SAAS;AAAA,EAChC,eAAe,EAAE,QAAQ;AAAA,EACzB,aAAa,EAAE,QAAQ;AAAA,EACvB,aAAa,EAAE,QAAQ;AAAA,EACvB,aAAa,EAAE,QAAQ,EAAE,SAAS;AAAA,EAClC,eAAe,EAAE,QAAQ;AAAA,EACzB,OAAO,EAAE,OAAO,EAAE,SAAS;AAC5B,CAAC;","names":[]}
|
|
1
|
+
{"version":3,"sources":["../../../src/shared/options/readOptions.ts"],"sourcesContent":["import { parseArgs } from \"node:util\";\nimport { titleCase } from \"title-case\";\nimport { z } from \"zod\";\n\nimport { withSpinner } from \"../cli/spinners.js\";\nimport { Mode, PromptedOptions } from \"../types.js\";\nimport { Options, OptionsLogo } from \"../types.js\";\nimport { allArgOptions } from \"./args.js\";\nimport { augmentOptionsWithExcludes } from \"./augmentOptionsWithExcludes.js\";\nimport { createOptionDefaults } from \"./createOptionDefaults/index.js\";\nimport { detectEmailRedundancy } from \"./detectEmailRedundancy.js\";\nimport { ensureRepositoryExists } from \"./ensureRepositoryExists.js\";\nimport { GitHub, getGitHub } from \"./getGitHub.js\";\nimport { getPrefillOrPromptedOption } from \"./getPrefillOrPromptedOption.js\";\nimport { optionsSchema } from \"./optionsSchema.js\";\n\nexport interface GitHubAndOptions {\n\tgithub: GitHub | undefined;\n\toptions: Options;\n}\n\nexport interface OptionsParseCancelled {\n\tcancelled: true;\n\terror?: string | z.ZodError<object>;\n\toptions: object;\n}\n\nexport interface OptionsParseSuccess extends GitHubAndOptions {\n\tcancelled: false;\n}\n\nexport type OptionsParseResult = OptionsParseCancelled | OptionsParseSuccess;\n\nexport async function readOptions(\n\targs: string[],\n\tmode: Mode,\n\tpromptedOptions: PromptedOptions = {},\n): Promise<OptionsParseResult> {\n\tconst defaults = createOptionDefaults(promptedOptions);\n\tconst { values } = parseArgs({\n\t\targs,\n\t\toptions: allArgOptions,\n\t\tstrict: false,\n\t\ttokens: true,\n\t});\n\n\tconst mappedOptions = {\n\t\taccess: values.access,\n\t\tauthor: values.author,\n\t\tbase: values.base,\n\t\tdescription: values.description,\n\t\tdirectory: values.directory,\n\t\temail:\n\t\t\tvalues.email ?? values[\"email-github\"] ?? values[\"email-npm\"]\n\t\t\t\t? {\n\t\t\t\t\t\tgithub: values.email ?? values[\"email-github\"],\n\t\t\t\t\t\tnpm: values.email ?? values[\"email-npm\"],\n\t\t\t\t }\n\t\t\t\t: undefined,\n\t\texcludeAllContributors: values[\"exclude-all-contributors\"],\n\t\texcludeCompliance: values[\"exclude-compliance\"],\n\t\texcludeLintDeprecation: values[\"exclude-lint-deprecation\"],\n\t\texcludeLintESLint: values[\"exclude-lint-eslint\"],\n\t\texcludeLintJSDoc: values[\"exclude-lint-jsdoc\"],\n\t\texcludeLintJson: values[\"exclude-lint-json\"],\n\t\texcludeLintKnip: values[\"exclude-lint-knip\"],\n\t\texcludeLintMd: values[\"exclude-lint-md\"],\n\t\texcludeLintPackageJson: values[\"exclude-lint-package-json\"],\n\t\texcludeLintPackages: values[\"exclude-lint-packages\"],\n\t\texcludeLintPerfectionist: values[\"exclude-lint-perfectionist\"],\n\t\texcludeLintRegex: values[\"exclude-lint-regex\"],\n\t\texcludeLintSpelling: values[\"exclude-lint-spelling\"],\n\t\texcludeLintStrict: values[\"exclude-lint-strict\"],\n\t\texcludeLintYml: values[\"exclude-lint-yml\"],\n\t\texcludeReleases: values[\"exclude-releases\"],\n\t\texcludeRenovate: values[\"exclude-renovate\"],\n\t\texcludeTests: values[\"unit-tests\"],\n\t\tfunding: values.funding,\n\t\toffline: values.offline,\n\t\towner: values.owner,\n\t\trepository: values.repository,\n\t\tskipAllContributorsApi:\n\t\t\tvalues[\"skip-all-contributors-api\"] ?? values.offline,\n\t\tskipGitHubApi: values[\"skip-github-api\"] ?? values.offline,\n\t\tskipInstall: values[\"skip-install\"],\n\t\tskipRemoval: values[\"skip-removal\"],\n\t\tskipRestore: values[\"skip-restore\"],\n\t\tskipUninstall: values[\"skip-uninstall\"],\n\t\ttitle: values.title,\n\t};\n\n\tconst emailError = detectEmailRedundancy(values);\n\tif (emailError) {\n\t\treturn {\n\t\t\tcancelled: true,\n\t\t\terror: emailError,\n\t\t\toptions: mappedOptions,\n\t\t};\n\t}\n\n\tconst optionsParseResult = optionsSchema.safeParse(mappedOptions);\n\n\tif (!optionsParseResult.success) {\n\t\treturn {\n\t\t\tcancelled: true,\n\t\t\terror: optionsParseResult.error,\n\t\t\toptions: mappedOptions,\n\t\t};\n\t}\n\n\tconst options = optionsParseResult.data;\n\n\toptions.owner ??= await getPrefillOrPromptedOption(\n\t\t\"What organization or user will the repository be under?\",\n\t\tdefaults.owner,\n\t);\n\tif (!options.owner) {\n\t\treturn {\n\t\t\tcancelled: true,\n\t\t\toptions,\n\t\t};\n\t}\n\n\toptions.repository ??= await getPrefillOrPromptedOption(\n\t\t\"What will the kebab-case name of the repository be?\",\n\t\tdefaults.repository,\n\t);\n\tif (!options.repository) {\n\t\treturn {\n\t\t\tcancelled: true,\n\t\t\toptions,\n\t\t};\n\t}\n\n\tconst { github, repository } = await ensureRepositoryExists(\n\t\toptions.skipGitHubApi\n\t\t\t? undefined\n\t\t\t: await withSpinner(\"Checking GitHub authentication\", getGitHub),\n\t\t{\n\t\t\tmode,\n\t\t\towner: options.owner,\n\t\t\trepository: options.repository,\n\t\t},\n\t);\n\tif (!repository) {\n\t\treturn { cancelled: true, options };\n\t}\n\n\toptions.description ??= await getPrefillOrPromptedOption(\n\t\t\"How would you describe the new package?\",\n\t\tasync () =>\n\t\t\t(await defaults.description()) ?? \"A very lovely package. Hooray!\",\n\t);\n\tif (!options.description) {\n\t\treturn { cancelled: true, options };\n\t}\n\n\toptions.title ??= await getPrefillOrPromptedOption(\n\t\t\"What will the Title Case title of the repository be?\",\n\t\tasync () =>\n\t\t\t(await defaults.title()) ?? titleCase(repository).replaceAll(\"-\", \" \"),\n\t);\n\tif (!options.title) {\n\t\treturn { cancelled: true, options };\n\t}\n\n\tlet logo: OptionsLogo | undefined;\n\n\tif (options.logo) {\n\t\tconst alt =\n\t\t\toptions.logoAlt ??\n\t\t\t(await getPrefillOrPromptedOption(\n\t\t\t\t\"What is the alt text (non-visual description) of the logo?\",\n\t\t\t));\n\t\tif (!alt) {\n\t\t\treturn { cancelled: true, options };\n\t\t}\n\n\t\tlogo = { alt, src: options.logo };\n\t}\n\n\tconst email =\n\t\toptions.email ??\n\t\t(await defaults.email()) ??\n\t\t(await getPrefillOrPromptedOption(\n\t\t\t\"What email should be used in package.json and .md files?\",\n\t\t));\n\tif (!email) {\n\t\treturn { cancelled: true, options };\n\t}\n\n\tconst augmentedOptions = await augmentOptionsWithExcludes({\n\t\t...options,\n\t\taccess: options.access ?? \"public\",\n\t\tauthor: options.author ?? (await defaults.owner()),\n\t\tdescription: options.description,\n\t\tdirectory:\n\t\t\toptions.directory ?? promptedOptions.directory ?? options.repository,\n\t\temail: typeof email === \"string\" ? { github: email, npm: email } : email,\n\t\tfunding: options.funding ?? (await defaults.funding()),\n\t\tlogo,\n\t\tmode,\n\t\towner: options.owner,\n\t\trepository,\n\t\ttitle: options.title,\n\t});\n\n\tif (!augmentedOptions) {\n\t\treturn {\n\t\t\tcancelled: true,\n\t\t\toptions,\n\t\t};\n\t}\n\n\treturn {\n\t\tcancelled: false,\n\t\tgithub,\n\t\toptions: augmentedOptions,\n\t};\n}\n"],"mappings":"AAAA,SAAS,iBAAiB;AAC1B,SAAS,iBAAiB;AAG1B,SAAS,mBAAmB;AAG5B,SAAS,qBAAqB;AAC9B,SAAS,kCAAkC;AAC3C,SAAS,4BAA4B;AACrC,SAAS,6BAA6B;AACtC,SAAS,8BAA8B;AACvC,SAAiB,iBAAiB;AAClC,SAAS,kCAAkC;AAC3C,SAAS,qBAAqB;AAmB9B,eAAsB,YACrB,MACA,MACA,kBAAmC,CAAC,GACN;AAC9B,QAAM,WAAW,qBAAqB,eAAe;AACrD,QAAM,EAAE,OAAO,IAAI,UAAU;AAAA,IAC5B;AAAA,IACA,SAAS;AAAA,IACT,QAAQ;AAAA,IACR,QAAQ;AAAA,EACT,CAAC;AAED,QAAM,gBAAgB;AAAA,IACrB,QAAQ,OAAO;AAAA,IACf,QAAQ,OAAO;AAAA,IACf,MAAM,OAAO;AAAA,IACb,aAAa,OAAO;AAAA,IACpB,WAAW,OAAO;AAAA,IAClB,OACC,OAAO,SAAS,OAAO,cAAc,KAAK,OAAO,WAAW,IACzD;AAAA,MACA,QAAQ,OAAO,SAAS,OAAO,cAAc;AAAA,MAC7C,KAAK,OAAO,SAAS,OAAO,WAAW;AAAA,IACvC,IACA;AAAA,IACJ,wBAAwB,OAAO,0BAA0B;AAAA,IACzD,mBAAmB,OAAO,oBAAoB;AAAA,IAC9C,wBAAwB,OAAO,0BAA0B;AAAA,IACzD,mBAAmB,OAAO,qBAAqB;AAAA,IAC/C,kBAAkB,OAAO,oBAAoB;AAAA,IAC7C,iBAAiB,OAAO,mBAAmB;AAAA,IAC3C,iBAAiB,OAAO,mBAAmB;AAAA,IAC3C,eAAe,OAAO,iBAAiB;AAAA,IACvC,wBAAwB,OAAO,2BAA2B;AAAA,IAC1D,qBAAqB,OAAO,uBAAuB;AAAA,IACnD,0BAA0B,OAAO,4BAA4B;AAAA,IAC7D,kBAAkB,OAAO,oBAAoB;AAAA,IAC7C,qBAAqB,OAAO,uBAAuB;AAAA,IACnD,mBAAmB,OAAO,qBAAqB;AAAA,IAC/C,gBAAgB,OAAO,kBAAkB;AAAA,IACzC,iBAAiB,OAAO,kBAAkB;AAAA,IAC1C,iBAAiB,OAAO,kBAAkB;AAAA,IAC1C,cAAc,OAAO,YAAY;AAAA,IACjC,SAAS,OAAO;AAAA,IAChB,SAAS,OAAO;AAAA,IAChB,OAAO,OAAO;AAAA,IACd,YAAY,OAAO;AAAA,IACnB,wBACC,OAAO,2BAA2B,KAAK,OAAO;AAAA,IAC/C,eAAe,OAAO,iBAAiB,KAAK,OAAO;AAAA,IACnD,aAAa,OAAO,cAAc;AAAA,IAClC,aAAa,OAAO,cAAc;AAAA,IAClC,aAAa,OAAO,cAAc;AAAA,IAClC,eAAe,OAAO,gBAAgB;AAAA,IACtC,OAAO,OAAO;AAAA,EACf;AAEA,QAAM,aAAa,sBAAsB,MAAM;AAC/C,MAAI,YAAY;AACf,WAAO;AAAA,MACN,WAAW;AAAA,MACX,OAAO;AAAA,MACP,SAAS;AAAA,IACV;AAAA,EACD;AAEA,QAAM,qBAAqB,cAAc,UAAU,aAAa;AAEhE,MAAI,CAAC,mBAAmB,SAAS;AAChC,WAAO;AAAA,MACN,WAAW;AAAA,MACX,OAAO,mBAAmB;AAAA,MAC1B,SAAS;AAAA,IACV;AAAA,EACD;AAEA,QAAM,UAAU,mBAAmB;AAEnC,UAAQ,UAAU,MAAM;AAAA,IACvB;AAAA,IACA,SAAS;AAAA,EACV;AACA,MAAI,CAAC,QAAQ,OAAO;AACnB,WAAO;AAAA,MACN,WAAW;AAAA,MACX;AAAA,IACD;AAAA,EACD;AAEA,UAAQ,eAAe,MAAM;AAAA,IAC5B;AAAA,IACA,SAAS;AAAA,EACV;AACA,MAAI,CAAC,QAAQ,YAAY;AACxB,WAAO;AAAA,MACN,WAAW;AAAA,MACX;AAAA,IACD;AAAA,EACD;AAEA,QAAM,EAAE,QAAQ,WAAW,IAAI,MAAM;AAAA,IACpC,QAAQ,gBACL,SACA,MAAM,YAAY,kCAAkC,SAAS;AAAA,IAChE;AAAA,MACC;AAAA,MACA,OAAO,QAAQ;AAAA,MACf,YAAY,QAAQ;AAAA,IACrB;AAAA,EACD;AACA,MAAI,CAAC,YAAY;AAChB,WAAO,EAAE,WAAW,MAAM,QAAQ;AAAA,EACnC;AAEA,UAAQ,gBAAgB,MAAM;AAAA,IAC7B;AAAA,IACA,YACE,MAAM,SAAS,YAAY,KAAM;AAAA,EACpC;AACA,MAAI,CAAC,QAAQ,aAAa;AACzB,WAAO,EAAE,WAAW,MAAM,QAAQ;AAAA,EACnC;AAEA,UAAQ,UAAU,MAAM;AAAA,IACvB;AAAA,IACA,YACE,MAAM,SAAS,MAAM,KAAM,UAAU,UAAU,EAAE,WAAW,KAAK,GAAG;AAAA,EACvE;AACA,MAAI,CAAC,QAAQ,OAAO;AACnB,WAAO,EAAE,WAAW,MAAM,QAAQ;AAAA,EACnC;AAEA,MAAI;AAEJ,MAAI,QAAQ,MAAM;AACjB,UAAM,MACL,QAAQ,WACP,MAAM;AAAA,MACN;AAAA,IACD;AACD,QAAI,CAAC,KAAK;AACT,aAAO,EAAE,WAAW,MAAM,QAAQ;AAAA,IACnC;AAEA,WAAO,EAAE,KAAK,KAAK,QAAQ,KAAK;AAAA,EACjC;AAEA,QAAM,QACL,QAAQ,SACP,MAAM,SAAS,MAAM,KACrB,MAAM;AAAA,IACN;AAAA,EACD;AACD,MAAI,CAAC,OAAO;AACX,WAAO,EAAE,WAAW,MAAM,QAAQ;AAAA,EACnC;AAEA,QAAM,mBAAmB,MAAM,2BAA2B;AAAA,IACzD,GAAG;AAAA,IACH,QAAQ,QAAQ,UAAU;AAAA,IAC1B,QAAQ,QAAQ,UAAW,MAAM,SAAS,MAAM;AAAA,IAChD,aAAa,QAAQ;AAAA,IACrB,WACC,QAAQ,aAAa,gBAAgB,aAAa,QAAQ;AAAA,IAC3D,OAAO,OAAO,UAAU,WAAW,EAAE,QAAQ,OAAO,KAAK,MAAM,IAAI;AAAA,IACnE,SAAS,QAAQ,WAAY,MAAM,SAAS,QAAQ;AAAA,IACpD;AAAA,IACA;AAAA,IACA,OAAO,QAAQ;AAAA,IACf;AAAA,IACA,OAAO,QAAQ;AAAA,EAChB,CAAC;AAED,MAAI,CAAC,kBAAkB;AACtB,WAAO;AAAA,MACN,WAAW;AAAA,MACX;AAAA,IACD;AAAA,EACD;AAEA,SAAO;AAAA,IACN,WAAW;AAAA,IACX;AAAA,IACA,SAAS;AAAA,EACV;AACD;","names":[]}
|
package/lib/shared/packages.d.ts
CHANGED
|
@@ -1,4 +1,6 @@
|
|
|
1
1
|
import { PartialPackageData } from './types.js';
|
|
2
|
+
import 'zod';
|
|
3
|
+
import './codes.js';
|
|
2
4
|
|
|
3
5
|
declare function readPackageData(): Promise<PartialPackageData>;
|
|
4
6
|
declare function removeDependencies(packageNames: string[], existing?: Record<string, string>, flags?: string): Promise<void>;
|
|
@@ -2,6 +2,6 @@ interface RunOrRestoreOptions {
|
|
|
2
2
|
run: () => Promise<void>;
|
|
3
3
|
skipRestore: boolean | undefined;
|
|
4
4
|
}
|
|
5
|
-
declare function runOrRestore({ run, skipRestore }: RunOrRestoreOptions): Promise<
|
|
5
|
+
declare function runOrRestore({ run, skipRestore }: RunOrRestoreOptions): Promise<0 | 2>;
|
|
6
6
|
|
|
7
7
|
export { RunOrRestoreOptions, runOrRestore };
|
package/lib/shared/types.d.ts
CHANGED
|
@@ -1,3 +1,6 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
import { StatusCode } from './codes.js';
|
|
3
|
+
|
|
1
4
|
interface AllContributorContributor {
|
|
2
5
|
contributions: string[];
|
|
3
6
|
login: string;
|
|
@@ -20,40 +23,79 @@ interface PartialPackageData {
|
|
|
20
23
|
url: string;
|
|
21
24
|
} | string;
|
|
22
25
|
}
|
|
23
|
-
type
|
|
26
|
+
type OptionsAccess = "public" | "restricted";
|
|
27
|
+
type OptionsBase = "common" | "everything" | "minimum" | "prompt";
|
|
28
|
+
interface OptionsEmail {
|
|
29
|
+
github: string;
|
|
30
|
+
npm: string;
|
|
31
|
+
}
|
|
24
32
|
interface OptionsLogo {
|
|
25
33
|
alt: string;
|
|
26
34
|
src: string;
|
|
27
35
|
}
|
|
36
|
+
/**
|
|
37
|
+
* All runtime options that may (or must) be specified for setup.
|
|
38
|
+
*/
|
|
28
39
|
interface Options {
|
|
40
|
+
access: OptionsAccess;
|
|
29
41
|
author?: string;
|
|
30
|
-
base?:
|
|
31
|
-
createRepository?: boolean;
|
|
42
|
+
base?: OptionsBase;
|
|
32
43
|
description: string;
|
|
33
|
-
|
|
44
|
+
directory: string;
|
|
45
|
+
email: OptionsEmail;
|
|
46
|
+
excludeAllContributors?: boolean;
|
|
34
47
|
excludeCompliance?: boolean;
|
|
35
|
-
|
|
48
|
+
excludeLintDeprecation?: boolean;
|
|
49
|
+
excludeLintESLint?: boolean;
|
|
50
|
+
excludeLintJSDoc?: boolean;
|
|
36
51
|
excludeLintJson?: boolean;
|
|
37
52
|
excludeLintKnip?: boolean;
|
|
38
53
|
excludeLintMd?: boolean;
|
|
39
54
|
excludeLintPackageJson?: boolean;
|
|
40
55
|
excludeLintPackages?: boolean;
|
|
41
56
|
excludeLintPerfectionist?: boolean;
|
|
57
|
+
excludeLintRegex?: boolean;
|
|
42
58
|
excludeLintSpelling?: boolean;
|
|
59
|
+
excludeLintStrict?: boolean;
|
|
60
|
+
excludeLintStylistic?: boolean;
|
|
43
61
|
excludeLintYml?: boolean;
|
|
44
62
|
excludeReleases?: boolean;
|
|
45
63
|
excludeRenovate?: boolean;
|
|
46
64
|
excludeTests?: boolean;
|
|
47
65
|
funding?: string;
|
|
66
|
+
keywords?: string[];
|
|
48
67
|
logo: OptionsLogo | undefined;
|
|
68
|
+
mode: Mode;
|
|
69
|
+
offline?: boolean;
|
|
49
70
|
owner: string;
|
|
50
71
|
repository: string;
|
|
51
|
-
|
|
72
|
+
skipAllContributorsApi?: boolean;
|
|
73
|
+
skipGitHubApi?: boolean;
|
|
52
74
|
skipInstall?: boolean;
|
|
53
75
|
skipRemoval?: boolean;
|
|
54
76
|
skipRestore?: boolean;
|
|
55
77
|
skipUninstall?: boolean;
|
|
56
78
|
title: string;
|
|
57
79
|
}
|
|
80
|
+
/**
|
|
81
|
+
* Options that might be suggested by how the user is running setup.
|
|
82
|
+
*/
|
|
83
|
+
interface PromptedOptions {
|
|
84
|
+
/**
|
|
85
|
+
* Directory for the repository, if it may differ from the repository name.
|
|
86
|
+
*/
|
|
87
|
+
directory?: string;
|
|
88
|
+
/**
|
|
89
|
+
* Repository name, if it may differ from the current directory.
|
|
90
|
+
*/
|
|
91
|
+
repository?: string;
|
|
92
|
+
}
|
|
93
|
+
interface ModeResult {
|
|
94
|
+
code: StatusCode;
|
|
95
|
+
error?: string | z.ZodError<object>;
|
|
96
|
+
options: Partial<Options>;
|
|
97
|
+
}
|
|
98
|
+
type ModeRunner = (args: string[], promptedOptions?: PromptedOptions) => Promise<ModeResult>;
|
|
99
|
+
type Mode = "create" | "initialize" | "migrate";
|
|
58
100
|
|
|
59
|
-
export { AllContributorContributor, AllContributorsData,
|
|
101
|
+
export { AllContributorContributor, AllContributorsData, Mode, ModeResult, ModeRunner, Options, OptionsAccess, OptionsBase, OptionsEmail, OptionsLogo, PartialPackageData, PromptedOptions };
|
|
@@ -1,3 +1,7 @@
|
|
|
1
|
-
|
|
1
|
+
import { Options } from '../shared/types.js';
|
|
2
|
+
import 'zod';
|
|
3
|
+
import '../shared/codes.js';
|
|
4
|
+
|
|
5
|
+
declare function addOwnerAsAllContributor(options: Pick<Options, "offline" | "owner">): Promise<void>;
|
|
2
6
|
|
|
3
7
|
export { addOwnerAsAllContributor };
|
|
@@ -2,8 +2,8 @@ import fs from "node:fs/promises";
|
|
|
2
2
|
import prettier from "prettier";
|
|
3
3
|
import { getGitHubUserAsAllContributor } from "../shared/getGitHubUserAsAllContributor.js";
|
|
4
4
|
import { readFileAsJson } from "../shared/readFileAsJson.js";
|
|
5
|
-
async function addOwnerAsAllContributor(
|
|
6
|
-
const user = await getGitHubUserAsAllContributor(
|
|
5
|
+
async function addOwnerAsAllContributor(options) {
|
|
6
|
+
const user = await getGitHubUserAsAllContributor(options);
|
|
7
7
|
const existingContributors = await readFileAsJson(
|
|
8
8
|
"./.all-contributorsrc"
|
|
9
9
|
);
|
|
@@ -13,7 +13,12 @@ async function addOwnerAsAllContributor(owner) {
|
|
|
13
13
|
);
|
|
14
14
|
}
|
|
15
15
|
const contributors = existingContributors.contributors.filter(({ login }) => ["JoshuaKGoldberg", user].includes(login)).map(
|
|
16
|
-
(contributor) => contributor.login === "JoshuaKGoldberg" ? { ...contributor, contributions: ["tool"] } :
|
|
16
|
+
(contributor) => contributor.login === "JoshuaKGoldberg" ? { ...contributor, contributions: ["tool"] } : {
|
|
17
|
+
...contributor,
|
|
18
|
+
contributions: Array.from(
|
|
19
|
+
/* @__PURE__ */ new Set([...contributor.contributions, "tool"])
|
|
20
|
+
)
|
|
21
|
+
}
|
|
17
22
|
);
|
|
18
23
|
if (!contributors.some((contributor) => contributor.login === user)) {
|
|
19
24
|
contributors.push({
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/steps/addOwnerAsAllContributor.ts"],"sourcesContent":["import fs from \"node:fs/promises\";\nimport prettier from \"prettier\";\n\nimport { getGitHubUserAsAllContributor } from \"../shared/getGitHubUserAsAllContributor.js\";\nimport { readFileAsJson } from \"../shared/readFileAsJson.js\";\nimport { AllContributorsData } from \"../shared/types.js\";\n\nexport async function addOwnerAsAllContributor(
|
|
1
|
+
{"version":3,"sources":["../../src/steps/addOwnerAsAllContributor.ts"],"sourcesContent":["import fs from \"node:fs/promises\";\nimport prettier from \"prettier\";\n\nimport { getGitHubUserAsAllContributor } from \"../shared/getGitHubUserAsAllContributor.js\";\nimport { readFileAsJson } from \"../shared/readFileAsJson.js\";\nimport { AllContributorsData, Options } from \"../shared/types.js\";\n\nexport async function addOwnerAsAllContributor(\n\toptions: Pick<Options, \"offline\" | \"owner\">,\n) {\n\tconst user = await getGitHubUserAsAllContributor(options);\n\n\tconst existingContributors = (await readFileAsJson(\n\t\t\"./.all-contributorsrc\",\n\t)) as AllContributorsData;\n\tif (!isValidAllContributorsData(existingContributors)) {\n\t\tthrow new Error(\n\t\t\t`Invalid .all-contributorsrc: ${JSON.stringify(existingContributors)}`,\n\t\t);\n\t}\n\n\tconst contributors = existingContributors.contributors\n\t\t.filter(({ login }) => [\"JoshuaKGoldberg\", user].includes(login))\n\t\t.map((contributor) =>\n\t\t\tcontributor.login === \"JoshuaKGoldberg\"\n\t\t\t\t? { ...contributor, contributions: [\"tool\"] }\n\t\t\t\t: {\n\t\t\t\t\t\t...contributor,\n\t\t\t\t\t\tcontributions: Array.from(\n\t\t\t\t\t\t\tnew Set([...contributor.contributions, \"tool\"]),\n\t\t\t\t\t\t),\n\t\t\t\t },\n\t\t);\n\n\tif (!contributors.some((contributor) => contributor.login === user)) {\n\t\tcontributors.push({\n\t\t\tcontributions: [\"tool\"],\n\t\t\tlogin: user,\n\t\t});\n\t}\n\n\tawait fs.writeFile(\n\t\t\"./.all-contributorsrc\",\n\t\tawait prettier.format(\n\t\t\tJSON.stringify({\n\t\t\t\t...existingContributors,\n\t\t\t\tcontributors,\n\t\t\t}),\n\t\t\t{ parser: \"json\" },\n\t\t),\n\t);\n}\n\nfunction isValidAllContributorsData(\n\tvalue: unknown,\n): value is AllContributorsData {\n\treturn !!value && typeof value === \"object\" && \"contributors\" in value;\n}\n"],"mappings":"AAAA,OAAO,QAAQ;AACf,OAAO,cAAc;AAErB,SAAS,qCAAqC;AAC9C,SAAS,sBAAsB;AAG/B,eAAsB,yBACrB,SACC;AACD,QAAM,OAAO,MAAM,8BAA8B,OAAO;AAExD,QAAM,uBAAwB,MAAM;AAAA,IACnC;AAAA,EACD;AACA,MAAI,CAAC,2BAA2B,oBAAoB,GAAG;AACtD,UAAM,IAAI;AAAA,MACT,gCAAgC,KAAK,UAAU,oBAAoB,CAAC;AAAA,IACrE;AAAA,EACD;AAEA,QAAM,eAAe,qBAAqB,aACxC,OAAO,CAAC,EAAE,MAAM,MAAM,CAAC,mBAAmB,IAAI,EAAE,SAAS,KAAK,CAAC,EAC/D;AAAA,IAAI,CAAC,gBACL,YAAY,UAAU,oBACnB,EAAE,GAAG,aAAa,eAAe,CAAC,MAAM,EAAE,IAC1C;AAAA,MACA,GAAG;AAAA,MACH,eAAe,MAAM;AAAA,QACpB,oBAAI,IAAI,CAAC,GAAG,YAAY,eAAe,MAAM,CAAC;AAAA,MAC/C;AAAA,IACA;AAAA,EACJ;AAED,MAAI,CAAC,aAAa,KAAK,CAAC,gBAAgB,YAAY,UAAU,IAAI,GAAG;AACpE,iBAAa,KAAK;AAAA,MACjB,eAAe,CAAC,MAAM;AAAA,MACtB,OAAO;AAAA,IACR,CAAC;AAAA,EACF;AAEA,QAAM,GAAG;AAAA,IACR;AAAA,IACA,MAAM,SAAS;AAAA,MACd,KAAK,UAAU;AAAA,QACd,GAAG;AAAA,QACH;AAAA,MACD,CAAC;AAAA,MACD,EAAE,QAAQ,OAAO;AAAA,IAClB;AAAA,EACD;AACD;AAEA,SAAS,2BACR,OAC+B;AAC/B,SAAO,CAAC,CAAC,SAAS,OAAO,UAAU,YAAY,kBAAkB;AAClE;","names":[]}
|
|
@@ -1,3 +1,7 @@
|
|
|
1
|
-
|
|
1
|
+
import { Options } from '../shared/types.js';
|
|
2
|
+
import 'zod';
|
|
3
|
+
import '../shared/codes.js';
|
|
4
|
+
|
|
5
|
+
declare function addToolAllContributors(options: Pick<Options, "offline" | "owner">): Promise<void>;
|
|
2
6
|
|
|
3
7
|
export { addToolAllContributors };
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { $ } from "execa";
|
|
2
2
|
import { getGitHubUserAsAllContributor } from "../shared/getGitHubUserAsAllContributor.js";
|
|
3
|
-
async function addToolAllContributors(
|
|
4
|
-
const login = await getGitHubUserAsAllContributor(
|
|
3
|
+
async function addToolAllContributors(options) {
|
|
4
|
+
const login = await getGitHubUserAsAllContributor(options);
|
|
5
5
|
if (login !== "JoshuaKGoldberg") {
|
|
6
6
|
await $`npx -y all-contributors-cli add JoshuaKGoldberg tool`;
|
|
7
7
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/steps/addToolAllContributors.ts"],"sourcesContent":["import { $ } from \"execa\";\n\nimport { getGitHubUserAsAllContributor } from \"../shared/getGitHubUserAsAllContributor.js\";\n\nexport async function addToolAllContributors(
|
|
1
|
+
{"version":3,"sources":["../../src/steps/addToolAllContributors.ts"],"sourcesContent":["import { $ } from \"execa\";\n\nimport { getGitHubUserAsAllContributor } from \"../shared/getGitHubUserAsAllContributor.js\";\nimport { Options } from \"../shared/types.js\";\n\nexport async function addToolAllContributors(\n\toptions: Pick<Options, \"offline\" | \"owner\">,\n) {\n\tconst login = await getGitHubUserAsAllContributor(options);\n\n\tif (login !== \"JoshuaKGoldberg\") {\n\t\tawait $`npx -y all-contributors-cli add JoshuaKGoldberg tool`;\n\t}\n}\n"],"mappings":"AAAA,SAAS,SAAS;AAElB,SAAS,qCAAqC;AAG9C,eAAsB,uBACrB,SACC;AACD,QAAM,QAAQ,MAAM,8BAA8B,OAAO;AAEzD,MAAI,UAAU,mBAAmB;AAChC,UAAM;AAAA,EACP;AACD;","names":[]}
|
|
@@ -6,12 +6,12 @@ async function finalizeDependencies(options) {
|
|
|
6
6
|
"@typescript-eslint/eslint-plugin",
|
|
7
7
|
"@typescript-eslint/parser",
|
|
8
8
|
"eslint",
|
|
9
|
-
"eslint-config-prettier",
|
|
10
9
|
"eslint-plugin-deprecation",
|
|
11
10
|
"eslint-plugin-eslint-comments",
|
|
12
|
-
"eslint-plugin-import",
|
|
13
11
|
"eslint-plugin-jsdoc",
|
|
14
12
|
"eslint-plugin-n",
|
|
13
|
+
"eslint-plugin-import",
|
|
14
|
+
"eslint-plugin-prettier",
|
|
15
15
|
"eslint-plugin-regexp",
|
|
16
16
|
"husky",
|
|
17
17
|
"lint-staged",
|
|
@@ -20,7 +20,7 @@ async function finalizeDependencies(options) {
|
|
|
20
20
|
"prettier-plugin-packagejson",
|
|
21
21
|
"tsup",
|
|
22
22
|
"typescript",
|
|
23
|
-
...options.
|
|
23
|
+
...options.excludeAllContributors ? [] : ["all-contributors-cli"],
|
|
24
24
|
...options.excludeLintJson ? [] : ["eslint-plugin-jsonc", "jsonc-eslint-parser"],
|
|
25
25
|
...options.excludeLintKnip ? [] : ["knip"],
|
|
26
26
|
...options.excludeLintMd ? [] : [
|
|
@@ -46,8 +46,10 @@ async function finalizeDependencies(options) {
|
|
|
46
46
|
"vitest"
|
|
47
47
|
]
|
|
48
48
|
].filter(Boolean).sort().map((packageName) => `${packageName}@latest`).join(" ");
|
|
49
|
-
await execaCommand(
|
|
50
|
-
|
|
49
|
+
await execaCommand(
|
|
50
|
+
`pnpm add ${devDependencies} -D${options.offline ? " --offline" : ""}`
|
|
51
|
+
);
|
|
52
|
+
if (!options.excludeAllContributors) {
|
|
51
53
|
await execaCommand(`npx all-contributors-cli generate`);
|
|
52
54
|
await removeDependencies(
|
|
53
55
|
["all-contributors-cli", "all-contributors-for-repository"],
|
|
@@ -55,7 +57,7 @@ async function finalizeDependencies(options) {
|
|
|
55
57
|
"-D"
|
|
56
58
|
);
|
|
57
59
|
}
|
|
58
|
-
await execaCommand(
|
|
60
|
+
await execaCommand(`pnpm dedupe`);
|
|
59
61
|
}
|
|
60
62
|
export {
|
|
61
63
|
finalizeDependencies
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/steps/finalizeDependencies.ts"],"sourcesContent":["import { execaCommand } from \"execa\";\n\nimport { readPackageData, removeDependencies } from \"../shared/packages.js\";\nimport { Options } from \"../shared/types.js\";\n\nexport async function finalizeDependencies(options: Options) {\n\tconst devDependencies = [\n\t\t\"@types/eslint\",\n\t\t\"@typescript-eslint/eslint-plugin\",\n\t\t\"@typescript-eslint/parser\",\n\t\t\"eslint\",\n\t\t\"eslint-
|
|
1
|
+
{"version":3,"sources":["../../src/steps/finalizeDependencies.ts"],"sourcesContent":["import { execaCommand } from \"execa\";\n\nimport { readPackageData, removeDependencies } from \"../shared/packages.js\";\nimport { Options } from \"../shared/types.js\";\n\nexport async function finalizeDependencies(options: Options) {\n\tconst devDependencies = [\n\t\t\"@types/eslint\",\n\t\t\"@typescript-eslint/eslint-plugin\",\n\t\t\"@typescript-eslint/parser\",\n\t\t\"eslint\",\n\t\t\"eslint-plugin-deprecation\",\n\t\t\"eslint-plugin-eslint-comments\",\n\t\t\"eslint-plugin-jsdoc\",\n\t\t\"eslint-plugin-n\",\n\t\t\"eslint-plugin-import\",\n\t\t\"eslint-plugin-prettier\",\n\t\t\"eslint-plugin-regexp\",\n\t\t\"husky\",\n\t\t\"lint-staged\",\n\t\t\"prettier\",\n\t\t\"prettier-plugin-curly\",\n\t\t\"prettier-plugin-packagejson\",\n\t\t\"tsup\",\n\t\t\"typescript\",\n\t\t...(options.excludeAllContributors ? [] : [\"all-contributors-cli\"]),\n\t\t...(options.excludeLintJson\n\t\t\t? []\n\t\t\t: [\"eslint-plugin-jsonc\", \"jsonc-eslint-parser\"]),\n\t\t...(options.excludeLintKnip ? [] : [\"knip\"]),\n\t\t...(options.excludeLintMd\n\t\t\t? []\n\t\t\t: [\n\t\t\t\t\t\"eslint-plugin-markdown\",\n\t\t\t\t\t\"markdownlint\",\n\t\t\t\t\t\"markdownlint-cli\",\n\t\t\t\t\t\"sentences-per-line\",\n\t\t\t ]),\n\t\t...(options.excludeLintPackageJson\n\t\t\t? []\n\t\t\t: [\"npm-package-json-lint\", \"npm-package-json-lint-config-default\"]),\n\t\t...(options.excludeLintPerfectionist\n\t\t\t? []\n\t\t\t: [\"eslint-plugin-perfectionist\"]),\n\t\t...(options.excludeLintSpelling ? [] : [\"cspell\"]),\n\t\t...(options.excludeLintYml\n\t\t\t? []\n\t\t\t: [\"eslint-plugin-yml\", \"yaml-eslint-parser\"]),\n\t\t...(options.excludeReleases\n\t\t\t? []\n\t\t\t: [\n\t\t\t\t\t\"@release-it/conventional-changelog\",\n\t\t\t\t\t\"release-it\",\n\t\t\t\t\t\"should-semantic-release\",\n\t\t\t ]),\n\t\t...(options.excludeTests\n\t\t\t? []\n\t\t\t: [\n\t\t\t\t\t\"@vitest/coverage-v8\",\n\t\t\t\t\t\"console-fail-test\",\n\t\t\t\t\t\"eslint-plugin-no-only-tests\",\n\t\t\t\t\t\"eslint-plugin-vitest\",\n\t\t\t\t\t\"vitest\",\n\t\t\t ]),\n\t]\n\t\t.filter(Boolean)\n\t\t.sort()\n\t\t.map((packageName) => `${packageName}@latest`)\n\t\t.join(\" \");\n\n\tawait execaCommand(\n\t\t`pnpm add ${devDependencies} -D${options.offline ? \" --offline\" : \"\"}`,\n\t);\n\n\tif (!options.excludeAllContributors) {\n\t\tawait execaCommand(`npx all-contributors-cli generate`);\n\t\tawait removeDependencies(\n\t\t\t[\"all-contributors-cli\", \"all-contributors-for-repository\"],\n\t\t\t(await readPackageData()).devDependencies,\n\t\t\t\"-D\",\n\t\t);\n\t}\n\n\tawait execaCommand(`pnpm dedupe`);\n}\n"],"mappings":"AAAA,SAAS,oBAAoB;AAE7B,SAAS,iBAAiB,0BAA0B;AAGpD,eAAsB,qBAAqB,SAAkB;AAC5D,QAAM,kBAAkB;AAAA,IACvB;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,GAAI,QAAQ,yBAAyB,CAAC,IAAI,CAAC,sBAAsB;AAAA,IACjE,GAAI,QAAQ,kBACT,CAAC,IACD,CAAC,uBAAuB,qBAAqB;AAAA,IAChD,GAAI,QAAQ,kBAAkB,CAAC,IAAI,CAAC,MAAM;AAAA,IAC1C,GAAI,QAAQ,gBACT,CAAC,IACD;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACA;AAAA,IACH,GAAI,QAAQ,yBACT,CAAC,IACD,CAAC,yBAAyB,sCAAsC;AAAA,IACnE,GAAI,QAAQ,2BACT,CAAC,IACD,CAAC,6BAA6B;AAAA,IACjC,GAAI,QAAQ,sBAAsB,CAAC,IAAI,CAAC,QAAQ;AAAA,IAChD,GAAI,QAAQ,iBACT,CAAC,IACD,CAAC,qBAAqB,oBAAoB;AAAA,IAC7C,GAAI,QAAQ,kBACT,CAAC,IACD;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACA;AAAA,IACH,GAAI,QAAQ,eACT,CAAC,IACD;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACA;AAAA,EACJ,EACE,OAAO,OAAO,EACd,KAAK,EACL,IAAI,CAAC,gBAAgB,GAAG,WAAW,SAAS,EAC5C,KAAK,GAAG;AAEV,QAAM;AAAA,IACL,YAAY,eAAe,MAAM,QAAQ,UAAU,eAAe,EAAE;AAAA,EACrE;AAEA,MAAI,CAAC,QAAQ,wBAAwB;AACpC,UAAM,aAAa,mCAAmC;AACtD,UAAM;AAAA,MACL,CAAC,wBAAwB,iCAAiC;AAAA,OACzD,MAAM,gBAAgB,GAAG;AAAA,MAC1B;AAAA,IACD;AAAA,EACD;AAEA,QAAM,aAAa,aAAa;AACjC;","names":[]}
|