AppFlowy-IO/AppFlowy

Fork 0

mirror of https://github.com/AppFlowy-IO/AppFlowy.git synced 2026-03-24 04:46:56 +00:00

[GH-ISSUE #2225] [FR] Add the rules to analysis_options.yaml based on AppFlowy Flutter Style Guide #911

New issue

Closed

opened 2026-03-23 20:42:58 +00:00 by mirror · 10 comments

mirror commented

2026-03-23 20:42:58 +00:00

Owner

Originally created by @LucasXu0 on GitHub (Apr 10, 2023).
Original GitHub issue: https://github.com/AppFlowy-IO/AppFlowy/issues/2225

Originally assigned to: @literalEval on GitHub.

Description

We should add rules to analysis_options.ymal, located in frontend/analysis_options.yaml, based on AppFlowy Flutter Style Guide

#2226
#2228

Impact

This will help format the code and reduce the time required for code reviewing.

Additional Context

Reference

Please DO NOT close this issue. We will keep this issue open to continue discussing which rules should be added.

Originally created by @LucasXu0 on GitHub (Apr 10, 2023). Original GitHub issue: https://github.com/AppFlowy-IO/AppFlowy/issues/2225 Originally assigned to: @literalEval on GitHub. ### Description We should add rules to `analysis_options.ymal`, located in `frontend/analysis_options.yaml`, based on [AppFlowy Flutter Style Guide](https://appflowy.gitbook.io/docs/essential-documentation/contribute-to-appflowy/software-contributions/submitting-code/style-guides) - [x] #2226 - [x] #2228 ### Impact This will help format the code and reduce the time required for code reviewing. ### Additional Context #### Reference * https://dart-lang.github.io/linter/lints/index.html * https://appflowy.gitbook.io/docs/essential-documentation/contribute-to-appflowy/software-contributions/submitting-code/style-guides **Please DO NOT close this issue**. We will keep this issue open to continue discussing which rules should be added.

mirror

2026-03-23 20:42:58 +00:00

closed this issue
added the
good first issue for devs

good first issue for experienced devs

help wanted
labels

mirror commented

2026-03-23 20:42:59 +00:00

Author

Owner

@literalEval commented on GitHub (Apr 20, 2023):

I would like to work on this issue @annieappflowy @LucasXu0
Please assign this to me :)

@literalEval commented on GitHub (Apr 20, 2023): I would like to work on this issue @annieappflowy @LucasXu0 Please assign this to me :)

mirror commented

2026-03-23 20:42:59 +00:00

Author

Owner

@annieappflowy commented on GitHub (Apr 21, 2023):

Assigned! Thanks for offering the help.

@annieappflowy commented on GitHub (Apr 21, 2023): Assigned! Thanks for offering the help.

mirror commented

2026-03-23 20:42:59 +00:00

Author

Owner

@literalEval commented on GitHub (Apr 22, 2023):

@LucasXu0 I plan to add each option in a separate PR. Is that fine?

@literalEval commented on GitHub (Apr 22, 2023): @LucasXu0 I plan to add each option in a separate PR. Is that fine?

mirror commented

2026-03-23 20:42:59 +00:00

Author

Owner

@a-wallen commented on GitHub (Jul 5, 2023):

@LucasXu0 let's add one to document all public classes, methods, etc.

@a-wallen commented on GitHub (Jul 5, 2023): @LucasXu0 let's add one to document all public classes, methods, etc.

mirror commented

2026-03-23 20:43:00 +00:00

Author

Owner

@LucasXu0 commented on GitHub (Jul 5, 2023):

@LucasXu0 let's add one to document all public classes, methods, etc.

This one? https://dart.dev/tools/linter-rules/public_member_api_docs

@LucasXu0 commented on GitHub (Jul 5, 2023): > @LucasXu0 let's add one to document all public classes, methods, etc. This one? https://dart.dev/tools/linter-rules/public_member_api_docs

mirror commented

2026-03-23 20:43:00 +00:00

Author

Owner

@a-wallen commented on GitHub (Jul 5, 2023):

Yes, that's the one. I wonder if there's a way that it will only apply to the PR diff rather than the whole repo.

@a-wallen commented on GitHub (Jul 5, 2023): Yes, that's the one. I wonder if there's a way that it will only apply to the PR diff rather than the whole repo.

mirror commented

2026-03-23 20:43:00 +00:00

Author

Owner

@LucasXu0 commented on GitHub (Jul 5, 2023):

It seems that there's no way to apply only to the diff.

@LucasXu0 commented on GitHub (Jul 5, 2023): It seems that there's no way to apply only to the diff.

mirror commented

2026-03-23 20:43:01 +00:00

Author

Owner

@a-wallen commented on GitHub (Jul 5, 2023):

734 members to document, so maybe it's best that we leave this off for now. cc @annieappflowy adding this lint will significantly help the documentation of the codebase.

@a-wallen commented on GitHub (Jul 5, 2023): 734 members to document, so maybe it's best that we leave this off for now. cc @annieappflowy adding this lint will significantly help the documentation of the codebase.

mirror commented

2026-03-23 20:43:01 +00:00

Author

Owner

@literalEval commented on GitHub (Jul 9, 2023):

@LucasXu0

If we use the Dart Linter directly, it is possible to check single/list of file(s). Maybe clone the linter repo during CI and run the tool ? Caching the repo will reduce the runtime in future.
We can add ignore directive on top of each file in the repo, and just check if the file with a diff has the ignore directive or not. If it has, the PR check fails. If it doesn't have, the linter will do it's job anyway.

Though these alternatives will have the problem that even if the contributor changes a single line in the file, they will need to write documentation for the whole file.

@literalEval commented on GitHub (Jul 9, 2023): @LucasXu0 1. If we use the Dart Linter directly, it is possible to check single/list of file(s). Maybe clone the linter repo during CI and run the tool ? Caching the repo will reduce the runtime in future. 2. We can add ignore directive on top of each file in the repo, and just check if the file with a diff has the ignore directive or not. If it has, the PR check fails. If it doesn't have, the linter will do it's job anyway. Though these alternatives will have the problem that even if the contributor changes a single line in the file, they will need to write documentation for the whole file.

mirror commented

2026-03-23 20:43:01 +00:00

Author

Owner

@LucasXu0 commented on GitHub (Jul 10, 2023):

I prefer to request that both us and the contributors write documentation during code reviews for now. Perhaps we can focus on documenting all the public functions or classes in the future. In my opinion, it is not a priority for this quarter.

@LucasXu0 commented on GitHub (Jul 10, 2023): I prefer to request that both us and the contributors write documentation during code reviews for now. Perhaps we can focus on documenting all the public functions or classes in the future. In my opinion, it is not a priority for this quarter.

mirror referenced this issue

2026-03-23 21:37:57 +00:00

[PR #976] [CLOSED] Implement Embed code #4469

mirror referenced this issue

2026-03-23 21:38:03 +00:00

[PR #1006] [MERGED] Tests for toolbar #4490