jscutlery/nx-completion

Nx workspace completion plugin for Zsh.

nx-completion's Issues

Does not work without a workspace file

If the workspace.json file does not exist (as is the way with a modern nx monorepo), the plugin generates this error when trying to autocomplete a package name:

Feature: dynamically grab target definition and build completion out of it

Actually, the plugin statically describes commands and their arguments. It might break on different workspaces as they may use another type of executor than the one described in the plugin.

To fix this issue we could dynamically grab the target definition and build the completion out of it.

Bug: cache works only for `nx` root command

To avoid heavy computation we need to cache all sub commands as nx generate.

> NX Running global Nx CLI with PNPM may have issues.

When running nx in pnpm managed repo, I get the following warning (which sometimes even results in not working command)

 >  NX   Running global Nx CLI with PNPM may have issues.

   Prefer to use "pnpm" (https://pnpm.io/cli/exec) to execute commands in this workspace.
    TIP  create a shortcut such as: alias pnx="pnpm nx --"

Using the alias from the TIP would break this autocompletion, so would be really great if the plugin could work with PNPM natively and run pnpm nx whenever nx is used.

Here is what I came up with as a solution for me:

In .zrhrc

function pnpm-nx() {
	local cmd=$BUFFER
	if [[ "$cmd" =~ ^nx ]]; then
		local new_cmd=$(echo $cmd | sed -E 's/^nx /pnpm nx /g')
		BUFFER="$new_cmd"
	fi
	zle accept-line
}

zle -N pnpm-nx
bindkey "^M" pnpm-nx

So, now whenever I type nx {command} it gets replaced by pnpm nx {command} automatically on Enter. This also doesn't break this autocompletion plugin

zsh-snap load

Thanks for writing this :)

Probably not worth including in the readme, but felt like sharing.

I was able to get this added to my zsh-snap based config with a one-liner:

znap eval nx "curl -fsSL https://raw.githubusercontent.com/zdog234/nx-completion/main/nx-completion.plugin.zsh"

(pointed at a fork because paranoia)

random aside:

I'm surprised nx doesn't include completion out of the box -- it seems like the JS ecosystem is a bit lacking w.r.t. CLI libaries compared to other languages I've worked in

Format arguments to camel-case

All arguments should be formatted in camel-case, eg: --i18nLocale instead of --i18n-locale.

Feature Request: Work with local Nx CLI installation

Hi,

This is such a nice plugin that I don't realize I want. However, like many people, I don't usually have Nx CLI installed globally and use yarn nx (or npx nx) to invoke the locally installed nx instead.

That said, would it be possible to support yarn nx as well?

Thanks

Update arguments to stick to nx 12.x.x

• A couple of arguments are outdated and/or missing, eg: --deleteOutputPath for nx build.
• Regular Angular CLI arguments are not necessary, we can delete them.

'nx g' does not complete

Hi!

Completions work quite nicely, but I can't get "nx generate" to complete anything. I've seen that in the code you call nx g which in my case returns Specify the generator name (e.g., nx generate @nrwl/workspace:library) on stderr. My nx --version is 13.9.2.

Regards
Adam

Support for workspace definition v2 format

The plugin should support the v2 definition format, more info here on the changes.

This plugin breaks globalias

https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins/globalias is a plugin that exapnds aliases when you press space.

Having this plugin loaded breaks the functionality of that.

Interestingly, when in a nix-shell it starts to work again.

Support for npx and other ways to use `nx` without having it installed globally

I use nx with npx because I don't want to deal with update my global install and I can use the version installed on each project, not the global one.

There is a way to use your plugin to have compatibility with npx and other ways to use nx without having it installed globally (like yarn and npm)?

Breaks on plugins that cannot be found

Hi all,

In a NX-angular project I cannot use the nx-completion plugin. It gives two errors when using it:

nx g Plugin listed in nx.json not found: devextreme-schematics
Plugin listed in nx.json not found: ng-extract-i18n-merge

These are npm installed packages, I'm not aware that they are listed in nx.json or elsewhere.

Thanks in advance

nx lint doesn't autocomplete project names

Hi, thanks for that plugin!

Just a small issue, for build it autocomplete properly:

However it's not the case for lint:

Thanks!

Is md5sha1sum also a dependency?

When running the latest version I got this error command not found: md5sum. That's probably because I needed to install it on MacOS with brew install md5sha1sum. After that it works fine. So maybe this should be mentioned in the readme.

Support for standalone project definition

The plugin should support standalone project definition.