Skip to content
janitor-sh logo janitor-sh logo janitor-sh Docs

TypeScript Example

Repository: janitor-sh/typescript-example

Run locally

Section titled “Run locally”
Terminal window
npm install
npm run dev

Build locally

Section titled “Build locally”
Terminal window
npm run build

Validate janitor locally

Section titled “Validate janitor locally”
Terminal window
janitor --no-commit

CI behavior

Section titled “CI behavior”

The example workflow runs on pushes and pull requests to main and executes janitor using Biome:

- name: Install biome
  run: npm install -g @biomejs/biome


- uses: janitor-sh/action@v1
  with:
    github_token: ${{ secrets.GITHUB_TOKEN }}
    tool: "biome"


- name: Push Janitor commit
  run: git push