laravel-shift / blueprint-docs

Documentation for Blueprint build with Jigsaw

Blueprint Docs

This project contains the documentation for Blueprint. It's built with Jigsaw using their Docs Template.

Contributing

Contributions may be made by submitting a Pull Request against the master branch.

You may also contribute by opening an issue to report a typo, ask a question, or suggest new content.

blueprint-docs's Issues

Doc should be clear that BluePrint only creates new components, doesn't support updates

I've just started using BluePrint and after reading the doc, "it's common to simply reuse the draft.yaml file over and over again to continue to generate code for your application", I was (wrongly) under the impression that I just could define a column and have my model updated.

I had to read many issues to finally find this one.

I probably shouldn't believe in magic anymore, but I can't help...

I think the doc should make clear that models can't be updated, and/or give any clues to bypass this.

Best way to extends model lexers

I have a questions about extending blueprint, since the docs doesn't cover too much about it, and I have not a twitter account to ask there, so sorry to jump here with this question.

I create a custom generator which starting from a model defined in draft.yaml, generate the controllers and basic views with a table with sorting and filtering.

All works fine so far, pretty powerful package!

At the moment I have just get all columns from model using $model->columns() and making all string, number and dates sortable and filterable.

I would like to add some new info inside draft.yaml when defining the model.

Somethiing like:

models:
  Post:
    title: string:255 sortable filterable
    content: longtext filterable
    published_at: nullable timestamp
    softDeletes

seeders: Post

I think such things should be done in the lexer, since we can only overrides the generators via config, is there a way to do this without creating custom model generator and model lexer?

Thanks

Deployment?

Hey @jasonmccreary

I've noticed an example on the website being incorrect:

When I checked the repo to fix it, I've noticed it was already fixed. Maybe the deployment needs to be triggered?

Cheers,
Peter

Controllers: MyController: resource: all doesn't work as documented

In your docs you suggest that all, api, and web are valid resource options. See 6 paragraphs down on page https://blueprint.laravelshift.com/docs/controller-shorthands/

Reviewing RouteGenerator.php, I see that all is not a valid option.
https://github.com/laravel-shift/blueprint/blob/7c9a32ef8e46796c2ef18a21f6bbb2359690fc3c/src/Generators/RouteGenerator.php#L20

In testing, using all generates an empty controller.

Blueprint how can we ignore existing models?

Just starting a new project and blueprint is great.
I was able to setup the initial structure of my app within minutes 🔥

One question is how do I append additional models without overriding everything?
I assumed running blueprint:trace would cache the models generated so that running again with the additional models appended to draft.yaml would only generate the new model.

However it seems to override everything which is not ideal after editing each model.
Expected behaviour would be to ignore anything which is already in .blueprint then just add new model Bid for example.

models:
    Auction: {  }
    Buyer: {  }
    Category: {  }
    Item: {  }
    Price: {  }
    Seller: {  }
    User: { }
    UserProfile: {  }

Current workaround is to comment out the generated models in draft.yaml
Certainly not ideal hoping there is a better way? or perhaps I can create a PR at some point to ignore anything with has been previously generated by the build command?

Additionally are you planning support enum generation?
for example it would be useful to generate Enums based from the field.
buyer_status: enum:pending,paid,reviewed,refunded,cancelled,disputed,completed

Enhance doc regarding generator UI: drawsql.app

After some searching for a UI to generate Laravel Blueprint draft.yaml files, I accidentally found out that https://drawsql.app can also generate Blueprint files.

It would be nice to mention this in the documentation.

missing example for trashed

hi
i search example with trashed for controller

Post::withTrashed()->get()
but i see nothing

Invokable controllers

As the creation of invokable controllers got released, I'd also like to add it to the docs. I think it would best fit into the controller shorthands section?

generate_fqcn_route

Hello,

On the Docs, it says generate_fqcn_route set to true on Advanced Configuration

After exporting the config file, i can't find it is it still valid?

New Addon

I've created a Blueprint addon for TALL-forms.
Would you consider adding it to the list of integrations?

https://github.com/tanthammar/tall-blueprint-addon

Example
TALL-forms: Automatically generate forms for each of the models specified in your draft file.