Skip to content

Unify code in emmylua_check and emmylua_doc_cli #609

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 15, 2025

Conversation

taminomara
Copy link
Contributor

Merge this after #608.

Both CLI tools have similar, yet slightly different code and usage. This PR makes them more consistent.

In emmylua_doc_cli:

  • added positional parameter [WORKSPACE]...;
  • deprecated -i, --input in favor of [WORKSPACE]...;
  • added -c, --config to specify location of .emmyrc.json/.luarc.json;
  • added --ignore to specify ignored files. No short option for --ignore because that would clash with -i, --input;
  • deprecated long option --format in favor of --output-format;
  • supported --output stdout for JSON output;
  • re-implemented debug output using log crate, added --verbose option;
  • contents of init.rs are now identical to those from emmylua_check.

In emmylua_check:

  • added short option -f for output format,
  • supported specifying multiple workspaces.

@CppCXY
Copy link
Member

CppCXY commented Jul 15, 2025

please fix the conflicts

Both CLI tools have similar, yet slightly different code and usage. This PR makes them more consistent.

In `emmylua_doc_cli`:

- added positional parameter `[WORKSPACE]...`;
- deprecated `-i, --input` in favor of `[WORKSPACE]...`;
- added `-c, --config` to specify location of `.emmyrc.json`/`.luarc.json`;
- added `--ignore` to specify ignored files. No short option for `--ignore` because that would clash with `-i, --input`;
- deprecated long option `--format` in favor of `--output-format`;
- supported `--output stdout` for JSON output;
- re-implemented debug output using `log` crate, added `--verbose` option;
- contents of `init.rs` are now identical to those from `emmylua_check`.

In `emmylua_check`:

- added short option `-f` for output format,
- supported specifying multiple workspaces.
@CppCXY CppCXY merged commit 059632d into EmmyLuaLs:main Jul 15, 2025
17 checks passed
@clason
Copy link

clason commented Jul 16, 2025

This seems to have broken something -- my workspace config isn't picked up anymore, and I get a lot of warnings like

warning: Unknown doc tag: inlinedoc [unknown-doc-tag]

(This is on nvim-treesitter using the checked-in .luarc.json and the call VIMRUNTIME=/usr/local/share/nvim/runtime/ emmylua_check .)

@CppCXY
Copy link
Member

CppCXY commented Jul 16, 2025

This seems to have broken something -- my workspace config isn't picked up anymore, and I get a lot of warnings like

warning: Unknown doc tag: inlinedoc [unknown-doc-tag]

(This is on nvim-treesitter using the checked-in .luarc.json and the call VIMRUNTIME=/usr/local/share/nvim/runtime/ emmylua_check .)

Please create a new issue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants