nushell / nushell/nushell.github.io

Formats for loading data directly into tables from docs not matching actual support

Open
#2,139 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
258
Forks
561
Avg merge
3h 20m
Merged PRs (30d)
15

Description

Hi,

I tried opening an xls file with the open command and got garbled output. I checked the docs and saw that it was supposed to be able to open xls files. Looked into what "from commands" actually existed using the sample command from the open docs (See copy of command at bottom) and xls was not in the list. I'm not sure what is the best way to "correct" this mismatch.

The list I'm referring to in the docs is defined here

The following are in the docs but not supported in my version of nu (0.111.0)

  • eml
  • ics
  • ini
  • vcf
  • xls

The following show when I run the command to get the "from commands" in scope but do not appear in the documentation:

  • msgpack
  • msgpackz

Command from Open Docs Showing List of From formats

Command

> scope commands
    | where name starts-with "from "
    | insert extension { get name | str replace -r "^from " "" | $"*.($in)" }
    | select extension name
    | rename extension command

Output for me on nu 0.111.0

╭────┬────────────┬───────────────╮
│  # │ extension  │    command    │
├────┼────────────┼───────────────┤
│  0 │ *.csv      │ from csv      │
│  1 │ *.json     │ from json     │
│  2 │ *.msgpack  │ from msgpack  │
│  3 │ *.msgpackz │ from msgpackz │
│  4 │ *.nuon     │ from nuon     │
│  5 │ *.ods      │ from ods      │
│  6 │ *.ssv      │ from ssv      │
│  7 │ *.toml     │ from toml     │
│  8 │ *.tsv      │ from tsv      │
│  9 │ *.url      │ from url      │
│ 10 │ *.xlsx     │ from xlsx     │
│ 11 │ *.xml      │ from xml      │
│ 12 │ *.yaml     │ from yaml     │
│ 13 │ *.yml      │ from yml      │
╰────┴────────────┴───────────────╯

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Compare the format list in book/loading_data.md with the output of the documented scope commands query for Nushell 0.111.0. Determine which list is authoritative, update the loading-data and open-command documentation as appropriate, and rerun the query to verify that documented formats match actual support.

Written by the indexing model from the issue text.

Assessment

Tech stack
shell
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.