{"id":25703001,"url":"https://github.com/CppCXY/emmylua-analyzer-rust","last_synced_at":"2025-02-25T05:05:23.387Z","repository":{"id":258331969,"uuid":"872860168","full_name":"CppCXY/emmylua-analyzer-rust","owner":"CppCXY","description":null,"archived":false,"fork":false,"pushed_at":"2025-02-20T03:53:22.000Z","size":1440,"stargazers_count":72,"open_issues_count":9,"forks_count":10,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-20T04:29:40.599Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Rust","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/CppCXY.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2024-10-15T07:45:06.000Z","updated_at":"2025-02-20T03:53:25.000Z","dependencies_parsed_at":"2024-10-28T11:00:06.353Z","dependency_job_id":"2049ae2e-aef6-4d05-9606-d965c9486077","html_url":"https://github.com/CppCXY/emmylua-analyzer-rust","commit_stats":null,"previous_names":["cppcxy/emmylua-analyzer-rust"],"tags_count":28,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CppCXY%2Femmylua-analyzer-rust","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CppCXY%2Femmylua-analyzer-rust/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CppCXY%2Femmylua-analyzer-rust/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CppCXY%2Femmylua-analyzer-rust/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CppCXY","download_url":"https://codeload.github.com/CppCXY/emmylua-analyzer-rust/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240605835,"owners_count":19827983,"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":[],"created_at":"2025-02-25T05:03:37.203Z","updated_at":"2025-02-25T05:05:23.375Z","avatar_url":"https://github.com/CppCXY.png","language":"Rust","funding_links":[],"categories":["Rust"],"sub_categories":[],"readme":"# EmmyLuaAnalyzer-Rust\n\nWe welcome your feedback and contributions. Please feel free to submit pull requests (PRs) and report issues to help shape the project's direction.\n\n## Crates\n\n| Crate | Badge | Description |\n| ----- | ----- | ----------- |\n| [emmylua_parser](./crates/emmylua_parser) | [![emmylua_parser](https://img.shields.io/crates/v/emmylua_parser.svg)](https://crates.io/crates/emmylua_parser) | A Rust-based Lua parser built for efficiency and accuracy. It serves as the foundation for advanced code analysis and the language server. |\n| [emmylua_code_analysis](./crates/emmylua_code_analysis) | [![emmylua_code_analysis](https://img.shields.io/crates/v/emmylua_code_analysis.svg)](https://crates.io/crates/emmylua_code_analysis) | Provides Lua code analysis by leveraging emmylua_parser. |\n| [emmylua_ls](./crates/emmylua_ls) | [![emmylua_ls](https://img.shields.io/crates/v/emmylua_ls.svg)](https://crates.io/crates/emmylua_ls) | The language server for Lua, offering extensive features for different Lua versions. |\n| [emmylua_doc_cli](./crates/emmylua_doc_cli/) | [![emmylua_doc_cli](https://img.shields.io/crates/v/emmylua_doc_cli.svg)](https://crates.io/crates/emmylua_doc_cli) | A command-line tool to effortlessly generate Lua API documentation. |\n| [emmylua_check](./crates/emmylua_check) | [![emmylua_check](https://img.shields.io/crates/v/emmylua_check.svg)](https://crates.io/crates/emmylua_check) | A tool to perform static analysis and validate Lua code quality. |\n\n## Features\n\n- [x] Support for Lua 5.1, 5.2, 5.3, 5.4, and LuaJIT.\n- [x] Support Luacats/emmylua annotations.\n- [x] Support almost lsp features.\n\n## Documentation\n\n- [Features](./docs/features/features_EN.md)\n- [Emmyrc Config](./docs/config/emmyrc_json_EN.md)\n- [Formatting Config](https://github.com/CppCXY/EmmyLuaCodeStyle/blob/master/README_EN.md)\n\n## Install\n\nif you want to install emmylua_ls and emmylua_doc_cli, you can use the following command:\n```shell\n# install emmylua_ls \ncargo install emmylua_ls\n# install emmylua_doc_cli\ncargo install emmylua_doc_cli\n# install emmylua_check\ncargo install emmylua_check\n```\n\nif you are using vscode, you can install the vscode extension [EmmyLua](https://marketplace.visualstudio.com/items?itemName=tangzx.emmylua) to get a better experience.\n\n## Usage\n\n### emmylua_ls\n\nIf you have installed emmylua_ls using cargo install, you can simply run emmylua_ls to start the language server without any additional parameters.\n\n### emmylua_doc_cli\n\nIf you have installed emmylua_doc_cli using cargo install, you can simply run emmylua_doc_cli to generate documentation. You can use the --input parameter to specify the directory of Lua files and the --output parameter to specify the output directory for the generated documentation.\n\n```shell\nemmylua_doc_cli --input ./tests/lua --output ./tests/doc\n```\n\n### emmylua_check\n\nIf you have installed emmylua_check using cargo install, you can simply run emmylua_check to check Lua code.\n\n```shell\nemmylua_check \u003cworkspace\u003e\n```\n\n\n## Build\n\n```shell\ncargo build --release -p emmylua_ls\n```\n\n## Develop\n\nThe language server supports both stdio and TCP communication, with stdio communication as the default. It has several startup parameters:\n- `-c` specifies the communication method. Acceptable values are `stdio` and `tcp`, with the default being `stdio`.\n- `--port` When the `-c` parameter is set to `tcp`, the `--port` parameter can specify the port number, with the default value of `5007`.\n- `--log-level` specifies the log level. Acceptable values are `debug`, `info`, `warn`, `error`, with the default being `info`.\n- `--log-path` specifies the directory path for the log files.\n\nFor example:\n\n```shell\nemmylua_ls -c tcp --port 5007 --log-level debug\n# Without parameters, it uses stdio communication\nemmylua_ls\n```\n\n## License\n\n[MIT](./LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCppCXY%2Femmylua-analyzer-rust","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FCppCXY%2Femmylua-analyzer-rust","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCppCXY%2Femmylua-analyzer-rust/lists"}