Merge pull request #59 from yassinebenaid/dev

Ad support for "$#" and "$$" special vars

Author: yassinebenaid

README.md

@@ -25,8 +25,8 @@ Technically speaking, **Bunster** in fact is a `shell-to-Go` [Transplier](https:
 
 In addition to the shell features, We aim to add several custom features to make shell scripts feel like any modern programming language. These features are either supported or are planned to be implemented in future. (_consider contributing to help us speed up the develpment cycle_)
 
-- **Different Shells support**: Bunster currently aims to be compatible `Bash` as a starting move. then additional shells in future.
-- **Modules**: something shell scripts lack is a module system, we aim to introduces a module system that allow you to publish and consume scripts as libraries.
+- **Different Shells support**: Bunster currently aims to be compatible with `bash` as a starting move. Then additional shells in future.
+- **Modules**: Something shell scripts lack is a module system, we aim to introduce a module system that allow you to publish and consume scripts as libraries.
 - **Static Asset Embedding**: This feature allows you to embed a file's content to a variable at build time. ([Go has one already](https://pkg.go.dev/embed))
 - **Password and Expiration Lock**: Surprisingly, some people have asked for this feature. Basically, It allows you to choose an expirity date at build time. the generated program will not work after that date. Also you can choose to lock the script using a password. whenever you try to run it, it prompts for the password.
 

docs/index.md

@@ -19,9 +19,9 @@ hero:
 features:
   - title: Native Program Generation
     details: |
-      Scripts compiled with Bunster are not just wrappers around your script, nor do they rely on any external shell on your system.
-  - title: Wite Once, Run Everywhere
+      Scripts compiled with Bunster are not just wrappers around your script, nor do they rely on any external shells on your system.
+  - title: Write Once, Run Everywhere
     details: Bunster offers static linking. Your scripts are compiled to a statically linked binary that runs on every machine.
   - title: Module System
-    details: Bunsters's module system makes it easy to shares your scripts as a versioned modules to be used by others.
+    details: Bunsters's module system makes it easy to shares and consume your scripts as libraries.
 ---

docs/maintainers.md

@@ -20,9 +20,9 @@ const members = [
 </script>
 
 # Maintainers
-**Bunster** is an open source project maintained and driven by the community, But we have a dedicated team
-that takes the final decision on contributions and feature requests. And keeps contact with the rest of the community to ensure a healthy and friendly
-environment for everyone.
+**Bunster** is an open source project driven by the public community, But we have a dedicated team
+that oversees the final decisions to ensure the project's direction aligns with its vision. The team also maintains open communication with the community
+to sustain a welcoming and collaborative environment for everyone.
 
 Say hello to our awesome team.
 

docs/supported-features.md

@@ -3,44 +3,8 @@ This page lists the features and syntax supported by **Bunster**. you must consi
 as work-in-progress and as not-yet-supported.
 
 
-## Simple commands
-```shell
-command argument 'argument' "argument" $VARIABLE
-```
-
-## Redirections
-### Output redirection
-```shell
-command >file.txt >|file.txt >>file.txt &>file.txt &>>file.txt
-```
-### Input redirection
-```shell
-command <file.txt <<<"foo bar"
-```
-### File descriptor duplication and closing
-```shell
-command 2>&3 3>&4- 3>&- 2>&-
-```
-### Opening files for reading and writing
-```shell
-command <>file.txt 3<>file.txt
-```
-
-::: tip
-Unlick bash, you are not limited to only use file descriptors between 0 to 9. Feel free to use any valid 64-bit integer number. (learn why TODO: add this link here)
-:::
-
-## Passing shell parameters as environment to commands
-```shell
-key=value key2="value" command
-```
-
-## Pipelines
-```shell
-command | command2 | command3
-```
-
-## Conditional Execution
-```shell
-command || command2 && command3
-```
+- Simple commands
+- Redirections
+- Passing shell parameters as environment to commands
+- Pipelines
+- Conditional Execution (`command || command2 && command3`)

generator/tests/0-simple-commands.test

@@ -265,7 +265,7 @@ func Main(shell *runtime.Shell) {
 
 #(TEST: special variables)
 
-echo $1 $?
+echo $1 $? $$ $#
 
 #(RESULT)
 
@@ -279,6 +279,8 @@ func Main(shell *runtime.Shell) {
   		var arguments []string
   		arguments = append(arguments, shell.ReadSpecialVar("1"))
   		arguments = append(arguments, shell.ReadSpecialVar("?"))
+  		arguments = append(arguments, shell.ReadSpecialVar("$"))
+  		arguments = append(arguments, shell.ReadSpecialVar("#"))
   		var command = shell.Command(commandName, arguments...)
   		commandFDT, err := shell.CloneFDT()
   		if err != nil {

runtime/shell.go

@@ -10,16 +10,18 @@ import (
 )
 
 type Shell struct {
+	PID int
+
 	Stdin  Stream
 	Stdout Stream
 	Stderr Stream
 
 	Args []string
 
-	ExitCode int
-
 	FDT FileDescriptorTable
 
+	ExitCode int
+
 	Main func(*Shell)
 }
 
@@ -40,6 +42,10 @@ func (shell *Shell) ReadVar(name string) string {
 
 func (shell *Shell) ReadSpecialVar(name string) string {
 	switch name {
+	case "$":
+		return strconv.FormatInt(int64(shell.PID), 10)
+	case "#":
+		return strconv.FormatInt(int64(len(shell.Args))-1, 10) // -1 to substract the argument index 0, which is the program name.
 	case "?":
 		return strconv.FormatInt(int64(shell.ExitCode), 10)
 	default:

stubs/main.go.stub

@@ -8,6 +8,8 @@ import (
 func main() {
 
 	shell := runtime.Shell{
+        PID: os.Getpid(),
+
 		Stdin:  os.Stdin,
 		Stdout: os.Stdout,
 		Stderr: os.Stderr,