Comments (3)
It will be somewhat difficult to support this. We currently don't bother formatting comments at all, since comments could consist of anything.
We could support formatting specifically doc comments, however there is no "standardised" way of defining documentation comments in Lua (luadoc, emmylua, LuaCATs, moonwave, etc.), so it isn't clear which one, if any, we should support.
from stylua.
At the very minimum, we could enforce consistent whitespace in doc comments:
---text1
--- text2
--- @param a
---@return string
becomes:
--- text1
--- text2
--- @param a
--- @return string
Where the padding maybe configurable.
from stylua.
Related Issues (20)
- `GLIBC_2.28` not found on Ubuntu 18.04 HOT 4
- pre-commit setup failure: KeyError: 'git-url' HOT 2
- Tests fail on v0.19.0, stack overflow in test_large_example HOT 8
- Modification time of unchanged files are changed HOT 1
- Luau: stylua erroneously removes parentheses around string union table indexers
- feature request: regarding support for "func {foo=.., bar=..}" named args syntax HOT 2
- Function definition for a very long variable name results into only closing bracket moved to the next line HOT 1
- feat: Use closest `stylua.toml` config to file being formatted HOT 7
- Add option to add spaces in function definitions HOT 5
- Ignore VCS ignored files HOT 1
- Is it possible to allow inline functions? HOT 4
- `--respect-ignores`: does not correctly ignore folders without the globbing pattern HOT 2
- Stylua extension won't format files HOT 4
- 1.6.0 doesn't seem to be supporting my Lua files HOT 8
- Stylua doesn't enforce column_width correctly with some inputs HOT 2
- Question- Support ? and ` characters? HOT 7
- Could not format file: INTERNAL WARNING: Output AST may be different to input AST. HOT 4
- VSCode plugin error on update: `No release version matches v.`
- Unable to format lua 5.4 code HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from stylua.