{"id":15529939,"url":"https://github.com/hazzard993/tstl-plugin-template","last_synced_at":"2025-03-28T21:43:42.267Z","repository":{"id":97408775,"uuid":"304199629","full_name":"hazzard993/tstl-plugin-template","owner":"hazzard993","description":"A small template for a new TypeScriptToLua plugin","archived":false,"fork":false,"pushed_at":"2020-10-15T03:29:29.000Z","size":1,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-03T08:13:56.099Z","etag":null,"topics":["plugin","template","typescript","typescript-to-lua"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hazzard993.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2020-10-15T03:28:28.000Z","updated_at":"2020-10-15T03:30:24.000Z","dependencies_parsed_at":null,"dependency_job_id":"3b943e5b-7710-4cd7-92d1-c4cf9c508982","html_url":"https://github.com/hazzard993/tstl-plugin-template","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hazzard993%2Ftstl-plugin-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hazzard993%2Ftstl-plugin-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hazzard993%2Ftstl-plugin-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hazzard993%2Ftstl-plugin-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hazzard993","download_url":"https://codeload.github.com/hazzard993/tstl-plugin-template/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246106668,"owners_count":20724400,"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":["plugin","template","typescript","typescript-to-lua"],"created_at":"2024-10-02T11:20:32.582Z","updated_at":"2025-03-28T21:43:42.211Z","avatar_url":"https://github.com/hazzard993.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# TypeScriptToLua Plugin Template\n\nA template for [TypeScriptToLua plugins](https://typescripttolua.github.io/docs/api/plugins).\n\n1) Use `link` to make the plugin available locally\n\n```sh\nyarn link                         # or `npm link`\n```\n\n2) Head to your project (should have a `package.json`)\n\n```sh\ncd /path/to/project\n```\n\n3) Ensure you have `ts-node` available\n\n```sh\nyarn add -D ts-node               # or npm install -D ts-node\n```\n\n4) Link your plugin to the project\n\n```sh\nyarn link tstl-plugin-template    # or npm link tstl-plugin-template\n```\n\n5) Append your plugin to your `tsconfig.json`\n\n```json\n{\n  \"tstl\": {\n    \"luaPlugins\": [\n      { \"name\": \"tstl-plugin-template\" }\n    ]\n  }\n}\n```\n\n4) Done, run TSTL on your project and the plugin should now run\n\n```sh\nnpx tstl -p tsconfig.json\n```\n\nOnce this setup is complete you can continue to adjust `plugin.ts` and source files in your project to adjust what your plugin does.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhazzard993%2Ftstl-plugin-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhazzard993%2Ftstl-plugin-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhazzard993%2Ftstl-plugin-template/lists"}