{"id":20264204,"url":"https://github.com/kawarimidoll/deno-dev-template","last_synced_at":"2025-04-11T02:09:57.059Z","repository":{"id":103284147,"uuid":"378542001","full_name":"kawarimidoll/deno-dev-template","owner":"kawarimidoll","description":"My deno dev template with sample scripts, tests, tasks (including git hooks) and workflows.","archived":false,"fork":false,"pushed_at":"2023-06-11T07:50:51.000Z","size":89,"stargazers_count":23,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-11T02:09:50.640Z","etag":null,"topics":["deno","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/kawarimidoll.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-06-20T02:26:26.000Z","updated_at":"2024-08-28T03:51:27.000Z","dependencies_parsed_at":"2023-08-23T20:16:23.704Z","dependency_job_id":null,"html_url":"https://github.com/kawarimidoll/deno-dev-template","commit_stats":null,"previous_names":[],"tags_count":3,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kawarimidoll%2Fdeno-dev-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kawarimidoll%2Fdeno-dev-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kawarimidoll%2Fdeno-dev-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kawarimidoll%2Fdeno-dev-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kawarimidoll","download_url":"https://codeload.github.com/kawarimidoll/deno-dev-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248328160,"owners_count":21085261,"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":["deno","template-repository"],"created_at":"2024-11-14T11:38:33.833Z","updated_at":"2025-04-11T02:09:57.034Z","avatar_url":"https://github.com/kawarimidoll.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# deno-dev-template\n\n[![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/kawarimidoll/deno-dev-template?sort=semver)](releases)\n[![ci](https://github.com/kawarimidoll/deno-dev-template/workflows/ci/badge.svg)](.github/workflows/ci.yml)\n[![deno.land](https://img.shields.io/badge/deno-%5E1.34.0-green?logo=deno)](https://deno.land)\n[![LICENSE](https://img.shields.io/badge/license-MIT-brightgreen)](LICENSE)\n\nMy deno dev template with sample scripts, tests, tasks (including git hooks) and\nworkflows.\n\nYou can customize as you like.\n\n## Setup\n\nCreate repository by this template, or just copy `deno.jsonc` in this repository\nto your project.\n\nRun `deno task setup-hooks` at first or when you add git hooks definitions.\n\n### Scripts\n\nThere are small scripts generated by `deno init` and sample API server:\n\n- main.ts\n- main_bench.ts\n- main_test.ts\n- server.ts\n  - This server is running on [Deno Deploy](https://cloudy-owl-71.deno.dev/).\n\nSome utility scripts is in `scripts` directory:\n\n- lint-staged.ts\n  - Run [lint-staged](https://github.com/okonet/lint-staged) with configurations\n    in `deno.jsonc`.\n  - Read, env, run and write permissions are required.\n  - To use this, add `lint-staged` key in `deno.jsonc` and add configurations.\n- setup-hooks.ts\n  - Setup git hooks defined in `deno.jsonc` using\n    [deno_hooks](https://github.com/Yakiyo/deno_hooks).\n  - Read and run permissions are required (in addition, this script give a write\n    permission to deno_hooks).\n  - To use this, add tasks in `deno.jsonc` with a key with the same name as git\n    hooks (e.g. pre-commit, commit-msg).\n  - You can also specify the directory where the hooks are defined using the key\n    `hooks_dir` (default is .hooks).\n\n`deno.jsonc` should look like this to use above scripts:\n\n```jsonc\n// deno.jsonc\n{\n  \"lint-staged\": {\n    \"*\": \"deno lint \u0026\u0026 deno fmt\"\n  },\n  \"hooks_dir\": \".my_hooks\",\n  \"tasks\": {\n    \"setup-hooks\": \"deno run --allow-read --allow-run https://pax.deno.dev/kawarimidoll/deno-dev-template/scripts/setup-hooks.ts\",\n    \"pre-commit\": \"deno run --allow-read --allow-env --allow-run --allow-write https://pax.deno.dev/kawarimidoll/deno-dev-template/scripts/lint-staged.ts\",\n    \"pre-push\": \"deno test\"\n  }\n}\n```\n\n💡 You can specify versions of scripts:\n`https://pax.deno.dev/kawarimidoll/deno-dev-template@2.0.1/scripts/setup-hooks.ts`\n\n### Tasks\n\nAvailable Tasks:\n\n- run\n  - Define common permissions.\n  - Using this task allows omitting permission declarations in other task\n    definitions.\n- dev\n  - Run main script with '--watch' flag.\n- main\n  - Run main script once.\n- start\n  - Start server script.\n- test\n  - Run tests.\n  - Don't return error if no test files are found.\n- cov\n  - Run tests and show coverage.\n- lint\n  - Run lint (excluding coverage directory).\n- fmt\n  - Run formatting (excluding coverage directory).\n- ci\n  - Execute lint, formatting, and tests.\n- deps\n  - Update dependencies using [deno-udd](https://github.com/hayd/deno-udd).\n- setup-hooks\n  - Set up the following git hooks.\n- commit-msg\n  - Validate commit messages with commitlint.\n- pre-commit\n  - Execute processes defined in lint-staged.\n- pre-push\n  - Execute `deno task ci`.\n\n### Workflows\n\nWorkflows of GitHub Actions are defined:\n\n- ci\n  - Run `deno task ci` on pull request.\n- udd\n  - Run `deno task deps` on workflow_dispatch.\n  - It is useful to run it periodically by scheduling.\n\n## Author\n\n[kawarimidoll](https://github.com/kawarimidoll)\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkawarimidoll%2Fdeno-dev-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkawarimidoll%2Fdeno-dev-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkawarimidoll%2Fdeno-dev-template/lists"}