LaraNuxt icon indicating copy to clipboard operation
LaraNuxt copied to clipboard

LaraNuxt Release

Open mentAl-maZe opened this issue 4 years ago • 4 comments

Thread to discuss properties and requirements for future LaraNuxt releases

mentAl-maZe avatar Sep 13 '20 18:09 mentAl-maZe

@GautierDele I opened this thread to handle discussion about future development of the package.

First order of business: Consider making the TypeScript branch the default

Pros

  • Typescript is a much nicer experience in development because strict types offer MUCH better instrumentation in IDEs.
  • Typescript avoids most run time errors by raising them already at compilation time... in addition with the correct IDE configuration prevents devs from coding such errors in the first place
  • Also with nuxt-property-decorator it is easy to define components as classes and thus should be more intuitive for people with OOP experience

Cons

  • Some new syntax to learn, but it mostly concerns typing an interface definition

mentAl-maZe avatar Sep 13 '20 18:09 mentAl-maZe

Second order of business: Consider Vuepress page for documentation and presentation

Vuepress allows to easily create a web page from Markdown files. Features include (but are not limited to):

  • easy to configure landing page
  • automatic menu
  • exchangeable and customizable templates

Of course the initial page in the package should show some info about the project, but as people might use this as template i think it should be kept minimal

mentAl-maZe avatar Sep 13 '20 19:09 mentAl-maZe

Hello,

I don't really think typescript should be the default one. A lot of people going for Vue don't know TypeScript and it's sometime the reason why they choose Vue. We could still maintain it since it seems TypeScript is a good solution.

Considering VuePress, i quite like the idea but it seems that there is a new version of this documentation - maybe a new package that i can't find -> https://dev.auth.nuxtjs.org/ Might be just styling ? A lot of package are going by this, i will have a look

GautierDele avatar Sep 19 '20 16:09 GautierDele

LaraNuxt doc can be found here: Pull Request #17 - nuxt-laravel.

  • This is using nuxt content which seems nicer than vuepress
  • I don't like the idea to implement this into nuxt-laravel because this is the LaraNuxt doc but the fact is that LaraNuxt is a template -> don't want to push docs to everybody packages
  • This is just a pull request we can move easely the doc while developping it

GautierDele avatar Sep 19 '20 17:09 GautierDele