Skip to content

Commit 2da2916

Browse files
committed
refactor: rename configuration file from objectql.config.ts to objectstack.config.ts and update related references
- Updated tsconfig.json to exclude objectstack.config.ts instead of objectql.config.ts - Deleted the old objectql.config.ts file and created a new objectstack.config.ts file with the same content. - Modified package.json to run the development server without specifying the config file. - Updated README files and CLI commands to reference the new objectstack.config.ts. - Refactored CLI commands to use a utility function for resolving the configuration file path. - Removed deprecated commands related to the old configuration file.
1 parent 0d1258a commit 2da2916

22 files changed

Lines changed: 110 additions & 723 deletions

File tree

content/docs/getting-started/cli.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ npx objectql repl [options]
107107

108108
| Option | Alias | Default | Description |
109109
| :--- | :--- | :--- | :--- |
110-
| `--config <path>` | `-c` | - | Path to `objectql.config.ts/js`. |
110+
| `--config <path>` | `-c` | - | Path to `objectstack.config.ts/js`. |
111111

112112
**Example Session:**
113113

@@ -181,7 +181,7 @@ npx objectql migrate [options]
181181

182182
| Option | Alias | Default | Description |
183183
| :--- | :--- | :--- | :--- |
184-
| `--config <path>` | `-c` | - | Path to `objectql.config.ts/js`. |
184+
| `--config <path>` | `-c` | - | Path to `objectstack.config.ts/js`. |
185185
| `--dir <path>` | `-d` | `./migrations` | Migrations directory. |
186186

187187
### 5.2 `migrate create`
@@ -210,7 +210,7 @@ npx objectql migrate status [options]
210210

211211
| Option | Alias | Default | Description |
212212
| :--- | :--- | :--- | :--- |
213-
| `--config <path>` | `-c` | - | Path to `objectql.config.ts/js`. |
213+
| `--config <path>` | `-c` | - | Path to `objectstack.config.ts/js`. |
214214
| `--dir <path>` | `-d` | `./migrations` | Migrations directory. |
215215

216216
## 6. Integration with Workflow

content/docs/reference/foundation/platform-node.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -249,7 +249,7 @@ my-app/
249249
│ └── permissions/
250250
│ ├── user.permission.yml
251251
│ └── project.permission.yml
252-
└── objectql.config.ts
252+
└── objectstack.config.ts
253253
```
254254

255255
**Loading:**
@@ -281,7 +281,7 @@ my-app/
281281
│ │ │ └── milestone.object.yml
282282
│ │ └── permissions/
283283
│ │ └── project.permission.yml
284-
└── objectql.config.ts
284+
└── objectstack.config.ts
285285
```
286286

287287
**Loading:**
@@ -309,7 +309,7 @@ my-app/
309309
│ │ ├── project.object.yml
310310
│ │ ├── project.validation.yml
311311
│ │ └── project.hooks.ts
312-
└── objectql.config.ts
312+
└── objectstack.config.ts
313313
```
314314

315315
**Loading:**
@@ -321,7 +321,7 @@ loader.load('./src/entities');
321321

322322
## Complete Example
323323

324-
### objectql.config.ts
324+
### objectstack.config.ts
325325

326326
```typescript
327327
import { ObjectQL } from '@objectql/core';
@@ -462,7 +462,7 @@ rules:
462462
### src/index.ts
463463
464464
```typescript
465-
import app from './objectql.config';
465+
import app from './objectstack.config';
466466

467467
(async () => {
468468
// Initialize

content/docs/server/configuration.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ ObjectQL is configured by passing an `ObjectQLConfig` object to the constructor.
77
## Basic Layout
88

99
```typescript
10-
// objectql.config.ts
10+
// objectstack.config.ts
1111
import { ObjectQL } from '@objectql/core';
1212

