Settings File

Tps allows you to have a settings file in your template to add certain actions/configurations when generating your template. The settings file can be a settings.json or settings.js in your template folder at the same level as your packages. The main use for this file is prompting but well be adding more features very soon.

| - .tps
    | - some-template
        | - settings.json
        | - default
            | - <files...>

json

settings.json

{}

js

settings.js

module.exports = {};

warning

Please note that export default has not been thoroughly tested and may not perform as anticipated. If you encounter any issues or have suggestions for improvement, we encourage you to file an issue or submit a pull request (PR). We greatly value contributions and welcome any input you may have.

tip

Our new template command creates this file for you 😃

Settings options

You can explore the complete list of available fields for a settings file in the comprehensive Settings File API Documentation. This guide will cover the following topics:

• Prompting