Skip to content

Commit 286627d

Browse files
committed
Add initial setup for @graphprotocol/guides package with README, TypeScript configuration, and example code
1 parent 82b8130 commit 286627d

File tree

4 files changed

+51
-0
lines changed

4 files changed

+51
-0
lines changed

packages/guides/README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# @graphprotocol/guides
2+
3+
A collection of guides and utilities for The Graph documentation site.
4+
5+
## Development
6+
7+
```
8+
# Install dependencies (from project root)
9+
pnpm install
10+
11+
# In watch mode (inside this package)
12+
pnpm --filter @graphprotocol/guides dev
13+
```
14+
15+
## Build
16+
17+
```
18+
# Build the TypeScript sources
19+
pnpm --filter @graphprotocol/guides build
20+
```
21+
22+
The compiled JavaScript files and type declarations will be output to `dist/`.

packages/guides/package.json

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"name": "@graphprotocol/guides",
3+
"version": "0.1.0",
4+
"private": true,
5+
"main": "dist/index.js",
6+
"types": "dist/index.d.ts",
7+
"files": ["dist"],
8+
"scripts": {
9+
"build": "tsc -p tsconfig.json",
10+
"dev": "tsc -w -p tsconfig.json",
11+
"typecheck": "tsc --noEmit -p tsconfig.json"
12+
},
13+
"dependencies": {},
14+
"devDependencies": {
15+
"typescript": "^5.8.3"
16+
}
17+
}

packages/guides/src/index.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
export const hello = (): string => 'Hello from @graphprotocol/guides';

packages/guides/tsconfig.json

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"extends": "../../tsconfig.json",
3+
"compilerOptions": {
4+
"rootDir": "src",
5+
"outDir": "dist",
6+
"declaration": true,
7+
"declarationMap": true,
8+
"sourceMap": true
9+
},
10+
"include": ["src"]
11+
}

0 commit comments

Comments
 (0)