1313
export const db = new ObjectQL({

content/docs/server/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ app.listen(3000, () => {
8989
### Configuration File
9090

9191
```typescript
92-
// objectql.config.ts
92+
// objectstack.config.ts
9393
import { defineConfig } from '@objectql/core';
9494

9595
export default defineConfig({

examples/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Welcome to the ObjectQL Examples repository. This collection demonstrates everyt
1414
| **[Basic Script](./starters/basic-script)** | A simple TypeScript script initializing ObjectQL with SQLite. Perfect for testing logic without a web server. | 🟢 Basic |
1515

1616
### 2. 🧩 Module Architecture
17-
*Demonstrating the power of the new `modules` system in `objectql.config.ts`. See `examples/scenarios/`.*
17+
*Demonstrating the power of the new `modules` system in `objectstack.config.ts`. See `examples/scenarios/`.*
1818

1919
| Example | Description | Proficiency |
2020
| :--- | :--- | :--- |

examples/showcase/project-tracker/tsconfig.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@
66
"resolveJsonModule": true
77
},
88
"include": ["src/**/*"],
9-
"exclude": ["objectql.config.ts"]
9+
"exclude": ["objectstack.config.ts"]
1010
}
1111

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"private": true,
44
"packageManager": "pnpm@10.28.2",
55
"scripts": {
6-
"dev": "objectstack serve objectql.config.ts",
6+
"dev": "objectstack serve",
77
"cli:dev": "ts-node packages/tools/cli/src/index.ts",
88
"site:dev": "pnpm --filter @objectql/site run dev",
99
"build": "turbo run build",

packages/foundation/platform-node/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ my-app/
182182
│ └── permissions/
183183
│ ├── user.permission.yml
184184
│ └── project.permission.yml
185-
└── objectql.config.ts
185+
└── objectstack.config.ts
186186
```
187187

188188
### Modular Structure
@@ -203,12 +203,12 @@ my-app/
203203
│ │ │ └── milestone.object.yml
204204
│ │ └── permissions/
205205
│ │ └── project.permission.yml
206-
└── objectql.config.ts
206+
└── objectstack.config.ts
207207
```
208208

209209
## Complete Example
210210

211-
### objectql.config.ts
211+
### objectstack.config.ts
212212

213213
```typescript
214214
import { ObjectQL } from '@objectql/core';

packages/tools/cli/README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -173,14 +173,14 @@ Run pending database migrations.
173173
objectql migrate
174174

175175
# Specify custom config file
176-
objectql migrate --config ./config/objectql.config.ts
176+
objectql migrate --config ./config/objectstack.config.ts
177177

178178
# Custom migrations directory
179179
objectql migrate --dir ./db/migrations
180180
```
181181

182182
**Options:**
183-
- `-c, --config <path>` - Path to objectql.config.ts/js
183+
- `-c, --config <path>` - Path to objectstack.config.ts/js
184184
- `-d, --dir <path>` - Migrations directory [default: "./migrations"]
185185

186186
#### `migrate create <name>`
@@ -207,11 +207,11 @@ Show migration status (pending vs. completed).
207207
objectql migrate status
208208

209209
# With custom config
210-
objectql migrate status --config ./config/objectql.config.ts
210+
objectql migrate status --config ./config/objectstack.config.ts
211211
```
212212

213213
**Options:**
214-
- `-c, --config <path>` - Path to objectql.config.ts/js
214+
- `-c, --config <path>` - Path to objectstack.config.ts/js
215215
- `-d, --dir <path>` - Migrations directory [default: "./migrations"]
216216

217217
#### `sync`
@@ -235,11 +235,11 @@ objectql sync --output ./src/metadata/objects
235235
objectql sync --force
236236

237237
# With custom config file
238-
objectql sync --config ./config/objectql.config.ts
238+
objectql sync --config ./config/objectstack.config.ts
239239
```
240240

241241
**Options:**
242-
- `-c, --config <path>` - Path to objectql.config.ts/js
242+
- `-c, --config <path>` - Path to objectstack.config.ts/js
243243
- `-o, --output <path>` - Output directory for .object.yml files [default: "./src/objects"]
244244
- `-t, --tables <tables...>` - Specific tables to sync (default: all tables)
245245
- `-f, --force` - Overwrite existing .object.yml files
@@ -437,11 +437,11 @@ Start an interactive shell to query your data.
437437
objectql repl
438438
439439
# Use custom config
440-
objectql repl --config ./objectql.config.ts
440+
objectql repl --config ./objectstack.config.ts
441441
```
442442

443443
**Options:**
444-
- `-c, --config <path>` - Path to objectql.config.ts/js
444+
- `-c, --config <path>` - Path to objectstack.config.ts/js
445445

446446
**Example REPL session:**
447447
```javascript
@@ -523,10 +523,10 @@ objectql migrate
523523

524524
## Configuration File
525525

526-
Most commands expect an `objectql.config.ts` or `objectql.config.js` file in your project root:
526+
Most commands expect an `objectstack.config.ts` or `objectstack.config.js` file in your project root:
527527

528528
```typescript
529-
// objectql.config.ts
529+
// objectstack.config.ts
530530
import { ObjectQL } from '@objectql/core';
531531
import { SqlDriver } from '@objectql/driver-sql';
532532
import { ObjectLoader } from '@objectql/platform-node';

0 commit comments

Comments
 (0)