template-configuration-script

Script included in Permafrost Software template repositories for customization.

Some of the optional features included in this script are:

• Use of the codecov.io service to report coverage.
• Use of Dependabot to automatically update dependencies.
• Automatically merging Dependabot pull requests.
• Use of CodeQL to analyze code quality.

---

Description

The compiled script prompts the user for some configuration options, which are used to replace the placeholders in several files.

• project name;
• project description;
• name, email and github username of the author;
• name and github username of the project's owner/organization;

The default values for the configuration prompts are intelligently guessed using several sources, such as the local git configuration and the GitHub API.

Setup

npm install
npm run build

This will generate the compiled script in dist/configure-template.js.

Testing

template-configuration-script uses Jest for unit tests. To run the test suite:

npm run test

---

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Patrick Organ
• All Contributors

License

The MIT License (MIT). Please see License File for more information.