refactor: ✨ (#418)

* refactor: ✨ move in one commit

Eveything in modules should probably be changed to `exported` defs.
The idea is to move everything first to keep proper history.

* refactor: 📝 add modules readme (wip)

* refactor: ✨ small move

* refactor: 📝 changed nestring, updated modules readme

* refactor: 📝 to document or not to document

* fix: 🐛 themes

replaced the template to use `main` and regenerated them
from lemnos themes.

* Revert "fix: 🐛 themes"

This reverts commit 4918d36.

* refactor: ✨ introduce sourced

- Created a source `root` in which sourcable demos are stored.
  Some might get converted to modules later on.
- Moved some files to bin too.

* fix: 🐛 fehbg.nu

* fix: 🐛 modules/after.nu

* moved some other stuff around

---------

Co-authored-by: Darren Schroeder <[email protected]>

README.md

@@ -1,6 +1,21 @@
 # Nushell Scripts
 
-This is a place to share Nushell scripts with each other. If you'd like to share your scripts, create a PR that adds it to the repo.
+This is a place to share Nushell scripts with each other. If you'd like to share your scripts, fork this repository, and [create a PR](https://github.com/nushell/nu_scripts/compare) that adds it to the repo.
+
+## Sections
+
+- [aliases](./aliases/)
+- [benchmarks](./benchmarks/)
+- [bin](./bin/) - scripts meant to be run as executable. i.e `nu script.nu`
+- [cool-oneliners](./cool-oneliners/)
+- [custom-completions](./custom-completions/) - collection of custom completions for external commands.
+- [custom-menus](./custom-menus/) - collection of custom nushell menus
+- [example-config](./example-config/)
+- [hooks](./hooks/)
+- [modules](./modules/) - This has it's dedicated [readme](./modules/)
+- [nu_101](./nu_101/) - Begginer introduction to nushell concepts.
+- [prompt](./prompt/)
+- [themes](./themes/)
 
 ## Running Scripts
 

modules/README.md

@@ -0,0 +1,156 @@
+# Modules
+
+- [Modules](#modules)
+ - [after](#after)
+ - [api\_wrappers](#api_wrappers)
+ - [background\_task](#background_task)
+ - [base16](#base16)
+ - [coloring](#coloring)
+ - [data\_extraction](#data_extraction)
+ - [docker](#docker)
+ - [filesystem](#filesystem)
+ - [formats](#formats)
+ - [fun](#fun)
+ - [github](#github)
+ - [gitlab](#gitlab)
+ - [kubernetes](#kubernetes)
+ - [make\_release](#make_release)
+ - [maths](#maths)
+ - [network](#network)
+ - [nvim](#nvim)
+ - [progress\_bar](#progress_bar)
+ - [rbenv](#rbenv)
+ - [virtual\_environments](#virtual_environments)
+ - [weather](#weather)
+ - [webscraping](#webscraping)
+
+
+## [after](./after)
+
+Run a function after the given program (by PID)
+
+## api_wrappers
+
+Demo of various API wrappers:
+- [Wolfram Alpha](./api_wrappers/wolframalpha.nu)
+- [AWS]()
+
+## background_task
+
+make nushell "support" background task feature.
+see [README](./background_task/)
+
+
+## base16
+
+Base16 theme generator (for Linux, might work for other OS)
+see [README](./base16/)
+
+## coloring
+
+These scripts are used to demonstrate the `ansi` command using `ansi` coloring. This is mainly a demo area where we have taken typical `bash` scripts and ported them to nushell scripts. It would be nice if all scripts here showed the "other" version of script and the ported nushell version. We can show "other" flavors of scripts by including them as comments in the nushell scripts or by naming the nushell script and the other script the same basename.
+
+
+## data_extraction
+
+- [Ultimate Extractor](./data_extraction/ultimate_extractor.nu) - Extract any compressed archive, UE will call the proper program under the hood 😎
+
+## [docker](./docker/)
+
+An extensive example of a wrapper for docker operations, with nushell completions.
+
+## filesystem
+
+- [cdpath](./filesystem/cdpath.nu) - ???
+- [up](./filesystem/up.nu) - Cd up `X` times
+
+## formats
+Examples of input/output formatters:
+- [from-cpuinfo](./formats/from-cpuinfo.nu)
+- [from-dmidecode](./formats/from-dmidecode.nu)
+- [to-ini](./formats/to-ini.nu)
+- [remove-diacritics](./strings/remove-diacritics.nu) - Turns `Zażółć gęślą jaźń` into `Zazolc gesla jazn`
+
+
+## fun
+
+- [spark](./fun/spark.nu) - send an array into spark and get a sparkline out:
+ ```console
+ > let v = [2, 250, 670, 890, 2, 430, 11, 908, 123, 57]
+ > spark $v
+ ▁▂▆▇▁▄▁█▁▁
+ ```
+- [website-builder](./fun/website_builder.nu) - converts markdown into their equivalent html pages
+- [wordle](./fun/wordle.nu) - A Terminal Wordle game. The code is based on this [gist](https://gist.github.com/huytd/6a1a6a7b34a0d0abcac00b47e3d01513), but slightly personalized.
+
+
+## github
+
+- [branch-protections](./github/branch-protections/) - Do you have hundreds or thousands of GitHub repositories in your organization? Are you tired of manually managing their branch protection rules? Don't! Let nushell do it for you! see [README](./github/branch-protections/)
+- [merged-branches](./github/merged-branches/) - Do your developers often forget to delete their branches after merging PRs? Are you tired of manually going into every repository and deleting them? Don't! Let nushell do it for you! see [README](./github/merged-branches/)
+
+## [gitlab](./gitlab/)
+Search files on your GitLab server
+
+## [kubernetes](./kubernetes/)
+???
+ 
+## [make_release](./make_release/)
+???
+
+## [maths](./maths/)
+
+- [math_functions] - module with the following commands:
+ - `root` - root with a custom denominator
+ - `croot` - cube root
+ - `aroot` - root with a custom scaler and denominator
+ - `delta` - calculate the delta of the quadratic function
+ - `fact` - factorial of the given number
+ - `q_roots` - calculare roots of the quadratic function: ax^2+bx+x
+ - `isprime` - check if integer is prime
+ - `primelist` - list primes until given number
+ - `mtable` - multiplication table of n till max
+ - `isleap` - check if year is leap
+ - `gcd` - greatest common divisor between 2 integers
+ - `lcm` - least commoin multiple between 2 integers
+ - `dec2base` - decimal number to custom base representation
+ - `scale-minmax` - scale list to `[a,b]` interval
+ - `scale-minmax-table` - Scale every column of a table (separately) to `[a,b]` interval
+ - `math exp` - exp function
+
+## network
+- [remoting](./network/remoting/) - This module provide convenient way to manage multiple remote clients. see [README](./network/remoting)
+
+- [sockets](./network/sockets/) - The `sockets` command returns a table containing information on network sockets and the processes they belong to.
+It is basically a join of the tables produced by the `lsof` command, and the nushell `ps` command.
+ 
+ <img width="1486" alt="image" src="https://user-images.githubusercontent.com/52205/196287615-00e46f8e-06ed-45ce-8fe7-a5c5f38afaaa.png">
+
+
+- [ssh](./network/ssh.nu) wrapper that provides the following commands:
+ - `ssh`
+ - `scp`
+ - `ssh-list`
+ - `parse-ssh-file`
+ - `str max-length`
+ - `ensure-index`
+
+
+## [nvim](./nvim/)
+??? (not sure how universal this is) Mix of hooks, defs and alias wrapper around neovim.
+
+## [progress_bar](./progress_bar/)
+??? (make a module out of these scripts?) - Collection of progress bars
+ 
+## [rbenv](./rbenv/)
+??? (not sure how universal this is) This script provides minimal working rbenv setup.
+
+## [virtual_environments](./virtual_environments/)
+The scripts in this directory activate virtual environments for Conda environments.
+
+## [weather](./weather/)
+These scripts should be used to demonstrate how get your local weather and/or weather forecasts.
+
+
+## [webscraping](./webscraping/)
+Simple scripts to demonstrate how to scrape websites in nushell. Requires `query web` plugin

after/after.nu → modules/after/after.nu

@@ -3,7 +3,7 @@ def "nu-complete ps" [] {
 }
 
 # after <pid> { do something ... }
-export def after [pid: string@"nu-complete ps" action ] {
+export def main [pid: string@"nu-complete ps" action ] {
  do -i { tail --pid $pid -f /dev/null }
  do $action
 }

modules/formats/README.md

@@ -0,0 +1,5 @@
+# Formatting scripts
+
+### Definition
+
+The scripts in this folder are used to help formatting nicely inputs/outputs of nushell. 

strings/remove-diacritics.nu → modules/formats/remove-diacritics.nu

@@ -2,7 +2,7 @@
 
 # Usage: (remove-diacritics 'Zażółć gęślą jaźń') == Zazolc gesla jazn
 
-def remove-diacritics [
+export def main [
  arg: string
 ] {
  let diacritics_map = {

formatting/number-format.nu → modules/formats/to-number-format.nu

@@ -1,4 +1,4 @@
-def number-format [
+export def number-format [
  num # Number to format
  --thousands_delim (-t) = ' ' # Thousands delimiter: number-format 1000 -t ': 1'000
  --whole_part_length (-w) = 0 # Length of padding whole-part digits: number-format 123 -w 6: 123

progress_bar/percent_meter.nu → sourced/progress_bar/percent_meter.nu

@@ -16,6 +16,8 @@ def hide_cursor [] {
  print $"(ansi -e '?25l')"
 }
 
-hide_cursor
-loading
-show_cursor
+def demo_percent_meter [] {
+ hide_cursor
+ loading
+ show_cursor
+}