Type checking in the build process

[christophstockinger]

This pull request adds a tsc (TypeScript Compiler) task to the build process. Currently, the build pipeline does not include a TypeScript type-checking step, which means that potentially erroneous TypeScript code could be deployed to production without being caught during the build process.

By incorporating the tsc task, we ensure that type errors are detected early in the build cycle, preventing invalid or mis-typed code from being pushed to production. This enhances the overall stability and reliability of the codebase and reduces the risk of runtime errors caused by type mismatches. Type checking during the build process also helps maintain consistency in our code, making it easier to spot bugs early on and ensuring a higher level of confidence in the production deployment.

Benefits:

• Early Error Detection: TypeScript's type checking will be enforced during the build, catching errors early before code reaches production.
• Code Quality Assurance: Including the tsc task ensures that only type-safe code is included in production builds, reducing the likelihood of runtime type errors.
• Improved Developer Experience: Developers will be alerted to type issues during the build process, helping to maintain cleaner and more maintainable code.

Please review and provide feedback. Thank you!

[christophstockinger]

⚠️ ⚠️ ⚠️ This PR requires changes to PR #36 for the CI test pipeline to exist, which currently assigns an interface to a type in the useForm hook in the forms, which leads to a build error!

[christophstockinger]

Since #36 was rejected, I have made the changes regarding type-checking in this PR.

⚠️ In addition, the order of the steps in the Github test action was adjusted, the npm run build requires the composer dependencies due to ziggy-js.

[taylorotwell]

Does this need to be ported to Vue starter kit as well?

[christophstockinger]

@taylorotwell I'll have a look, but probably won't get around to it until Friday. Hope that's all right?

[christophstockinger]

Okay I found some time this evening and create a port for the vue-starter-kit laravel/vue-starter-kit#52

[tnylea]

Thanks @christophstockinger 👏

Will be discussing this with Taylor tomorrow and following up on this. Appreciate the PR.

[tnylea]

@christophstockinger, would you mind resolving the current conflicts and then we can work on getting this PR merged in the next few days.

Really appreciate it 👍

[christophstockinger]

@christophstockinger, would you mind resolving the current conflicts and then we can work on getting this PR merged in the next few days.

Really appreciate it 👍

@tnylea All conflicts are resolved

[devinnived]

Is this still needed? By default phpunit uses sqlite in memory https://github.com/laravel/react-starter-kit/blob/main/phpunit.xml#L26

[christophstockinger]

Hi @devinnived , thanks for your comment.
I didn't make any changes in this regard, I just adjusted the order here as this is necessary for a successful pipeline.

Unfortunately, I am not an expert in PHPUnit and cannot assess your change request. If you are of the opinion that it can be done differently, then I would suggest that you contribute this yourself via a PR.

[devinnived]

I understand. I checked the workflow files and do not see the Create SQLite Database section

[christophstockinger]

#52

[tnylea]

Hey @christophstockinger,

I just responded in the Vue PR here (laravel/vue-starter-kit#52) with our thoughts on this. If you could do the same to this PR and add the tsc to the CI workflow that would be great.

Really appreciate it.

[tnylea]

We won't want to add the tsc to the build step, but this would be great to add to the Github Workflow. Let me know if you can make those updates and we can get this merged in.

Appreciate it!

[christophstockinger]

We won't want to add the tsc to the build step, but this would be great to add to the Github Workflow. Let me know if you can make those updates and we can get this merged in.

Appreciate it!

Unfortunately, I won't get to it for a few days. Hope that's all right?

I also have a few other thoughts on this topic, but I need to sort them out more precisely and will come back to them in the update.

[christophstockinger]

@tnylea PR is updated.

I have introduced a new command type:check, which compiles and checks the typescript using tsc.

A few more thoughts: Currently, however, this only does something in the internal Github action to keep the starter kit type-safe. However, I would still question whether there is any benefit in using the starter kit if other pipelines (e.g. Envoyer or Laravel Cloud) are used and not Github Action. You may need to find a way to point out how this is used.

One of your arguments was also that people who are not familiar with Typescript may have problems with it. I agree with this and would therefore ask whether it wouldn't make more sense to provide a starter kit for Typescript or Javascript? If necessary, you can also include this in the laravel new command and then install the correct repo accordingly. This is how many Javascript frameworks such as next.js do it, for example.

[tnylea]

Thanks @christophstockinger

I totally hear what you are saying. The hard part about offering a JS and TS version is the maintenance. In addition to the authentication options, we would have three different versions to maintain for each React/Vue. Then, we have two versions of the Livewire. So, in total, we would have eight versions to maintain. Perhaps we can find a better way to streamline this in the future, but for now, we're going to go with adding the typescript checker only in the CI.

Thanks for the latest update. Really appreciate the contribution 👍