{"id":21466568,"url":"https://github.com/permafrost-dev/template-configuration-script","last_synced_at":"2025-03-17T05:47:59.276Z","repository":{"id":37092594,"uuid":"456245465","full_name":"permafrost-dev/template-configuration-script","owner":"permafrost-dev","description":"A script for customizing repositories created from template repositories.","archived":false,"fork":false,"pushed_at":"2023-11-21T11:57:04.000Z","size":126,"stargazers_count":0,"open_issues_count":8,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-23T15:31:54.648Z","etag":null,"topics":["configuration","customization","repository-utilities","script","template-repository"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/permafrost-dev.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"permafrost-dev","custom":"https://permafrost.dev/open-source"}},"created_at":"2022-02-06T19:06:07.000Z","updated_at":"2022-07-09T10:43:07.000Z","dependencies_parsed_at":"2024-01-16T18:59:20.866Z","dependency_job_id":"3ac10d77-fd1e-476b-99ba-541dfab1aa74","html_url":"https://github.com/permafrost-dev/template-configuration-script","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":"permafrost-dev/typescript-project-skeleton-esbuild-jest","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/permafrost-dev%2Ftemplate-configuration-script","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/permafrost-dev%2Ftemplate-configuration-script/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/permafrost-dev%2Ftemplate-configuration-script/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/permafrost-dev%2Ftemplate-configuration-script/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/permafrost-dev","download_url":"https://codeload.github.com/permafrost-dev/template-configuration-script/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243982136,"owners_count":20378606,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["configuration","customization","repository-utilities","script","template-repository"],"created_at":"2024-11-23T08:14:37.477Z","updated_at":"2025-03-17T05:47:59.246Z","avatar_url":"https://github.com/permafrost-dev.png","language":"TypeScript","funding_links":["https://github.com/sponsors/permafrost-dev","https://permafrost.dev/open-source"],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n    \u003cimg style=\"height: 130px;\" src=\"https://user-images.githubusercontent.com/5508707/178102899-d8a0d8ec-6126-4969-8dae-763c7d0b22ba.png\" alt=\"\" /\u003e\n\u003c/p\u003e\n\n# template-configuration-script\n\n\u003cp align=\"center\" style=\"flex\"\u003e\n\u003cimg alt=\"Tests\" src=\"https://github.com/permafrost-dev/template-configuration-script/actions/workflows/run-tests.yml/badge.svg?branch=main\" /\u003e\n\u003cimg alt=\"License\" src=\"https://shields.io/github/license/permafrost-dev/template-configuration-script\" /\u003e\n\u003cimg alt=\"Lines of code\" src=\"https://img.shields.io/tokei/lines/github/permafrost-dev/template-configuration-script\" /\u003e\n\u003cbr\u003e\n\u003c!--\u003cimg src=\"https://www.codefactor.io/repository/github/permafrost-dev/template-configuration-script/badge\" alt=\"CodeFactor\" /\u003e--\u003e\n\u003cimg alt=\"CodeFactor Grade\" src=\"https://img.shields.io/codefactor/grade/github/permafrost-dev/template-configuration-script?logo=codefactor\" /\u003e\n\u003c!--\u003cimg alt=\"Code Climate maintainability\" src=\"https://img.shields.io/codeclimate/maintainability/permafrost-dev/template-configuration-script?logo=codeclimate\" /\u003e--\u003e\n\u003cimg alt=\"Code climate maintainability\" src=\"https://api.codeclimate.com/v1/badges/c18158bd1f1d5f9935c0/maintainability\" /\u003e\n\u003cimg alt=\"Code Climate technical debt\" src=\"https://img.shields.io/codeclimate/tech-debt/permafrost-dev/template-configuration-script?label=tech%20debt\u0026logo=codeclimate\" /\u003e\n\u003c/p\u003e\n\nScript included in [Permafrost Software](https://github.com/permafrost-dev) template repositories for customization.\n\nSome of the optional features included in this script are:\n\n- Use of the [codecov.io](https://codecov.io) service to report coverage.\n- Use of Dependabot to automatically update dependencies.\n- Automatically merging Dependabot pull requests.\n- Use of CodeQL to analyze code quality.\n\n---\n\n## Description\n\nThe compiled script prompts the user for some configuration options, which are used to replace the placeholders in several files.\n\n- project name;\n- project description;\n- name, email and github username of the author;\n- name and github username of the project's owner/organization;\n\nThe default values for the configuration prompts are intelligently guessed using several sources, such as the local git configuration and the GitHub API.\n\n## Setup\n\n```bash\nnpm install\nnpm run build\n```\n\nThis will generate the compiled script in `dist/configure-template.js`.\n\n## Testing\n\n`template-configuration-script` uses Jest for unit tests.  To run the test suite:\n\n`npm run test`\n\n---\n\n## Changelog\n\nPlease see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.\n\n## Contributing\n\nPlease see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.\n\n## Security Vulnerabilities\n\nPlease review [our security policy](../../security/policy) on how to report security vulnerabilities.\n\n## Credits\n\n- [Patrick Organ](https://github.com/patinthehat)\n- [All Contributors](../../contributors)\n\n## License\n\nThe MIT License (MIT). Please see [License File](LICENSE) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpermafrost-dev%2Ftemplate-configuration-script","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpermafrost-dev%2Ftemplate-configuration-script","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpermafrost-dev%2Ftemplate-configuration-script/lists"}