Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(devenv): adds Modules support #766

Merged
merged 1 commit into from Feb 24, 2023
Merged

feat(devenv): adds Modules support #766

merged 1 commit into from Feb 24, 2023

Conversation

nojhan
Copy link
Collaborator

@nojhan nojhan commented Feb 22, 2023

This feature will display the list of loaded modules in the "dev env" section.

Configurable information: items versions, color, hashed color, marks.

Environment modules is a tool allowing for dynamic modification of a user's environment, which is quite ubiquitous in high-performance computing systems. https://modules.readthedocs.io

Refs: #763

Technical checklist:

  • code follows our shell standards:
    • correct use of IFS
    • careful quoting
    • cautious array access
    • portable array indexing with _LP_FIRST_INDEX
    • printing a "%" character is done with _LP_PERCENT
    • functions/variable naming conventions
    • functions have local variables
    • data functions have optimization guards (early exits)
    • subshells are avoided as much as possible
    • string substitutions may be done differently in Bash and Zsh (use _LP_SHELL_*)
  • tests and checks have been added, ran, and their warnings fixed:
    • unit tests have been updated (see tests/test_*.sh files)
    • ran test.sh
    • ran shellcheck.sh (requires shellcheck).
  • documentation have been updated accordingly:
    • functions and attributes are documented in alphabetical order
    • new sections are documented in the default theme
    • tag .. versionadded:: X.Y or .. versionchanged:: Y.Z
    • functions signatures have arguments, returned code, and set value(s)
    • attributes have types and defaults
    • ran docs/docs-lint.sh (requires Python 3 and requirements.txt
      installed (cd docs/; python3 -m venv venv; . venv/bin/activate; pip install -r requirements.txt))

@nojhan nojhan added the enhancement Feature request label Feb 22, 2023
@nojhan nojhan added this to the v2.2 milestone Feb 22, 2023
@nojhan nojhan marked this pull request as ready for review February 22, 2023 20:03
@nojhan nojhan requested a review from Rycieos February 22, 2023 20:03
Copy link
Collaborator

@Rycieos Rycieos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good in general. Rebase onto latest master to fix the Shellcheck failure.

liquidprompt Show resolved Hide resolved
docs/config.rst Outdated Show resolved Hide resolved
docs/config.rst Outdated Show resolved Hide resolved
This feature will display the list of loaded modules in the "dev env" section.

Configurable information: items versions, color, hashed color, marks.

Environment modules is a tool allowing for dynamic modification of a user's environment,
which is quite ubiquitous in high-performance computing systems.
https://modules.readthedocs.io

Refs: #763
@Rycieos Rycieos merged commit 24ad575 into master Feb 24, 2023
@Rycieos Rycieos deleted the feat/modules branch February 24, 2023 16:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Feature request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants