Added `help externs` command by klementievdmitry · Pull Request #8403 · nushell/nushell

klementievdmitry · 2023-03-11T07:47:54Z

Description

help externs - command, which list external commands

User-Facing Changes

$ help externs
╭───┬──────────────┬─────────────┬───────────────────────────────────────────────────╮
│ # │     name     │ module_name │                       usage                       │
├───┼──────────────┼─────────────┼───────────────────────────────────────────────────┤
│ 0 │ git push     │ completions │ Push changes                                      │
│   │              │             │                                                   │
│ 1 │ git fetch    │ completions │ Download objects and refs from another repository │
│   │              │             │                                                   │
│ 2 │ git checkout │ completions │ Check out git branches and files                  │
│   │              │             │                                                   │
╰───┴──────────────┴─────────────┴───────────────────────────────────────────────────╯

Tests + Formatting

Don't forget to add tests that cover your changes.

Make sure you've run and fixed any issues with these commands:

cargo fmt --all -- --check to check standard code formatting (cargo fmt --all applies these changes)
cargo clippy --workspace -- -D warnings -D clippy::unwrap_used -A clippy::needless_collect to check that you're using the standard code style
cargo test --workspace to check that all tests pass

After Submitting

If your PR had any user-facing changes, update the documentation after the PR is merged, if necessary. This will help us keep the docs up to date.

codecov · 2023-03-11T08:09:25Z

Codecov Report

Merging #8403 (0ec069e) into main (e435196) will decrease coverage by 0.07%.
The diff coverage is 31.44%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #8403      +/-   ##
==========================================
- Coverage   68.25%   68.18%   -0.07%     
==========================================
  Files         620      621       +1     
  Lines       99355    99514     +159     
==========================================
+ Hits        67813    67857      +44     
- Misses      31542    31657     +115

Impacted Files	Coverage Δ
crates/nu-engine/src/scope.rs	`81.36% <0.00%> (-5.96%)`	⬇️
...ates/nu-cmd-lang/src/core_commands/help_externs.rs	`41.88% <41.88%> (ø)`
crates/nu-cmd-lang/src/default_context.rs	`98.52% <100.00%> (+0.02%)`	⬆️

... and 2 files with indirect coverage changes

amtoine · 2023-03-11T09:13:31Z

This should close #8301 👌

fdncred · 2023-03-11T13:28:58Z

If we're going to have this command, I'd rather call it help extern since it shows up here $nu.scope.commands | where is_extern == true as is_extern.

I also think that it would be good to have the module_name column.

The category, signatures, and search_terms don't seem particularly useful.

Just my two cents.

fdncred · 2023-03-11T18:21:52Z

@klementievdmitry oops, I made a mistake. Sorry, but we can't use help extern because we already have an extern command and help extern shows that help. Maybe making it plural is ok like help externs, unless you have a better suggestion.

klementievdmitry · 2023-03-11T18:56:29Z

Well, I didn't even think about it, I just did 😄, and I have no other ideas.

kubouch · 2023-03-12T12:07:56Z

I'm thinking help externals is clearer and even more distinct. Otherwise, I'm ok with this PR.

kubouch · 2023-03-12T12:22:27Z

One thing we might do is to remove aliases and externals from help commands, and make better customized individual help messages for them. The externals discovery should also be added here

nushell/crates/nu-cmd-lang/src/core_commands/help.rs

Lines 88 to 115 in a52386e

    
           } else { 
        
               let result = help_aliases(engine_state, stack, call); 
        
               let result = if let Err(ShellError::AliasNotFound(_)) = result { 
        
                   help_commands(engine_state, stack, call) 
        
               } else { 
        
                   result 
        
               }; 
        
               let result = if let Err(ShellError::CommandNotFound(_)) = result { 
        
                   help_modules(engine_state, stack, call) 
        
               } else { 
        
                   result 
        
               }; 
        
               if let Err(ShellError::ModuleNotFoundAtRuntime { 
        
                   mod_name: _, 
        
                   span: _, 
        
               }) = result 
        
               { 
        
                   let rest_spans: Vec<Span> = rest.iter().map(|arg| arg.span).collect(); 
        
                   Err(ShellError::NotFound { 
        
                       span: span(&rest_spans), 
        
                   }) 
        
               } else { 
        
                   result 
        
               } 
        
           }

