Skip to content

Commit 5bd8f12

Browse files
committed
badges
1 parent ed7be16 commit 5bd8f12

File tree

2 files changed

+46
-2
lines changed

2 files changed

+46
-2
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,29 @@
11
# sqlc-typescript
22

3+
<!-- NPM Badges -->
4+
5+
[![npm version](https://img.shields.io/npm/v/sqlc-typescript.svg)](https://www.npmjs.com/package/sqlc-typescript)
6+
[![npm downloads](https://img.shields.io/npm/dm/sqlc-typescript.svg)](https://www.npmjs.com/package/sqlc-typescript)
7+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
8+
[![npm types](https://img.shields.io/npm/types/sqlc-typescript.svg)](https://www.npmjs.com/package/sqlc-typescript)
9+
[![Dependencies](https://img.shields.io/librariesio/release/npm/sqlc-typescript)](https://libraries.io/npm/sqlc-typescript)
10+
11+
<!-- GitHub Badges -->
12+
13+
[![GitHub stars](https://img.shields.io/github/stars/seralexeev/sqlc-typescript.svg)](https://github.com/seralexeev/sqlc-typescript)
14+
[![GitHub issues](https://img.shields.io/github/issues/seralexeev/sqlc-typescript.svg)](https://github.com/seralexeev/sqlc-typescript/issues)
15+
[![GitHub last commit](https://img.shields.io/github/last-commit/seralexeev/sqlc-typescript.svg)](https://github.com/seralexeev/sqlc-typescript/commits)
16+
[![Contributors](https://img.shields.io/github/contributors/seralexeev/sqlc-typescript)](https://github.com/seralexeev/sqlc-typescript/graphs/contributors)
17+
18+
<!-- Package Info -->
19+
20+
[![Bundle Size](https://img.shields.io/bundlephobia/min/sqlc-typescript)](https://bundlephobia.com/package/sqlc-typescript)
21+
[![Bundle Size (gzip)](https://img.shields.io/bundlephobia/minzip/sqlc-typescript)](https://bundlephobia.com/package/sqlc-typescript)
22+
23+
<!-- CI/CD Badges -->
24+
25+
[![CI](https://github.com/seralexeev/sqlc-typescript/actions/workflows/manual-release.yml/badge.svg)](https://github.com/seralexeev/sqlc-typescript/actions/workflows/manual-release.yml)
26+
327
A super lightweight TypeScript types generator that respects your laziness and love for raw SQL.
428

529
Zero runtime dependencies, just types. This is just a super thin wrapper around [sqlc](https://sqlc.dev/) and a file generator - all the real magic is in sqlc. It just makes it more convenient to use in TypeScript projects.

package.json

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
{
22
"name": "sqlc-typescript",
3+
"description": "A super lightweight TypeScript types generator that respects your laziness and love for raw SQL",
34
"version": "0.0.15",
45
"type": "module",
56
"main": "dist/cli.js",
@@ -9,10 +10,23 @@
910
"bin"
1011
],
1112
"scripts": {
13+
"build": "tsc",
1214
"start": "node --no-warnings src/cli.ts",
13-
"example": "node --no-warnings src/cli.ts generate -c tests/sqlc.json",
14-
"build": "tsc"
15+
"test": "node --no-warnings src/cli.ts generate -c tests/sqlc.json"
1516
},
17+
"repository": {
18+
"type": "git",
19+
"url": "git+https://github.com/seralexeev/sqlc-typescript"
20+
},
21+
"bugs": {
22+
"url": "https://github.com/seralexeev/sqlc-typescript/issues"
23+
},
24+
"keywords": [
25+
"postgres",
26+
"typescript",
27+
"sql",
28+
"sqlc"
29+
],
1630
"packageManager": "yarn@4.6.0",
1731
"dependencies": {
1832
"chokidar": "^4.0.3",
@@ -22,5 +36,11 @@
2236
"devDependencies": {
2337
"@types/node": "^22.13.1",
2438
"typescript": "^5.7.3"
39+
},
40+
"peerDependencies": {
41+
"node": ">=23.7.0"
42+
},
43+
"engines": {
44+
"node": ">=23.7.0"
2545
}
2646
}

0 commit comments

Comments
 (0)