Skip to content
create

Configuration

Running npx create --preset ... in a repository that was already set up with the Preset will re-run the Preset on the repository. Re-running create will bring in any updates from the latest version of the Preset.

If you plan on keeping a repository up-to-date with its Preset, you can add a create.config.js or create.config.ts file in the root of the repository. It should export default a call to a createConfig() function that takes in a Preset. npx create will pick up on that file and read any customizations to your Preset from it.

For example, keeping a repository up-to-date with create-typescript-app:

create.config.ts
import { createConfig } from "create";
import { presetEverything } from "create-typescript-app";


export default createConfig(presetEverything);

Once that file is created, you can re-run create:

Terminal window
npx create

Running npx create in a repository with that create.config.ts would be the equivalent of running npx create typescript-app --preset everything.

createConfig

The exported createConfig function takes in up to two arguments:

  1. (required) A Preset imported from a package
  2. (optional) An object containing any customizations to be applied to the preset

The customizations that can be passed to createConfig are a superset of what you can pass on the CLI.

addons

Any Addons to be passed to the Blocks that come with the Preset. These will be merged in with Addons provided by other Blocks.

For example, this configuration file adds the word "arethetypeswrong" to a CSpell Block’s Addons:

create.config.ts
import { createConfig } from "create";
import { blockCSpell, presetEverything } from "create-typescript-app";


export default createConfig(presetEverything, {
  addons: [
    blockCSpell({
      words: ["arethetypeswrong"],
    }),
  ],
});

Running npx create in a repository with that configuration file would merge in that words to the Addons provided to its CSpell Block.

blocks

Any customizations to the Blocks provided as part of the Preset.

add

Any Blocks to add to what the Preset provides.

For example, this configuration file adds in an “arethetypeswrong” Block alongside existing Blocks provided by create-typescript-app:

create.config.ts
import { createConfig } from "create";
import { blockAreTheTypesWrong, presetEverything } from "create-typescript-app";


export default createConfig(presetEverything, {
  blocks: {
    add: [blockAreTheTypesWrong],
  },
});

Running npx create in a repository with that configuration file would add in the created outputs from blockAreTheTypesWrong.

remove

Any Blocks to remove from what the Preset provides.

For example, this configuration file removes the default “This package was templated with…” notice that comes with by create-typescript-app:

create.config.ts
import { createConfig } from "create";
import { blockTemplatedBy, presetEverything } from "create-typescript-app";


export default createConfig(presetEverything, {
  blocks: {
    remove: [blockTemplatedBy],
  },
});

Running npx create in a repository with that configuration file would not include that Block, and so its generated README.md would not include the notice.