https://github.com/darekkay/darekkay-scripts

My shared project scripts
https://github.com/darekkay/darekkay-scripts

Last synced: 17 days ago
JSON representation

My shared project scripts

• Host: GitHub
• URL: https://github.com/darekkay/darekkay-scripts
• Owner: darekkay
• License: mit
• Created: 2021-04-30T14:22:55.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-02-03T20:21:03.000Z (9 months ago)
• Last Synced: 2024-10-11T04:46:26.814Z (about 1 month ago)
• Language: JavaScript
• Size: 601 KB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# @darekkay/scripts

[![npm (scoped)](https://img.shields.io/npm/v/@darekkay/scripts?style=flat-square)](https://www.npmjs.com/package/@darekkay/scripts)

[![Build](https://img.shields.io/github/actions/workflow/status/darekkay/darekkay-scripts/ci.yml?branch=master&style=flat-square)](https://github.com/darekkay/darekkay-scripts/actions/workflows/ci.yml)

[![license](https://img.shields.io/badge/license-MIT-green?style=flat-square)](https://github.com/darekkay/darekkay-scripts/blob/master/LICENSE)

A CLI that abstracts away all configurations for my projects (linting, testing, building, ...). Inspired by [react-scripts](https://www.npmjs.com/package/react-scripts) and [kcd-scripts](https://www.npmjs.com/package/kcd-scripts).

## Usage

```shell

dks [node arguments] [script] [script arguments]

```

To output debug information, set `DEBUG` env variable:

```shell

cross-env DEBUG=true dks [script]

```

## Available scripts

- `dks ci`: Run `lint`, `test` and `typecheck`.

- `dks format`: Run Prettier.

- `dks lint`: Run ESlint with `--fix` and `--cache`.

- `dks test`: Run Jest.

- `dks typecheck`: Run TypeScript compiler with `--noEmit`.

## Additional commands

Some additional utilities are included:

- [cross-env](https://www.npmjs.com/package/cross-env)

- [npm-run-all](https://www.npmjs.com/package/npm-run-all)

## License

This project and its contents are open source under the [MIT license](LICENSE).