{"id":13496340,"url":"https://github.com/LuaLS/LLS-Addons","last_synced_at":"2025-03-28T18:31:54.649Z","repository":{"id":63407403,"uuid":"567574311","full_name":"LuaLS/LLS-Addons","owner":"LuaLS","description":"Addons for use with Sumneko's Lua Language Server","archived":false,"fork":false,"pushed_at":"2025-03-12T01:01:34.000Z","size":1270,"stargazers_count":82,"open_issues_count":8,"forks_count":55,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-21T02:28:02.516Z","etag":null,"topics":["lua","lua-cats","lua-language-server","sumneko-lua"],"latest_commit_sha":null,"homepage":"https://github.com/LuaLS/lua-language-server","language":null,"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/LuaLS.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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-11-18T04:27:11.000Z","updated_at":"2025-03-15T02:43:49.000Z","dependencies_parsed_at":"2023-09-24T04:35:50.832Z","dependency_job_id":"efd3392c-419a-42d0-8559-eb44715cee3e","html_url":"https://github.com/LuaLS/LLS-Addons","commit_stats":{"total_commits":403,"total_committers":39,"mean_commits":"10.333333333333334","dds":0.4069478908188585,"last_synced_commit":"689d322d94a523ffd4b7b02e8aee7215b83c8fdb"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LuaLS%2FLLS-Addons","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LuaLS%2FLLS-Addons/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LuaLS%2FLLS-Addons/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LuaLS%2FLLS-Addons/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LuaLS","download_url":"https://codeload.github.com/LuaLS/LLS-Addons/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246080685,"owners_count":20720571,"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":["lua","lua-cats","lua-language-server","sumneko-lua"],"created_at":"2024-07-31T19:01:46.291Z","updated_at":"2025-03-28T18:31:54.618Z","avatar_url":"https://github.com/LuaLS.png","language":null,"readme":"\n# Lua Language Server Addons\n\n![Addons count](https://img.shields.io/github/directory-file-count/LuaLS/LLS-Addons/addons?label=Addons\u0026type=dir\u0026color=097aba)\n![Contributors](https://img.shields.io/github/contributors/LuaLS/LLS-Addons?label=Contributors)\n\nWelcome to the repository of [addons][addon-wiki] for the [Lua Language Server][lls-github] by [sumneko](https://github.com/sumneko)!\n\nThis repository is a highly collaborative project, with the community contributing addons through pull requests. The goal is to provide a central location where the community can collaborate on creating addons. Addons are added to this repository as a git submodule, allowing each project to have its own issues, pull requests, and fork-able repo - they can even live on GitLab. The addons in this repository can be fetched by the [addon manager](https://luals.github.io/wiki/addons#addon-manager) in the [VS Code extension](https://github.com/sumneko/vscode-lua) that communicates with the Lua Language Server in VS Code.\n\n## What is an Addon?\nAn [addon][addon-wiki], simply put, is something that extends the functionality of the [Lua Language Server][lls-github]. An addon could, for example, include definitions for an API, and apply settings. [Definition files](https://luals.github.io/wiki/definition-files) are written in Lua using the Lua Language Server's [LuaCATS annotation system](https://luals.github.io/wiki/annotations).\n\n### What should be an Addon?\n- An [addon][addon-wiki] for a popular library/framework.\n- Definitions for an API\n\n### What should **NOT** be an Addon?\n- Definitions for a personal project (use [`workspace.library`](https://luals.github.io/wiki/settings#workspacelibrary)).\n- Definitions for proprietary software.\n\n### Anatomy of an Addon\nHere is an example of what an addon could look like:\n```\n📂 MySnazzyAddon/\n    ├──📜 info.json\n    └── 📁 module/\n        ├── 📁 library/\n        └── 📜 config.lua\n```\n#### `info.json`\nThe `info.json` file contains some details about the addon such as the name and description. It also contains some additional metadata such as `size` and `hasPlugin`, but these values are generated automatically by the [LLS-Addons-Action](https://github.com/LuaLS/LLS-Addons-Action). This file is used by the [addon manager](https://luals.github.io/wiki/addons#addon-manager) to retrieve some data about each addon without having to install them all first.\n\n#### `module`\nThe module folder is the submodule that contains the [addon][addon-wiki]'s definition files and `config.json`.\n\n## Get Involved\nAs already said, this is a very collaborative project, so anyone is welcome to help out! To get started, please review the [contribution guidelines](CONTRIBUTING.md). Your contributions are greatly appreciated and will help to make this project a valuable resource for the Lua community ❤️.\n\n\n\n[lls-github]: https://github.com/LuaLS/lua-language-server\n[addon-wiki]: https://luals.github.io/wiki/addons\n\n","funding_links":[],"categories":["Others"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FLuaLS%2FLLS-Addons","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FLuaLS%2FLLS-Addons","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FLuaLS%2FLLS-Addons/lists"}