Make into a CLI tool

[jpike88]

It would be good if this could be run via cli directly and throw an error if issues are found. That way there's alignment between code editor and CI

[blopker]

Hey! Thanks for raising this. I do use it as a CLI for testing, but I'm not sure what would be helpful output for CI. How would you like it to run? What would the ouput look like?

[jpike88]

I'm angular/nodejs, for it to perfectly fall into my pipeline I'd like to be able to install it from npm to have the binary available in the package (not a big deal there)

Then I'd like to run something like
codebook ./**/*.ts, so maybe pass one or more globs to it.

Then, it would scan, and successfully it would just return exit code 0.

I like how biome flags issues when they're found, something like the screenshot

Return exit code 1, return an errors string like:

Error: Spellchecked 421 files in 149ms.
Found 1 spelling issue.

[jpike88]

Modification to my request: I just realized no need to pass globs. just relying on the .codebook config is plenty

[jpike88]

But it would need an allow_paths configuration item

[blopker]

Thanks for the extra info. I'm going to add this in the future, but right now I'm still working out how the dictionary management works. While that process is ongoing, the words that get flagged are going to change over time. My concern is that I don't want to be breaking people's CI, causing extra work.

Please bear with me while things stabilize 😅

[inferiorhumanorgans]

As someone with less than zero interest in yet another bloated Microsoft protocol the risk of getting incorrect results from codebook is outweighed by the benefits of not having to hack together an LSP client. I suspect anyone who's had even the slightest exposure to SOAP feels similarly.

[blopker]

Fair enough. I will say there's a pretty rudimentary CLI in crates/codebook/src/main.rs that I use for quick testing and running benchmarks. It doesn't even load the codebook.toml file right now though, and it's not set up for an easy installation. However, I'd be happy to take PRs for it, especially to start iterating on what the interface would look like. It can be run with cargo run -p codebook from the root directory.

[inferiorhumanorgans]

I just hacked up something quickly and published it as spellcode-cli. It does enough of what I want to fit into my CI pipeline (reads codebook.toml at a specified path, allows directories to be excluded). For a Rust project that may be enough. For other languages probably not.

[niekdomi]

and published it as spellcode-cli

What do you mean by published? Can't find anything on your account, though I would be quite interested in such a tool for the CI as well.

[inferiorhumanorgans]

I meant published on crates.io. I no longer put projects on Github due to ethical concerns with AI (and, of course, the atriocious UI updates).

[blopker]

Hey, good news! @niekdomi has landed a lint subcommand on the LSP binary (codebook-lsp). I've just put out a release with it. Would love any feedback! If this is something people find useful, I think it would make sense to deprecate the -lsp binary and have a unified codebook entry point with an lsp subcommand, but that's a major refactor.

Anyway, this is out for testing, but I've marked it as unstable as we'll likely need to change it as feedback comes in. Check out the readme for more info!