Skip to content

Configure default data types #761

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 10, 2025
Merged

Configure default data types #761

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
76127de
Configure default data types
jasonmccreary Nov 10, 2025
f9f648d
Default for backward compatibility
jasonmccreary Nov 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions config/blueprint.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,21 @@
*/
'use_guarded' => false,

/*
|--------------------------------------------------------------------------
| Default Data Types
|--------------------------------------------------------------------------
|
| By default, Blueprint will set the primary key data type to `id` and the
| timestamps data type to `timestamp`. While you may customize these in
| your draft file, you may also configure your own defaults below.
|
*/
'types' => [
'primary' => 'id',
'timestamps' => 'timestamp',
],

/*
|--------------------------------------------------------------------------
| Singular route names
Expand Down
12 changes: 10 additions & 2 deletions src/Lexers/ModelLexer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,10 @@ private function buildModel(string $name, array $columns): Model
} elseif (isset($columns['timestampstz'])) {
$model->enableTimestamps(true);
unset($columns['timestampstz']);
} elseif (config('blueprint.types.timestamps') === false) {
$model->disableTimestamps();
} else {
$model->enableTimestamps(strtolower(config('blueprint.types.timestamps', 'timestamp')) === 'timestamptz');
}

if (isset($columns['softdeletes'])) {
Expand Down Expand Up @@ -203,8 +207,12 @@ private function buildModel(string $name, array $columns): Model
}

if (!isset($columns['id']) && $model->usesPrimaryKey()) {
$column = $this->buildColumn('id', 'id');
$model->addColumn($column);
if (config('blueprint.types.primary')) {
$column = $this->buildColumn('id', config('blueprint.types.primary', 'id'));
$model->addColumn($column);
} else {
$model->disablePrimaryKey();
}
}

foreach ($columns as $name => $definition) {
Expand Down
138 changes: 138 additions & 0 deletions tests/Feature/Lexers/ModelLexerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
namespace Tests\Feature\Lexers;

use Blueprint\Lexers\ModelLexer;
use Illuminate\Support\Arr;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Test;
use Tests\TestCase;
Expand Down Expand Up @@ -124,6 +125,42 @@ public function it_defaults_the_id_column(): void
$this->assertEquals(['nullable'], $columns['title']->modifiers());
}

#[Test]
public function it_defaults_the_id_column_based_on_configuration(): void
{
$type = Arr::random(['id', 'uuid', 'ulid']);
config(['blueprint.types.primary' => $type]);

$tokens = [
'models' => [
'Model' => [
'title' => 'string nullable',
],
],
];

$actual = $this->subject->analyze($tokens);

$this->assertIsArray($actual['models']);
$this->assertCount(1, $actual['models']);

$model = $actual['models']['Model'];
$this->assertEquals('Model', $model->name());
$this->assertTrue($model->usesTimestamps());
$this->assertFalse($model->usesSoftDeletes());

$columns = $model->columns();
$this->assertCount(2, $columns);
$this->assertEquals('id', $columns['id']->name());
$this->assertEquals($type, $columns['id']->dataType());
$this->assertEquals([], $columns['id']->attributes());
$this->assertEquals([], $columns['id']->modifiers());
$this->assertEquals('title', $columns['title']->name());
$this->assertEquals('string', $columns['title']->dataType());
$this->assertEquals([], $columns['title']->attributes());
$this->assertEquals(['nullable'], $columns['title']->modifiers());
}

#[Test]
public function it_disables_the_id_column(): void
{
Expand All @@ -147,6 +184,73 @@ public function it_disables_the_id_column(): void
$this->assertFalse($model->usesPrimaryKey());
}

#[Test]
public function it_disables_the_id_column_based_on_configuration(): void
{
config(['blueprint.types.primary' => false]);

$tokens = [
'models' => [
'Model' => [
'name' => 'string',
],
],
];

$actual = $this->subject->analyze($tokens);

$this->assertIsArray($actual['models']);
$this->assertCount(1, $actual['models']);

$model = $actual['models']['Model'];
$this->assertEquals('Model', $model->name());
$this->assertFalse($model->usesPrimaryKey());
$this->assertCount(1, $model->columns());

$columns = $model->columns();
$this->assertEquals('name', $columns['name']->name());
$this->assertEquals('string', $columns['name']->dataType());
$this->assertEquals([], $columns['name']->attributes());
$this->assertEquals([], $columns['name']->modifiers());
}

#[Test]
public function it_sets_timestamps_data_type_based_on_configuration(): void
{
$type = Arr::random(['timestampTz', 'timestamptz']);
config(['blueprint.types.timestamps' => $type]);

$tokens = [
'models' => [
'Model' => [
'name' => 'string',
],
],
];

$actual = $this->subject->analyze($tokens);

$this->assertIsArray($actual['models']);
$this->assertCount(1, $actual['models']);

$model = $actual['models']['Model'];
$this->assertEquals('Model', $model->name());
$this->assertTrue($model->usesTimestamps());
$this->assertSame('timestampsTz', $model->timestampsDataType());
$this->assertFalse($model->usesSoftDeletes());
$this->assertCount(2, $model->columns());

$columns = $model->columns();
$this->assertEquals('id', $columns['id']->name());
$this->assertEquals('id', $columns['id']->dataType());
$this->assertEquals([], $columns['id']->attributes());
$this->assertEquals([], $columns['id']->modifiers());
$this->assertEquals('name', $columns['name']->name());
$this->assertEquals('string', $columns['name']->dataType());
$this->assertEquals([], $columns['name']->attributes());
$this->assertEquals([], $columns['name']->modifiers());
}

#[Test]
public function it_disables_timestamps(): void
{
Expand All @@ -169,6 +273,40 @@ public function it_disables_timestamps(): void
$this->assertFalse($model->usesSoftDeletes());
}

#[Test]
public function it_disables_timestamps_based_on_configuration(): void
{
config(['blueprint.types.timestamps' => false]);

$tokens = [
'models' => [
'Model' => [
'name' => 'string',
],
],
];

$actual = $this->subject->analyze($tokens);

$this->assertIsArray($actual['models']);
$this->assertCount(1, $actual['models']);

$model = $actual['models']['Model'];
$this->assertEquals('Model', $model->name());
$this->assertFalse($model->usesSoftDeletes());
$this->assertCount(2, $model->columns());

$columns = $model->columns();
$this->assertEquals('id', $columns['id']->name());
$this->assertEquals('id', $columns['id']->dataType());
$this->assertEquals([], $columns['id']->attributes());
$this->assertEquals([], $columns['id']->modifiers());
$this->assertEquals('name', $columns['name']->name());
$this->assertEquals('string', $columns['name']->dataType());
$this->assertEquals([], $columns['name']->attributes());
$this->assertEquals([], $columns['name']->modifiers());
}

#[Test]
public function it_defaults_to_string_datatype(): void
{
Expand Down