Move some from xxx commands to plugin (#7942)

# Description From nushell 0.8 philosophy: https://github.com/nushell/nushell.github.io/blob/main/contributor-book/philosophy_0_80.md#core-categories > The following categories should be moved to plugins: Uncommon format support So this pr is trying to move following commands to plugin: - [X] from eml - [x] from ics - [x] from ini - [x] from vcf And we can have a new plugin handles for these formatting, currently it's implemented here: https://github.com/WindSoilder/nu_plugin_format The command usage should be the same to original command. If it's ok, the plugin can support more formats like [parquet](https://github.com/fdncred/nu_plugin_from_parquet), or [EDN format](https://github.com/nushell/nushell/issues/6415), or something else. Just create a draft pr to show what's the blueprint looks like, and is it a good direction to move forward? # User-Facing Changes _(List of all changes that impact the user experience here. This helps us keep track of breaking changes.)_ # 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](https://github.com/nushell/nushell.github.io) after the PR is merged, if necessary. This will help us keep the docs up to date.
2025-08-16 22:01:42 +02:00 · 2023-02-13 20:42:08 +08:00
parent 4468dc835c
commit 208ffdc1da
32 changed files with 734 additions and 828 deletions
--- a/tests/plugins/formats/eml.rs
+++ b/tests/plugins/formats/eml.rs
@ -0,0 +1,65 @@
+use nu_test_support::nu_with_plugins;
+
+const TEST_CWD: &str = "tests/fixtures/formats";
+
+// Note: the tests can only run successfully if nushell binary is in `target/debug/`
+// The To field in this email is just "to@example.com", which gets parsed out as the Address. The Name is empty.
+#[test]
+fn from_eml_get_to_field() {
+    let actual = nu_with_plugins!(
+        cwd: TEST_CWD,
+        plugin: ("nu_plugin_formats"),
+        "open sample.eml | get To.Address"
+    );
+
+    assert_eq!(actual.out, "to@example.com");
+    let actual = nu_with_plugins!(
+        cwd: TEST_CWD,
+        plugin: ("nu_plugin_formats"),
+        "open sample.eml | get To | get Name"
+    );
+
+    assert_eq!(actual.out, "");
+}
+
+// The Reply-To field in this email is "replyto@example.com" <replyto@example.com>, meaning both the Name and Address values are identical.
+#[test]
+fn from_eml_get_replyto_field() {
+    let actual = nu_with_plugins!(
+        cwd: TEST_CWD,
+        plugin: ("nu_plugin_formats"),
+        "open sample.eml | get Reply-To | get Address"
+    );
+
+    assert_eq!(actual.out, "replyto@example.com");
+
+    let actual = nu_with_plugins!(
+        cwd: TEST_CWD,
+        plugin: ("nu_plugin_formats"),
+        "open sample.eml | get Reply-To | get Name"
+    );
+
+    assert_eq!(actual.out, "replyto@example.com");
+}
+
+#[test]
+fn from_eml_get_subject_field() {
+    let actual = nu_with_plugins!(
+        cwd: TEST_CWD,
+        plugin: ("nu_plugin_formats"),
+        "open sample.eml | get Subject"
+    );
+
+    assert_eq!(actual.out, "Test Message");
+}
+
+#[test]
+fn from_eml_get_another_header_field() {
+    let actual = nu_with_plugins!(
+        cwd: TEST_CWD,
+        plugin: ("nu_plugin_formats"),
+        "open sample.eml | get MIME-Version"
+    );
+
+    assert_eq!(actual.out, "1.0");
+}
--- a/tests/plugins/formats/ics.rs
+++ b/tests/plugins/formats/ics.rs
@ -0,0 +1,99 @@
+use nu_test_support::fs::Stub::FileWithContentToBeTrimmed;
+use nu_test_support::nu_with_plugins;
+use nu_test_support::playground::Playground;
+
+#[test]
+fn infers_types() {
+    Playground::setup("filter_from_ics_test_1", |dirs, sandbox| {
+        sandbox.with_files(vec![FileWithContentToBeTrimmed(
+            "calendar.ics",
+            r#"
+                BEGIN:VCALENDAR
+                PRODID:-//Google Inc//Google Calendar 70.9054//EN
+                VERSION:2.0
+                BEGIN:VEVENT
+                DTSTART:20171007T200000Z
+                DTEND:20171007T233000Z
+                DTSTAMP:20200319T182138Z
+                UID:4l80f6dcovnriq38g57g07btid@google.com
+                CREATED:20170719T202915Z
+                DESCRIPTION:
+                LAST-MODIFIED:20170930T190808Z
+                LOCATION:
+                SEQUENCE:1
+                STATUS:CONFIRMED
+                SUMMARY:Maryland Game
+                TRANSP:TRANSPARENT
+                END:VEVENT
+                BEGIN:VEVENT
+                DTSTART:20171002T010000Z
+                DTEND:20171002T020000Z
+                DTSTAMP:20200319T182138Z
+                UID:2v61g7mij4s7ieoubm3sjpun5d@google.com
+                CREATED:20171001T180103Z
+                DESCRIPTION:
+                LAST-MODIFIED:20171001T180103Z
+                LOCATION:
+                SEQUENCE:0
+                STATUS:CONFIRMED
+                SUMMARY:Halloween Wars
+                TRANSP:OPAQUE
+                END:VEVENT
+                END:VCALENDAR
+            "#,
+        )]);
+        let cwd = dirs.test();
+
+        let actual = nu_with_plugins!(
+            cwd: cwd,
+            plugin: ("nu_plugin_formats"),
+            "open calendar.ics | get events.0 | length"
+        );
+
+        assert_eq!(actual.out, "2");
+    })
+}
+
+#[test]
+fn from_ics_text_to_table() {
+    Playground::setup("filter_from_ics_test_2", |dirs, sandbox| {
+        sandbox.with_files(vec![FileWithContentToBeTrimmed(
+            "calendar.txt",
+            r#"
+                BEGIN:VCALENDAR
+                BEGIN:VEVENT
+                DTSTART:20171007T200000Z
+                DTEND:20171007T233000Z
+                DTSTAMP:20200319T182138Z
+                UID:4l80f6dcovnriq38g57g07btid@google.com
+                CREATED:20170719T202915Z
+                DESCRIPTION:
+                LAST-MODIFIED:20170930T190808Z
+                LOCATION:
+                SEQUENCE:1
+                STATUS:CONFIRMED
+                SUMMARY:Maryland Game
+                TRANSP:TRANSPARENT
+                END:VEVENT
+                END:VCALENDAR
+            "#,
+        )]);
+
+        let cwd = dirs.test();
+        let actual = nu_with_plugins!(
+            cwd: cwd,
+            plugin: ("nu_plugin_formats"),
+            r#"
+                open calendar.txt
+                | from ics
+                | get events.0
+                | get properties.0
+                | where name == "SUMMARY"
+                | first
+                | get value
+            "#
+        );
+
+        assert_eq!(actual.out, "Maryland Game");
+    })
+}
--- a/tests/plugins/formats/ini.rs
+++ b/tests/plugins/formats/ini.rs
@ -0,0 +1,55 @@
+use nu_test_support::fs::Stub::FileWithContentToBeTrimmed;
+use nu_test_support::nu_with_plugins;
+use nu_test_support::playground::Playground;
+
+const TEST_CWD: &str = "tests/fixtures/formats";
+
+#[test]
+fn parses_ini() {
+    let actual = nu_with_plugins!(
+        cwd: TEST_CWD,
+        plugin: ("nu_plugin_formats"),
+        "open sample.ini | get SectionOne.integer"
+    );
+
+    assert_eq!(actual.out, "1234")
+}
+
+#[test]
+fn parses_utf16_ini() {
+    let actual = nu_with_plugins!(
+        cwd: TEST_CWD,
+        plugin: ("nu_plugin_formats"),
+        "open ./utf16.ini --raw | decode utf-16 | from ini | rename info | get info | get IconIndex"
+    );
+
+    assert_eq!(actual.out, "-236")
+}
+
+#[test]
+fn read_ini_with_missing_session() {
+    Playground::setup("from ini with missiong session", |dirs, sandbox| {
+        sandbox.with_files(vec![FileWithContentToBeTrimmed(
+            "some_missing.ini",
+            r#"
+            min-width=450
+            max-width=820
+            [normal]
+            sound-file=/usr/share/sounds/freedesktop/stereo/dialog-information.oga
+            [critical]
+            border-color=FAB387ff
+            default-timeout=20
+            sound-file=/usr/share/sounds/freedesktop/stereo/dialog-warning.oga
+            "#,
+        )]);
+
+        let cwd = dirs.test();
+        let actual = nu_with_plugins!(
+            cwd: cwd,
+            plugin: ("nu_plugin_formats"),
+            r#"open some_missing.ini | get "".min-width "#
+        );
+
+        assert_eq!(actual.out, "450");
+    })
+}
--- a/tests/plugins/formats/mod.rs
+++ b/tests/plugins/formats/mod.rs
@ -0,0 +1,4 @@
+mod eml;
+mod ics;
+mod ini;
+mod vcf;
--- a/tests/plugins/formats/vcf.rs
+++ b/tests/plugins/formats/vcf.rs
@ -0,0 +1,83 @@
+use nu_test_support::fs::Stub::FileWithContentToBeTrimmed;
+use nu_test_support::nu_with_plugins;
+use nu_test_support::playground::Playground;
+
+#[test]
+fn infers_types() {
+    Playground::setup("filter_from_vcf_test_1", |dirs, sandbox| {
+        sandbox.with_files(vec![FileWithContentToBeTrimmed(
+            "contacts.vcf",
+            r#"
+                BEGIN:VCARD
+                VERSION:3.0
+                FN:John Doe
+                N:Doe;John;;;
+                EMAIL;TYPE=INTERNET:john.doe99@gmail.com
+                item1.ORG:'Alpine Ski Resort'
+                item1.X-ABLabel:Other
+                item2.TITLE:'Ski Instructor'
+                item2.X-ABLabel:Other
+                BDAY:19001106
+                NOTE:Facebook: john.doe.3\nWebsite: \nHometown: Cleveland\, Ohio
+                CATEGORIES:myContacts
+                END:VCARD
+                BEGIN:VCARD
+                VERSION:3.0
+                FN:Alex Smith
+                N:Smith;Alex;;;
+                TEL;TYPE=CELL:(890) 123-4567
+                CATEGORIES:Band,myContacts
+                END:VCARD
+            "#,
+        )]);
+
+        let cwd = dirs.test();
+        let actual = nu_with_plugins!(
+            cwd: cwd,
+            plugin: ("nu_plugin_formats"),
+            "open contacts.vcf | length"
+        );
+
+        assert_eq!(actual.out, "2");
+    })
+}
+
+#[test]
+fn from_vcf_text_to_table() {
+    Playground::setup("filter_from_vcf_test_2", |dirs, sandbox| {
+        sandbox.with_files(vec![FileWithContentToBeTrimmed(
+            "contacts.txt",
+            r#"
+                BEGIN:VCARD
+                VERSION:3.0
+                FN:John Doe
+                N:Doe;John;;;
+                EMAIL;TYPE=INTERNET:john.doe99@gmail.com
+                item1.ORG:'Alpine Ski Resort'
+                item1.X-ABLabel:Other
+                item2.TITLE:'Ski Instructor'
+                item2.X-ABLabel:Other
+                BDAY:19001106
+                NOTE:Facebook: john.doe.3\nWebsite: \nHometown: Cleveland\, Ohio
+                CATEGORIES:myContacts
+                END:VCARD
+            "#,
+        )]);
+
+        let cwd = dirs.test();
+        let actual = nu_with_plugins!(
+            cwd: cwd,
+            plugin: ("nu_plugin_formats"),
+            r#"
+                open contacts.txt
+                | from vcf
+                | get properties.0
+                | where name == "EMAIL"
+                | first
+                | get value
+            "#
+        );
+
+        assert_eq!(actual.out, "john.doe99@gmail.com");
+    })
+}