Skip to content

Commit ef96e03

Browse files
🔧 Rename project from id-ts to typed-id and update related documentation
1 parent e341171 commit ef96e03

File tree

5 files changed

+29
-29
lines changed

5 files changed

+29
-29
lines changed

.github/workflows/release.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ jobs:
9797
fi
9898
9999
echo "" >> CHANGELOG.md
100-
echo "**Full Changelog**: https://github.com/max-programming/id-ts/compare/${LAST_TAG:-$(git rev-list --max-parents=0 HEAD)}...${{ steps.get_version.outputs.tag }}" >> CHANGELOG.md
100+
echo "**Full Changelog**: https://github.com/max-programming/typed-id/compare/${LAST_TAG:-$(git rev-list --max-parents=0 HEAD)}...${{ steps.get_version.outputs.tag }}" >> CHANGELOG.md
101101
102102
# Set changelog content for release
103103
{
@@ -137,6 +137,6 @@ jobs:
137137
138138
- name: Notify
139139
run: |
140-
echo "🎉 Successfully released id-ts v${{ steps.get_version.outputs.version }} with Bun!"
141-
echo "📦 Published to npm: https://www.npmjs.com/package/id-ts"
142-
echo "🏷️ GitHub Release: https://github.com/max-programming/id-ts/releases/tag/v${{ steps.get_version.outputs.version }}"
140+
echo "🎉 Successfully released typed-id v${{ steps.get_version.outputs.version }} with Bun!"
141+
echo "📦 Published to npm: https://www.npmjs.com/package/typed-id"
142+
echo "🏷️ GitHub Release: https://github.com/max-programming/typed-id/releases/tag/v${{ steps.get_version.outputs.version }}"

CONTRIBUTING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Contributing to id-ts
1+
# Contributing to typed-id
22

3-
Thank you for considering contributing to id-ts! 🎉 We welcome contributions from everyone, whether you're fixing a bug, adding a feature, improving documentation, or just asking questions.
3+
Thank you for considering contributing to typed-id! 🎉 We welcome contributions from everyone, whether you're fixing a bug, adding a feature, improving documentation, or just asking questions.
44

55
## 📋 Table of Contents
66

@@ -57,8 +57,8 @@ This project and everyone participating in it is governed by our Code of Conduct
5757

5858
```bash
5959
# 1. Fork the repository on GitHub, then clone your fork
60-
git clone https://github.com/YOUR_USERNAME/id-ts.git
61-
cd id-ts
60+
git clone https://github.com/YOUR_USERNAME/typed-id.git
61+
cd typed-id
6262

6363
# 2. Install dependencies
6464
bun install
@@ -72,7 +72,7 @@ bun test
7272
### Project Structure
7373

7474
```
75-
id-ts/
75+
typed-id/
7676
├── src/ # Source code
7777
│ ├── id-helper.ts # Main IdHelper class
7878
│ ├── types.ts # Type definitions
@@ -297,4 +297,4 @@ We appreciate all contributions, no matter how small! Contributors will be:
297297

298298
---
299299

300-
Thank you for contributing to id-ts! Together, we can make type-safe ID generation better for everyone. 🚀
300+
Thank you for contributing to typed-id! Together, we can make type-safe ID generation better for everyone. 🚀

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# id-ts
1+
# typed-id
22

3-
![npm version](https://img.shields.io/npm/v/id-ts) ![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?logo=typescript&logoColor=white) ![License](https://img.shields.io/npm/l/id-ts) ![Test Status](https://img.shields.io/github/actions/workflow/status/max-programming/id-ts/test.yml?branch=main)
3+
![npm version](https://img.shields.io/npm/v/typed-id) ![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?logo=typescript&logoColor=white) ![License](https://img.shields.io/npm/l/typed-id) ![Test Status](https://img.shields.io/github/actions/workflow/status/max-programming/typed-id/test.yml?branch=main)
44

55
A lightweight, type-safe TypeScript library for generating prefixed IDs with customizable options. Perfect for creating consistent, identifiable IDs across your application (e.g., `user_abc123xyz`, `order_def456uvw`).
66

@@ -17,13 +17,13 @@ A lightweight, type-safe TypeScript library for generating prefixed IDs with cus
1717
## 🚀 Installation
1818

1919
```bash
20-
npm install id-ts
20+
npm install typed-id
2121
# or
22-
yarn add id-ts
22+
yarn add typed-id
2323
# or
24-
pnpm add id-ts
24+
pnpm add typed-id
2525
# or
26-
bun add id-ts
26+
bun add typed-id
2727
```
2828

2929
### Optional Dependencies
@@ -39,7 +39,7 @@ npm install zod
3939
### Basic Usage
4040

4141
```typescript
42-
import { IdHelper } from "id-ts";
42+
import { IdHelper } from "typed-id";
4343

4444
// Create an ID helper for users
4545
const userIdHelper = new IdHelper("user");
@@ -63,7 +63,7 @@ console.log(orderId); // "order::A1B2C3D4E5F6" (example output)
6363
### Advanced Examples
6464

6565
```typescript
66-
import { IdHelper } from "id-ts";
66+
import { IdHelper } from "typed-id";
6767

6868
// Different ID types for your application
6969
const userIds = new IdHelper("user");
@@ -82,11 +82,11 @@ const session = sessionIds.generate(); // "session_a1b2c3d4e5f67890"
8282

8383
## 🔍 Zod Integration
8484

85-
If you're using Zod for validation, id-ts provides built-in schema creators:
85+
If you're using Zod for validation, typed-id provides built-in schema creators:
8686

8787
```typescript
88-
import { IdHelper } from "id-ts";
89-
import { createZodIdSchema } from "id-ts/validators/zod";
88+
import { IdHelper } from "typed-id";
89+
import { createZodIdSchema } from "typed-id/validators/zod";
9090

9191
const userIdHelper = new IdHelper("user");
9292
const userIdSchema = createZodIdSchema(userIdHelper);
@@ -164,8 +164,8 @@ type GeneratedID<P extends string, S extends string> = `${P}${S}${string}`;
164164

165165
```bash
166166
# Clone the repository
167-
git clone https://github.com/max-programming/id-ts.git
168-
cd id-ts
167+
git clone https://github.com/max-programming/typed-id.git
168+
cd typed-id
169169

170170
# Install dependencies
171171
bun install
@@ -220,7 +220,7 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
220220

221221
If you have any questions or issues, please:
222222

223-
1. Check the [existing issues](https://github.com/max-programming/id-ts/issues)
223+
1. Check the [existing issues](https://github.com/max-programming/typed-id/issues)
224224
2. Create a new issue with a clear description
225225
3. Include code examples and expected vs actual behavior
226226

bun.lock

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"lockfileVersion": 1,
33
"workspaces": {
44
"": {
5-
"name": "id-ts",
5+
"name": "typed-id",
66
"dependencies": {
77
"nanoid": "^5.1.5",
88
},

package.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
{
2-
"name": "id-ts",
2+
"name": "typed-id",
33
"version": "1.1.3",
44
"description": "A lightweight, type-safe TypeScript library for generating prefixed IDs with customizable options",
55
"author": "Max Programming",
66
"license": "MIT",
77
"repository": {
88
"type": "git",
9-
"url": "git+https://github.com/max-programming/id-ts.git"
9+
"url": "git+https://github.com/max-programming/typed-id.git"
1010
},
1111
"bugs": {
12-
"url": "https://github.com/max-programming/id-ts/issues"
12+
"url": "https://github.com/max-programming/typed-id/issues"
1313
},
14-
"homepage": "https://github.com/max-programming/id-ts#readme",
14+
"homepage": "https://github.com/max-programming/typed-id#readme",
1515
"keywords": [
1616
"id",
1717
"uuid",

0 commit comments

Comments
 (0)