Skip to content
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.

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

Annotations & Linter including luascript.cpp functions #4672

Merged
merged 4 commits into from
May 22, 2024

Conversation

EvilHero90
Copy link
Contributor

@EvilHero90 EvilHero90 commented May 7, 2024

Pull Request Prelude

Changes Proposed

This will make it easier for people with IDE's capable of linting to be able to keep track of their code.
It includes all functions from luascript.cpp
There is still some stuff missing, feel free to propose changes/fixes.

Issues addressed:

@EvilHero90 EvilHero90 added enhancement Increase or improvement in quality, value, or extent feature New feature or functionality documentation includes linting/annotations or overall documentation labels May 7, 2024
@EvilHero90 EvilHero90 marked this pull request as ready for review May 9, 2024 13:13
@Codinablack
Copy link
Contributor

This is quite a lot, and I really like the looks of this thing.... and I understand what a linter does, but, can you explain to me how this works?

@EvilHero90
Copy link
Contributor Author

EvilHero90 commented May 10, 2024

This is quite a lot, and I really like the looks of this thing.... and I understand what a linter does, but, can you explain to me how this works?

Assuming you work with vsc or cursor (not sure which other IDE's have those options)
You have to enable a linter addon (preferable https://marketplace.visualstudio.com/items?itemName=sumneko.lua)
Then you open your entire root folder of the tfs project you are working on and it'll automaticly find this file and it'll start checking all of the files which are load for the project and show you where you have potential errors
You DON'T let this file be load by the server, it just needs to be somewhere inside the working directory that's all

Copy link
Contributor

@MillhioreBT MillhioreBT left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It will have to be tested and reviewed as you go.

@EvilHero90 EvilHero90 merged commit ea59250 into otland:master May 22, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation includes linting/annotations or overall documentation enhancement Increase or improvement in quality, value, or extent feature New feature or functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants