Skip to content

Writing a preset

Creating the project

In an empty directory, run the following command:

preset init

Alternatively, you can specify a directory as the second argument to create the preset elsewhere. After asking for a preset name, the command will generate the following:

templates/
├─ .gitkeep
preset.ts
package.json
tsconfig.json
README.md
.gitignore

Repository initilialization

Unless you use the --no-git flag, a repository will be created and the initial files will be committed.

Adding actions

In the handler function of the object exported by preset.ts, you can use actions. Note that both handler and action functions are asynchronous, which means that the latter must be awaited.

To learn more about actions and how they are used, refer to their documentation page.

export default definePreset({
  name: 'my-preset',
  handler: async() => {
    // Will extract /templates/vue to the target directory
    await extractTemplates({
      from: 'vue'
    })

    // ...
  },
})

Actions are globals

The whole preset API is global, so yUsing options

Using options

Preset uses cac to parse command-line arguments. You can set default values to arguments using the options property and use the context object that is given to handler to read their value:

export default definePreset({
  name: 'my-preset',
  options: {
    somethingCustom: false
  },
  handler: async(context) => {
    if (context.options.somethingCustom) {
      // Do something only if --something-custom was used
    }

    // ...
  },
})

Thanks to cac, you can set an option to false using the --no- prefix. In the example below, customOption is always true unless you use --no-custom-option.

export default definePreset({
  options: {
    customOption: true
  },
  // ...
})

Note that options names are converted to camelCase.

Testing the preset locally

In order to try your preset, you can simply use its path:

preset apply /path/to/your/preset/project

Next steps

The next step is to build your preset. You can learn more about actions in their documentation.

Archiving edited files

When creating a preset from a test project, if you committed its initial state and started editing it, you can use git diff to list the modified files.

Combined with git archive, you can zip up all of the files you edited and unzip them in the templates directory of your preset.

git archive -o update.zip HEAD $(git diff --diff-filter=M --name-only)

Then, you will need to publish your preset, or you can keep it local for your personal use. You can even use an alias to make it easier.

Writing a preset has loaded