. help name should be different based on whether name is a command, alias or known external. I think known externals might have one already, not sure, but the aliases should show a more customized message in addition to showing the wrapped command's help message. But these changes can be done in a future PR.

Ultimately, the help commands could be re-implemented in Nu code as a part of the standard library so that's also something to consider in the future.

amtoine · 2023-03-12T12:49:31Z

(@kubouch added to the task list in #8311 😉)

fdncred · 2023-03-12T13:00:45Z

I'm thinking help externals is clearer and even more distinct. Otherwise, I'm ok with this PR.

I think help externals is confusing because your file system is filled with externals that are not nushell built-ins. Is help externals supposed to list everything on your file system that isn't a built-in? Also, if we're going to be consistent, then it should match is_extern but we can't have help extern because extern is a built-in. Which is why it's plural now. So, I'm voting against help externals since it's so confusing.

kubouch · 2023-03-12T13:06:44Z

OK, let's keep it help externs then. Alternative is help known-externals but that seems too verbose...

fdncred · 2023-03-12T13:15:28Z

I agree that help known-externals is too verbose but it is descriptive. I'm up for something else too, as long as it's less confusing. overloaded terms like extern are confusing. maybe the nushell code should call them something else too.

sholderbach · 2023-03-15T17:40:03Z

I would like to move ahead with this even though I can understand the arguments for and against certain naming decisions.

klementievdmitry added 2 commits March 11, 2023 12:04

added help externals command, which list externals (#8301)

aaf1fc0

added help external command tests

5c25218

sholderbach linked an issue Mar 11, 2023 that may be closed by this pull request

aliases should be listed in help alias or $nu.scope.aliases and externals in help externals #8301

Closed

2 tasks

amtoine mentioned this pull request Mar 11, 2023

aliases should be listed in help alias or $nu.scope.aliases and externals in help externals #8301

Closed

2 tasks

rename and rework help extern command

3631a84

klementievdmitry changed the title ~~Added help external command~~ Added help extern command Mar 11, 2023

klementievdmitry added 2 commits March 12, 2023 00:08

rename help extern to help externs

9fa58ee

fix signature name

0ec069e

klementievdmitry changed the title ~~Added help extern command~~ Added help externs command Mar 12, 2023

amtoine mentioned this pull request Mar 12, 2023

standard library: a few ideas of commands #8311

Open

14 tasks

fdncred added the status:wait-until-after-nushell-release label Mar 13, 2023

sholderbach merged commit 4de0347 into nushell:main Mar 15, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added `help externs` command#8403

Added `help externs` command#8403
sholderbach merged 5 commits intonushell:mainfrom
klementievdmitry:main

klementievdmitry commented Mar 11, 2023 •

edited by kubouch

Loading

Uh oh!

codecov bot commented Mar 11, 2023 •

edited

Loading

Uh oh!

amtoine commented Mar 11, 2023

Uh oh!

fdncred commented Mar 11, 2023

Uh oh!

fdncred commented Mar 11, 2023

Uh oh!

klementievdmitry commented Mar 11, 2023

Uh oh!

kubouch commented Mar 12, 2023

Uh oh!

kubouch commented Mar 12, 2023

Uh oh!

amtoine commented Mar 12, 2023 •

edited

Loading

Uh oh!

fdncred commented Mar 12, 2023

Uh oh!

kubouch commented Mar 12, 2023

Uh oh!

fdncred commented Mar 12, 2023

Uh oh!

sholderbach commented Mar 15, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

klementievdmitry commented Mar 11, 2023 • edited by kubouch Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

User-Facing Changes

Tests + Formatting

After Submitting

Uh oh!

codecov bot commented Mar 11, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

amtoine commented Mar 11, 2023

Uh oh!

fdncred commented Mar 11, 2023

Uh oh!

fdncred commented Mar 11, 2023

Uh oh!

klementievdmitry commented Mar 11, 2023

Uh oh!

kubouch commented Mar 12, 2023

Uh oh!

kubouch commented Mar 12, 2023

Uh oh!

amtoine commented Mar 12, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

fdncred commented Mar 12, 2023

Uh oh!

kubouch commented Mar 12, 2023

Uh oh!

fdncred commented Mar 12, 2023

Uh oh!

sholderbach commented Mar 15, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

klementievdmitry commented Mar 11, 2023 •

edited by kubouch

Loading

codecov bot commented Mar 11, 2023 •

edited

Loading

amtoine commented Mar 12, 2023 •

edited

Loading