Script.js: Simplifying Shell Scripting with JavaScript

Script.js enables developers to write shell scripts using JavaScript, harnessing the simplicity and flexibility of the language to streamline the scripting process. This shift from traditional shell scripting platforms like Bash to a more universally understood language can significantly reduce errors and boost productivity by using familiar syntax.

Key Features

• Rapid Development: Quickly create scripts without troublesome import statements. Script.js offers a streamlined scripting experience with global commands to enhance writing speed.
• Enhanced Usability: Leverage built-in autocompletion support that makes script running more intuitive and satisfying.
• JavaScript Ecosystem: Utilize the power of the extensive JavaScript ecosystem to write complex scripts.
• Familiar Syntax: Maintain the simplicity of Bash-like syntax, supporting redirection, pipes, and environment variables.
• Organized Subcommands: Simplify the creation and management of subcommands within scripts.
• Auto-generated Documentation: Offer users auto-generated help documentation for easier understanding and use.
• Optimized Execution: Experience fast script execution, enhancing efficiency and performance.

Usage Example

Create a JavaScript script for listing files and counting them:

#!/usr/bin/env gutenye-script.js

app
  .name('hello.js')
  .enableCompletion()

app.command('greetings [files...]')
  .completion({
    positionalany: ['$files'],
  })
  .action((files, options) => {
    $`
      ls -l ${files}
      echo ${files} | wc -l
    `
  })

Supporting Tools & Libraries

• Bun: An efficient JavaScript runtime and package manager.
• Carapace: Enables multi-shell completion functionality.
• Zurk & Zx: Useful tools for improved script writing and process spawning.
• Commander.js: Facilitates building command-line interfaces in node.js.

Contributing and Recognition

Script.js thrives on community contributions. Contributions through code improvements, bug fixes, or documentation enhancements are welcomed. To contribute:

1. Fork the repository.
2. Submit a pull request on GitHub.

Explore the world of shell scripting through JavaScript with Script.js, and transform how scripts are created and executed.