{"id":25758138,"url":"https://github.com/gkzhb/typescript-nvim-template","last_synced_at":"2026-05-09T02:34:13.580Z","repository":{"id":118133123,"uuid":"504756192","full_name":"gkzhb/typescript-nvim-template","owner":"gkzhb","description":"neovim plugin template using typescript-to-lua","archived":false,"fork":false,"pushed_at":"2022-06-18T08:49:36.000Z","size":9,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-02T13:04:38.581Z","etag":null,"topics":["lua","neovim","neovim-plugin","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":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gkzhb.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":"2022-06-18T05:48:05.000Z","updated_at":"2024-03-15T01:29:41.000Z","dependencies_parsed_at":null,"dependency_job_id":"f83dcab7-d41c-4aa4-b145-7dd7fd4c1be1","html_url":"https://github.com/gkzhb/typescript-nvim-template","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/gkzhb/typescript-nvim-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gkzhb%2Ftypescript-nvim-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gkzhb%2Ftypescript-nvim-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gkzhb%2Ftypescript-nvim-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gkzhb%2Ftypescript-nvim-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gkzhb","download_url":"https://codeload.github.com/gkzhb/typescript-nvim-template/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gkzhb%2Ftypescript-nvim-template/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32804943,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-08T08:22:46.396Z","status":"online","status_checked_at":"2026-05-09T02:00:06.633Z","response_time":123,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["lua","neovim","neovim-plugin","typescript","typescript-to-lua"],"created_at":"2025-02-26T16:37:29.695Z","updated_at":"2026-05-09T02:34:13.564Z","avatar_url":"https://github.com/gkzhb.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# TypeScriptToLua Neovim Plugin Template\n\nThis template project uses [TypeScriptToLua](https://typescripttolua.github.io/)\nto create a neovim lua plugin.\n\n## Notice for TypeScriptToLua\n\nThere are many differences between Typescript for JavaScript and TypeScriptToLua\nfor Lua:\n\n1. Features from languages(JavaScript and Lua): [Caveats | TypeScriptToLua](https://typescripttolua.github.io/docs/caveats)\n1. To support JavaScript's function behavior in Lua: [The Self Parameter | TypeScriptToLua](https://typescripttolua.github.io/docs/the-self-parameter)\n1. Using other modules: you can use external Lua code but not TypeScript files\nfrom npm packages. [External Lua Code | TypeScriptToLua](https://typescripttolua.github.io/docs/external-lua-code)\n1. Publish TSToLua modules: with the previous item, the good news is you can use\nTypeScriptToLua to publish this Lua module with **types** and can be used in\nother TSToLua projects.\n[Publishing Modules | TypeScriptToLua](https://typescripttolua.github.io/docs/publishing-modules)\n1. Extend TypeScript to support features in Lua: [Language Extensions | TypeScriptToLua](https://typescripttolua.github.io/docs/advanced/language-extensions)\n\n## How to use this template\n\nFirst change the project name and related path.\n\n1. In `package.json`:\n  * Update meta data `name`, `repository.url`, `author`, etc.\n  * Update project name path in `main`, `types`\n1. In `tsconfig.json`:\n  * Update project name path in `compilerOptions.outDir`\n\nThis project favors `yarn` and use `yarn` to install dependencies, use\n`yarn build` to generate lua code. The output files will be in `./lua/\u003cproject name\u003e/`.\n\nFinally, use `yarn dev` to build in realtime\nas source files change.\n\n## TODO\n\n* [ ] Examples to use GitHub CI to automatically build code on git push.\n* [ ] Provide Neovim API type declarations (how to automatically generate them?)\nas a npm package.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgkzhb%2Ftypescript-nvim-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgkzhb%2Ftypescript-nvim-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgkzhb%2Ftypescript-nvim-template/lists"}