Skip to content

Commit

Permalink
chore(ci): add script to install dev tools on macos (#5059)
Browse files Browse the repository at this point in the history
* chore: add a simple script to install dev tools

* chore: use Brewfile
  • Loading branch information
PeterSchafer authored Mar 18, 2024
1 parent 2b37539 commit c903102
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 11 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,5 @@ tap-output
# Jest
coverage
test/fixtures/basic-swift/.build
test/fixtures/basic-swift/Package.resolved
test/fixtures/basic-swift/Package.resolved
scripts/Brewfile.lock.json
13 changes: 3 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,11 @@
## Prerequisites

You will need the following software installed:

- Git
- Node.js (and bundled npm)
- Use whichever version is in [`.nvmrc`](./.nvmrc).

Open a terminal and make sure they are available.
To install the required development dependencies in homebrew based environments, execute the following script from the root directory.
The only additional prerequisite is having [homebrew](https://brew.sh/) installed.

```sh
git --version
node --version
npm --version
./scripts/install-dev-dependencies.sh
```

## Setting up
Expand Down
10 changes: 10 additions & 0 deletions scripts/Brewfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
brew 'fnm'
brew 'git'
brew 'go'
brew 'gitleaks'
brew 'pre-commit'
brew 'convco'
brew 'python'
brew 'gnupg'

cask 'github'
5 changes: 5 additions & 0 deletions scripts/install-dev-dependencies.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
#!/usr/bin/env bash
set -exuo pipefail

# requires https://brew.sh/
brew bundle --file=$(dirname "$0")/Brewfile

0 comments on commit c903102

Please sign in to comment.