https://github.com/marcisbee/utils

This repo contains various tiny sh utilities.
https://github.com/marcisbee/utils

Last synced: about 1 year ago
JSON representation

This repo contains various tiny sh utilities.

Host: GitHub
URL: https://github.com/marcisbee/utils
Owner: Marcisbee
License: mit
Created: 2025-01-17T13:03:28.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2025-04-19T18:48:33.000Z (about 1 year ago)
Last Synced: 2025-06-24T07:21:35.965Z (about 1 year ago)
Language: Shell
Homepage:
Size: 33.2 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Various utilities

This repository contains several shell utility scripts designed to facilitate various tasks in your development workflow.

## dotenv.sh

The `dotenv.sh` script loads environment variables from a `.env` file. This can be particularly useful for setting up your application's configuration in different environments without hardcoding sensitive information into your source code.

### Default Usage:

```sh
# .env:
# PORT=4000

# test.js:
# console.log(process.env.PORT);

./dotenv.sh -- node ./test.js
```

```sh
curl -SsfL https://marcisbee.github.io/utils/dotenv.sh | bash -s -- -- node ./test.js
```

The script loads the environment variables from `.env` by default and runs the specified command, in this case, `node ./test.js`.

### Using a Custom Environment File:

If you need to load environment variables from a different file (e.g., for development or testing environments), specify it as follows:

```sh
./dotenv.sh .env.development -- node ./test.js
```

```sh
curl -SsfL https://marcisbee.github.io/utils/dotenv.sh | bash -s -- .env.development -- node ./test.js
```

## lslint.sh

The `lslint.sh` script assists in linting the file paths within your project according to rules specified in a `.lslint` configuration file. This is helpful for maintaining consistency and ensuring that all necessary files adhere to the specified patterns.

### Usage:

Create a `.lslint` configuration file in your project's root directory with the desired file patterns. Here’s an example of how to set it up:

```sh
# .lslint
# /package.json
# /node_modules/**/*
# /src/**/.<:tsx|ts>
# /src/**/.module.css
# /test/**/.test.ts

./lslint.sh
```

Before running the script, ensure that the `.lslint` configuration file exists in your project root directory. Here are some example syntax matches for typical linting patterns:

| Pattern | Matched File Paths |
|---------------------------------|---------------------------------------------------------------|
| `/file.ts` | `/file.ts` |
| `/test/*` | `/test/file.ts`, `/test/any.css` |
| `/test/**/*` | `/test/file.ts`, `/test/a/b/c/any.css` |
| `/test/**/file.ts` | `/test/file.ts`, `/test/a/file.ts`, `/test/a/b/c/file.ts` |
| `/test/**/*.ts` | `/test/file.ts`, `/test/a/any.ts`, `/test/a/b/c/any.ts` |
| `/test/start/**/end/*.ts` | `/test/start/end/file.ts`, `/test/start/a/end/any.ts`, ... |
| `/test/**/.ts` | `/test/paper-bag.ts`, `/test/a/paper-bag.ts`, ... |
| `/test/**/.ts` | `/test/paper-bag.ts`, ... |
| `/test/<:[A-Z]+>**/mod.<:ts\|tsx\|css>` | `/test/any.ts`, ... |

## tasks.sh

The `tasks.sh` script allows you to define and execute shell functions as tasks. These tasks are defined in a separate `task.sh` file within your project's root directory.

### Usage:

```sh
./tasks.sh
```

```sh
curl -SsfL https://marcisbee.github.io/utils/tasks.sh | bash -s --
```

- **Single Task**: Execute the function by specifying its name, e.g., `./tasks.sh build`.

- **Task Group**: Run multiple tasks concurrently by combining their names with a `+`, e.g., `./tasks.sh build+lint`.

### Instructions:

1. Ensure a `task.sh` file exists in your project's root directory.

2. Define bash functions prefixed with `task_`. For example:

```sh
#!/usr/bin/env bash

task_dev() {
start_task build
start_task db+server
}

task_server() {
echo "Start server process"
}

task_db() {
echo "Start db process"
}

task_build() {
echo "This is build"
}
```

3. Run the `tasks.sh` script with the desired task name or group of tasks.

The script includes error handling and cleanup procedures to manage running processes effectively. When combined task names (e.g., `build+lint`) are provided, each specified task runs concurrently; otherwise, they run sequentially.

## Development

For linting shell scripts, use the following command:

```sh
curl -SsfL https://marcisbee.github.io/gh/dl.sh | bash -s -- --repo koalaman/shellcheck
./shellcheck lslint.sh
```

## License

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/marcisbee/utils

Awesome Lists containing this project

README