https://github.com/danger/danger-ts

An npx-able mix of Danger and TypeScript
https://github.com/danger/danger-ts

Last synced: about 1 year ago
JSON representation

An npx-able mix of Danger and TypeScript

• Host: GitHub
• URL: https://github.com/danger/danger-ts
• Owner: danger
• License: mit
• Created: 2020-08-19T09:51:59.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2020-08-19T11:21:33.000Z (almost 6 years ago)
• Last Synced: 2025-04-25T06:39:15.755Z (about 1 year ago)
• Language: JavaScript
• Size: 30.3 KB
• Stars: 6
• Watchers: 5
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# danger-ts

An npx-able mix of Danger and TypeScript, so you can trivially use Danger JS with a TS Dangerfile without having Danger in your dependency tree.  

```sh

echo 'import {markdown} from "danger"; markdown("Hi!");"' > dangerfile.ts

npx danger-ts

```

### Why Use This?

Most of the time, you don't need to. You could be using Danger in a TS project, at that point though you'll want to include the Danger dep for the Types. 

Cases where you might not though:

- You're running CI on webhooks which aren't worth doing a full `yarn install` on. 

- You add the `dangerfile.ts` to your `exclude` in the project's `tsconfig.json`.

In those cases you can use `npx danger-ts` which acts as a proxy for `yarn danger ci`.

e.g.

```yml

name: CI

on: pull_request

jobs:

  test:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v1

      - uses: actions/setup-node@v1

      - name: "Use npx to run the dangerfile"

        run: "npx danger-ts"

        env:

          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

```