Skip to content

Commit 4e0b726

Browse files
committed
minor cosmetic changes in linting
1 parent f10591d commit 4e0b726

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

DEVELOPMENT.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,17 @@ Module GCS Publisher.
88
- Node.js (version specified in `.node-version`)
99
- npm
1010

11+
## Tool Installation
12+
13+
### Required System Tools
14+
15+
1. Install yamllint:
16+
17+
```bash
18+
# macOS
19+
brew install yamllint
20+
```
21+
1122
## Setup Development Environment
1223

1324
1. Clone the repository:
@@ -22,6 +33,15 @@ Module GCS Publisher.
2233
```bash
2334
# If you use nodenv, nvm, asdf, volta, etc:
2435
# They will automatically read the version from .node-version
36+
37+
# Using nvm
38+
nvm use
39+
40+
# Using nodenv
41+
nodenv local
42+
43+
# Using homebrew on macOS
44+
brew install nodejs
2545
```
2646

2747
1. Install dependencies:
@@ -36,6 +56,18 @@ Module GCS Publisher.
3656
npm run prepare
3757
```
3858

59+
### Node.js Tools
60+
61+
The following tools are automatically installed as part of the `npm ci` command:
62+
63+
- **TypeScript** - Strongly typed JavaScript
64+
- **ESLint** - TypeScript/JavaScript linting
65+
- **Prettier** - Code formatting
66+
- **markdownlint-cli** - Markdown linting
67+
- **Jest** - Testing framework
68+
- **Husky** - Git hooks
69+
- **@vercel/ncc** - Compiler for Node.js
70+
3971
## Development Workflow
4072

4173
- `npm run verify` - Run all linting and formatting checks

0 commit comments

Comments
 (0)