fix: rename to modifyName

BREAKING CHANGE: handleName => modifyName

Author: uetchy

README.md

@@ -37,11 +37,13 @@
     - [`space`](#space)
     - [`uuid`](#uuid)
 - [Config](#config)
-  - [`extra`](#extra)
-  - [`caveat`](#caveat)
-    - [AfterHookOptions](#afterhookoptions)
-  - [`after`](#after)
-  - [`handleName`](#handlename)
+  - [templateRoot (required)](#templateroot-required)
+  - [promptForTemplate (default: `false`)](#promptfortemplate-default-false)
+  - [extra (default: `undefined`)](#extra-default-undefined)
+  - [modifyName (default: `undefined`)](#modifyname-default-undefined)
+  - [after (default: `undefined`)](#after-default-undefined)
+  - [caveat (default: `undefined`)](#caveat-default-undefined)
+  - [AfterHookOptions](#afterhookoptions)
 - [Contribution](#contribution)
   - [Contributors ✨](#contributors-)
 
@@ -151,14 +153,14 @@ Generates unique UUID string.
 
 ## Config
 
-You can find the app config in `src/cli.ts` (or `src/cli.js` if you chose `default` template).
+You can find the app config in `src/cli.js` (or `src/cli.ts` if you chose `typescript` template).
 
 ```ts
 import { resolve } from 'path';
 import { create } from 'create-create-app';
 
 create('create-greet', {
-  templateRoot: resolve(__dirname, '../templates'),
+  templateRoot: resolve(__dirname, '..', 'templates'),
   extra: {
     language: {
       type: 'input',
@@ -167,23 +169,47 @@ create('create-greet', {
       prompt: 'if-no-arg',
     },
   },
+  modifyName: (name) => `package-prefix-${name}`,
   after: ({ installNpmPackage }) => installNpmPackage('chalk'),
-  caveat: `Your app has been created successfuly!`,
-  handleName: (name) => `package-prefix-${name}`,
+  caveat: `Your app has been created successfully!`,
 });
 ```
 
+### templateRoot (required)
+
 `templateRoot` set to `path.resolve(__dirname, '../templates')`. You can change it to whereever you want.
 
-### `extra`
+### promptForTemplate (default: `false`)
+
+Ask users to choose a template to be used for initialization only if `promptForTemplate` is set `true` AND there's multiple templates found in `templates/`.
+
+With `promptForTemplate` set `false`, users still can specify template via command-line flag `--template`:
+
+```
+create-something <name> --template <template>
+```
+
+### extra (default: `undefined`)
 
 `object | undefined`
 
 Extra options passed to the app. These options will be accessible as a cli option, interactive question, and template string. In this case, `--language` cli option and `{{language}}` template string will be available.
 
 You can find all possible options in [yargs-interactive documentation](https://github.com/nanovazquez/yargs-interactive#options).
 
-### `caveat`
+### modifyName (default: `undefined`)
+
+`(name: string) => string | Promise<string>`
+
+Modify `name` property.
+
+### after (default: `undefined`)
+
+`(options: AfterHookOptions) => void`
+
+After hook script that runs after the initialization.
+
+### caveat (default: `undefined`)
 
 `string | ((options: AfterHookOptions) => string | void) | undefined`
 
@@ -211,7 +237,7 @@ create('create-greet', {
 });
 ```
 
-#### AfterHookOptions
+### AfterHookOptions
 
 ```typescript
 {
@@ -234,18 +260,6 @@ create('create-greet', {
 }
 ```
 
-### `after`
-
-`(options: AfterHookOptions) => void`
-
-After hook script that runs after the initialization.
-
-### `handleName`
-
-`(name: string) => string | Promise<string>`
-
-Modify `name` property.
-
 ## Contribution
 
 PRs are always welcome!

src/cli.ts

@@ -44,7 +44,7 @@ ${chalk.yellow(
 
 create('create-create-app', {
   templateRoot,
-  alwaysAskForTemplate: true,
+  promptForTemplate: true,
+  modifyName: (name) => (name.startsWith('create-') ? name : `create-${name}`),
   caveat,
-  handleName: (name) => (name.startsWith('create-') ? name : `create-${name}`),
 });

src/index.ts

@@ -33,8 +33,8 @@ export interface Option {
 
 export interface Options {
   templateRoot: string;
-  alwaysAskForTemplate?: boolean;
-  handleName?: (name: string) => string | Promise<string>;
+  promptForTemplate?: boolean;
+  modifyName?: (name: string) => string | Promise<string>;
   extra?: Option;
   caveat?:
     | string
@@ -144,13 +144,13 @@ function isOccupied(dirname: string) {
 
 async function getYargsOptions(
   templateRoot: string,
-  alwaysAskForTemplate: boolean,
+  promptForTemplate: boolean,
   extraOptions: Option = {},
 ) {
   const gitUser = await getGitUser();
   const availableTemplates = getAvailableTemplates(templateRoot);
   const isMultipleTemplates = availableTemplates.length > 1;
-  const askForTemplate = isMultipleTemplates && alwaysAskForTemplate;
+  const askForTemplate = isMultipleTemplates && promptForTemplate;
   const yargOption: Option = {
     interactive: { default: true },
     description: {
@@ -203,19 +203,19 @@ export async function create(appName: string, options: Options) {
   const useCurrentDir = firstArg === '.';
   const name: string = useCurrentDir
     ? path.basename(process.cwd())
-    : options.handleName
-    ? await Promise.resolve(options.handleName(firstArg))
+    : options.modifyName
+    ? await Promise.resolve(options.modifyName(firstArg))
     : firstArg;
   const packageDir = useCurrentDir ? process.cwd() : path.resolve(name);
-  const { templateRoot, alwaysAskForTemplate = false } = options;
+  const { templateRoot, promptForTemplate = false } = options;
 
   if (isOccupied(packageDir)) {
     error(`${packageDir} is not empty directory.`);
   }
 
   const yargsOption = await getYargsOptions(
     templateRoot,
-    alwaysAskForTemplate,
+    promptForTemplate,
     options.extra,
   );
   const args = await yargsInteractive()