How do I set up git hooks with Velociraptor?

You can configure scripts to run on git events by defining them in the Velociraptor configuration file, such as for pre-commit or pre-push hooks. The tool handles the integration automatically, as detailed in the official documentation on its website.

Velociraptor vs npm scripts: which is better for Deno?

Velociraptor is specifically built for Deno with native support for its features like permissions and TypeScript, while npm scripts are tied to Node.js. For Deno projects, Velociraptor offers better integration and declarative options, but npm scripts remain standard for Node.js environments.

Can Velociraptor run scripts concurrently?

Yes, concurrent script execution is a core feature, allowing you to define multiple scripts to run in parallel. This can speed up tasks like building and testing, as mentioned in the README's key features section.

How to manage environment variables in Velociraptor?

Velociraptor provides built-in support for environment variables within its script configurations, letting you set and use them directly without external tools. This simplifies managing different environments for development, testing, and production.

Is Velociraptor compatible with TypeScript in Deno?

Absolutely, since it's designed for Deno, it supports TypeScript out of the box. You can specify TypeScript configurations and import maps in the script options, leveraging Deno's native TypeScript capabilities.

How to migrate from npm scripts to Velociraptor?

Start by creating a Velociraptor configuration file and copy your npm scripts into it, then adjust for Deno-specific options like permissions. The familiar npm-style format makes migration straightforward, but you'll need to adapt to Deno's CLI flags and ecosystem.

Open-Awesome

velociraptor

MITTypeScript1.5.0

A script runner for Deno that provides npm-style scripts with declarative Deno CLI options, environment variables, and concurrency.

Visit Website GitHub

668 stars21 forks0 contributors

What is velociraptor?

Velociraptor is a script runner for Deno that allows developers to define and run scripts in a way similar to npm's package.json scripts. It solves the problem of managing complex Deno command-line options and environment variables by providing a declarative configuration format, making it easier to automate development tasks.

Target Audience

Deno developers who want a streamlined way to manage scripts, automate workflows, and integrate git hooks without relying on external task runners.

Value Proposition

Developers choose Velociraptor because it offers native Deno support with declarative configurations, concurrent script execution, and git hooks integration, providing a more integrated and efficient alternative to manual script management or generic task runners.

Overview

The npm-style script runner for Deno

Use Cases

Best For

Automating Deno project tasks like building, testing, and linting
Managing complex Deno CLI flags and permissions in scripts
Running multiple scripts concurrently to speed up workflows
Integrating git hooks for pre-commit checks or automated deployments
Simplifying environment variable management within Deno scripts
Migrating from npm scripts to Deno without losing functionality

Not Ideal For

Projects not using Deno, as it's specifically designed for the Deno runtime and cannot execute Node.js or other language scripts.
Teams that prefer language-agnostic task runners like GNU Make or Just, which offer broader cross-platform and toolchain compatibility.
Simple Deno workflows where managing scripts directly via Deno CLI suffices, avoiding extra configuration overhead.

Pros & Cons

Pros

Declarative Deno Options

Allows defining Deno CLI flags like permissions and import maps directly in script configurations, simplifying complex command setups as highlighted in the README.

Concurrent Script Execution

Supports running multiple scripts in parallel to optimize build and development processes, a key feature emphasized in the documentation.

Git Hooks Integration

Automates script execution on git events such as pre-commit, enhancing workflow automation without relying on external tools.

Familiar npm-Style Interface

Uses a configuration format similar to npm's package.json scripts, easing migration for developers coming from Node.js projects.

Cons

Deno-Only Lock-in

Limited to Deno ecosystems, making it unsuitable for mixed or Node.js environments and reducing flexibility for broader project needs.

Configuration Overhead

Adds an extra layer of tooling that may be unnecessary for simple scripts, as Deno's native CLI can handle basic tasks without it.

Less Mature Ecosystem

Compared to established task runners like npm scripts or Gulp, it has a smaller community and fewer third-party integrations, which could limit support.

Frequently Asked Questions

Related Projects

vscode-deno

Visual Studio Code plugin for Deno

Stars1,548

Forks169

Last commit2 months ago

dnt

Deno to npm package build tool.

Stars1,334

Forks49

Last commit1 month ago

denon

👀 Monitor any changes in your Deno application and automatically restart.

Stars1,107

Forks43

Last commit2 years ago

deno_docker

Latest dockerfiles and images for Deno - alpine, centos, debian, ubuntu

Stars1,018

Forks114

Last commit11 days ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub