disable directory submodule auto export by amtoine · Pull Request #11157 · nushell/nushell

amtoine · 2023-11-26T17:49:48Z

should

close remove directory module autoexport #11133

Description

to allow more freedom when writing complex modules, we are disabling the auto-export of director modules.

the change was as simple as removing the crawling of files and modules next to any mod.nu and update the standard library.

User-Facing Changes

users will have to explicitely use export module <mod> to define submodules and export use <mod> <cmd> to re-export definitions, e.g.

# my-module/mod.nu
export module foo.nu     # export a submodule
export use bar.nu bar-1  # re-export an internal command

export def top [] {
    print "`top` from `mod.nu`"
}

# my-module/foo.nu
export def "foo-1" [] {
    print "`foo-1` from `lib/foo.nu`"
}

export def "foo-2" [] {
    print "`foo-2` from `lib/foo.nu`"
}

# my-module/bar.nu
export def "bar-1" [] {
    print "`bar-1` from `lib/bar.nu`"
}

Tests + Formatting

i had to add export module calls in the tests/modules/samples/spam directory module and allow the not_allowed module to not give an error, it is just empty, which is fine.

After Submitting

mention in the release note
update the following repos
- amtoine/nu-git-manager in fix the export of modules amtoine/nu-git-manager#134
- amtoine/scripts (already done a while back in amtoine/scripts@cb32ad8c)
- amtoine/zellij-layouts (already done)
- nushell/nu_scripts (already done because the modules don't have a mod.nu)
- nushell/nupm in export internal modules manually nupm#47

amtoine · 2023-11-26T17:59:49Z

for now with

# mod.nu
export use lib/foo.nu

export def top [] {
    print "`top` from `mod.nu`"
}

# lib/foo.nu
export def "foo-1" [] {
    print "`foo-1` from `lib/foo.nu`"
}

export def "foo-2" [] {
    print "`foo-2` from `lib/foo.nu`"
}

use my-module will bring all the commands to scope
use my-module foo will run but foo foo-1 and foo foo-2 are not there

EDIT

i've added some temporary debug statements in dae78e1 and what i'm confused about for now is that the two use calls above both show

module: my-module
    sub: foo
        decl: foo-1
        decl: foo-2

as expected so i'm not sure where the issue comes from 😕

amtoine · 2023-11-26T18:17:15Z

actually i think this error does not have anything to do with the changes in this PR 🤔

i'm able to reproduce it with Nushell 0.87.1

this will bring the change made to `use foo bar baz` when `bar` is a command of `foo` and not a submodule -> should give an error.

kubouch · 2023-12-08T21:15:14Z

I see what it is. You need to use export module, not export use. There is a subtle difference. The following:

# my-module/mod.nu
export use lib/foo.nu

export def top [] {
    print "`top` from `mod.nu`"
}

will define three commands inside the module and export them: foo foo-1 and foo foo-2 coming from lib/foo.nu, and top. If you look at scope modules output, you'll see that my-module only contains these three commands. That's why use my-module foo doesn't do anything.

On the other hand:

# my-module/mod.nu
export module lib/foo.nu

export def top [] {
    print "`top` from `mod.nu`"
}

will define foo as a submodule of my-module, so you'll be able to call use my-module foo and it works as expected.

Basically, the rule of thumb is to always use export module, not export use (unless you do something specific, like re-exporting commands from somewhere else to be a part of the module).

There are two problems currently:

use my-module foo should throw an error if foo isn't a valid alias/const/decl/submodule of my-module
export use spam could export the spam submodule as well, so it would be the same as export module + re-exporting its commands etc. Although, the re-exporting is redundant, it's better to use export module, we might want to keep it as it is and rely on the error in 1.

amtoine · 2023-12-09T11:32:43Z

wow, thanks @kubouch, it appears to work very nice now 😮

let me fix the standard library tests 🙏

amtoine · 2023-12-10T10:46:49Z

Important
because it is quite a heavy change from the user's perspective, i think it would be better to wait for after the release to leave us the full 4 weeks to update our modules and tweaks things if necessary

tests/modules/mod.rs

amtoine · 2023-12-15T11:37:38Z

let's try this out 👍
i'll go ahead and fix the modules mentionned above today 😋

depends on - nushell/nushell#11157 - nushell/nupm#47 - #140 - #141 ## description as directory modules won't export the modules next to any `mod.nu`, this PR adds `export module` calls to `nu-git-manager-sugar` and the tests, making the source base compatible again with nushell/nushell#11157 and nushell/nupm#47.

amtoine · 2023-12-16T13:02:45Z

all the packages i know of have been fixed at that point 🆗

depends on - nushell/nushell#11157 - nushell/nupm#47 - #140 - #141 ## description as directory modules won't export the modules next to any `mod.nu`, this PR adds `export module` calls to `nu-git-manager-sugar` and the tests, making the source base compatible again with nushell/nushell#11157 and nushell/nupm#47.

should - close nushell#11133 # Description to allow more freedom when writing complex modules, we are disabling the auto-export of director modules. the change was as simple as removing the crawling of files and modules next to any `mod.nu` and update the standard library. # User-Facing Changes users will have to explicitely use `export module <mod>` to define submodules and `export use <mod> <cmd>` to re-export definitions, e.g. ```nushell # my-module/mod.nu export module foo.nu # export a submodule export use bar.nu bar-1 # re-export an internal command export def top [] { print "`top` from `mod.nu`" } ``` ```nushell # my-module/foo.nu export def "foo-1" [] { print "`foo-1` from `lib/foo.nu`" } export def "foo-2" [] { print "`foo-2` from `lib/foo.nu`" } ``` ```nushell # my-module/bar.nu export def "bar-1" [] { print "`bar-1` from `lib/bar.nu`" } ``` # Tests + Formatting i had to add `export module` calls in the `tests/modules/samples/spam` directory module and allow the `not_allowed` module to not give an error, it is just empty, which is fine. # After Submitting - mention in the release note - update the following repos ``` #┬─────name─────┬version┬─type─┬─────────repo───────── 0│nu-git-manager│0.4.0 │module│amtoine/nu-git-manager 1│nu-scripts │0.1.0 │module│amtoine/scripts 2│nu-zellij │0.1.0 │module│amtoine/zellij-layouts 3│nu-scripts │0.1.0 │module│nushell/nu_scripts 4│nupm │0.1.0 │module│nushell/nupm ─┴──────────────┴───────┴──────┴────────────────────── ```

amtoine added 2 commits November 26, 2023 18:41

do not parse directory modules recursively

709f7d0

reexport the standard library modules

869447c

amtoine added notes:breaking-changes This PR implies a change affecting users and has to be noted in the release notes A:modules Issues related to functionality of the module system. See also usage:modules labels Nov 26, 2023

Merge branch 'main' into disable-directory-submodule-auto-export

c76f5fb

this will bring the change made to `use foo bar baz` when `bar` is a command of `foo` and not a submodule -> should give an error.

amtoine added the notes:mention Include the release notes summary in the "Hall of Fame" section label Dec 9, 2023

amtoine added 3 commits December 9, 2023 13:18

use export use instead of export module in std

baccae9

export modules explicitely in the tests

4d96ce9

not_allowed should not error

612ac01

amtoine force-pushed the disable-directory-submodule-auto-export branch from d9af111 to 612ac01 Compare December 9, 2023 12:25

amtoine marked this pull request as ready for review December 9, 2023 12:34

amtoine mentioned this pull request Dec 9, 2023

export use in modules yields unexpected results #11272

Open

amtoine requested a review from kubouch December 9, 2023 12:38

amtoine added the language label Dec 9, 2023

This was referenced Dec 9, 2023

export internal modules manually nushell/nupm#47

Merged

fix the export of modules amtoine/nu-git-manager#134

Merged

amtoine added the status:wait-until-after-nushell-release label Dec 10, 2023

amtoine mentioned this pull request Dec 13, 2023

Release notes for 0.89.0 nushell/nushell.github.io#1174

Merged

8 tasks

kubouch reviewed Dec 13, 2023

View reviewed changes

tests/modules/mod.rs Outdated Show resolved Hide resolved

remove the not_allowed_submodule_file test

fc203d1

amtoine merged commit 156232f into nushell:main Dec 15, 2023

amtoine deleted the disable-directory-submodule-auto-export branch December 15, 2023 11:38

amtoine mentioned this pull request Dec 17, 2023

Calling several external tools no longer works #11347

Closed

This was referenced Jan 18, 2024

Warn when loading empty mod.nu #11573

Open

use causes module directory subcommand to be added to wrong module #11501

Closed

kubouch mentioned this pull request Jan 19, 2024

Update modules.md nushell/nushell.github.io#1215

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

disable directory submodule auto export#11157

disable directory submodule auto export#11157
amtoine merged 7 commits intonushell:mainfrom
amtoine:disable-directory-submodule-auto-export

amtoine commented Nov 26, 2023 •

edited

Loading

Uh oh!

amtoine commented Nov 26, 2023 •

edited

Loading

Uh oh!

amtoine commented Nov 26, 2023

Uh oh!

kubouch commented Dec 8, 2023

Uh oh!

amtoine commented Dec 9, 2023

Uh oh!

amtoine commented Dec 10, 2023

Uh oh!

Uh oh!

amtoine commented Dec 15, 2023

Uh oh!

amtoine commented Dec 16, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

amtoine commented Nov 26, 2023 • edited 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!

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

Uh oh!

EDIT

Uh oh!

amtoine commented Nov 26, 2023

Uh oh!

kubouch commented Dec 8, 2023

Uh oh!

amtoine commented Dec 9, 2023

Uh oh!

amtoine commented Dec 10, 2023

Uh oh!

Uh oh!

amtoine commented Dec 15, 2023

Uh oh!

amtoine commented Dec 16, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

amtoine commented Nov 26, 2023 •

edited

Loading

amtoine commented Nov 26, 2023 •

edited

Loading