Sam Rawlins
a2218abe7c
analyzer: Document release policies
...
Change-Id: I98c1d9265f80fff8e3d23e895b0b6b2339bea11a
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/435261
Commit-Queue: Samuel Rawlins <srawlins@google.com >
Reviewed-by: Konstantin Shcheglov <scheglov@google.com >
Reviewed-by: Brian Wilkerson <brianwilkerson@google.com >
Reviewed-by: Paul Berry <paulberry@google.com >
2025-06-17 15:57:33 -07:00
Sam Rawlins
ca662a8c49
analyzer: Move the DevExp style guide doc to analysis_server
...
This is awkward as there are some packages which are co-developed like
analyzer_testing and analyzer_utilities. But broadly speaking, this
style guide is used for the "analysis-related" packages that the Dash
Developer Experience team maintains. So we can move it to live with the
other docs in pkg/analysis_server.
Change-Id: Ic94cfe1d16288ec707c96a42c7a18788e9f8b7d0
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/435220
Reviewed-by: Paul Berry <paulberry@google.com >
Commit-Queue: Samuel Rawlins <srawlins@google.com >
Reviewed-by: Brian Wilkerson <brianwilkerson@google.com >
2025-06-17 12:56:49 -07:00
Johnni Winther
eb8156415c
[cfe] Remove use of 'fasta' in (file)names
...
Change-Id: Iac3850696fb5e48dff847d17f7110644e8b8bd03
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/395920
Reviewed-by: Jens Johansen <jensj@google.com >
Commit-Queue: Johnni Winther <johnniwinther@google.com >
Reviewed-by: Slava Egorov <vegorov@google.com >
2024-11-20 14:22:56 +00:00
Keerti Parthasarathy
b533072386
Update extending the AST docs.
...
Change-Id: I39bc63a7244df0d8a32670dc63f97f672ff86717
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/379080
Commit-Queue: Keerti Parthasarathy <keertip@google.com >
Reviewed-by: Brian Wilkerson <brianwilkerson@google.com >
2024-08-06 19:39:10 +00:00
Brian Wilkerson
4cade6496b
Add documentation related to adding experiment flags
...
Let me know if there's any information missing. We can either add it
now or later.
Change-Id: I9b0792e9e614eadc3a570c3ac0155e8b91ba8489
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/373101
Commit-Queue: Brian Wilkerson <brianwilkerson@google.com >
Reviewed-by: Keerti Parthasarathy <keertip@google.com >
2024-06-25 17:16:48 +00:00
Konstantin Shcheglov
14c155d2db
Coding style. Add the reason for using 'var' and not 'final'.
...
Change-Id: Id30cad3b8c5e45d290d6f1cf5bdc79320e6ff0b7
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/362900
Commit-Queue: Konstantin Shcheglov <scheglov@google.com >
Reviewed-by: Brian Wilkerson <brianwilkerson@google.com >
2024-04-16 17:50:31 +00:00
Sam Rawlins
c2a9026ef2
analyzer: add Effective Dart to our style guide
...
I tidy up a few other bits.
In particular, I wasn't sure about the word "adjective" to describe the word "file" in the variable name `filePath`. I looked it up and found "noun adjunct." https://en.wikipedia.org/wiki/Noun_adjunct#:~:text=Noun%20adjuncts%20can%20also%20be,and%20%22chicken%20soup%22%20modifies%20%22 . Never heard of it! It looks like "qualifying noun" is also a common term, and I think it's not too hard to figure out what that means. But, open to suggestions as always.
Change-Id: If204c67078532fb5130fda08f6777761c87ba8eb
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/355891
Reviewed-by: Brian Wilkerson <brianwilkerson@google.com >
Commit-Queue: Samuel Rawlins <srawlins@google.com >
2024-03-06 19:29:58 +00:00
Sam Rawlins
b19141a202
analyzer: Rename some extensions
...
And add a bit to our style doc about naming of extensions.
Change-Id: I22dd05dfe08b46ae38cc200456eb008e02eb002f
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/347782
Reviewed-by: Brian Wilkerson <brianwilkerson@google.com >
Commit-Queue: Brian Wilkerson <brianwilkerson@google.com >
Auto-Submit: Samuel Rawlins <srawlins@google.com >
2024-01-23 16:26:39 +00:00
Brian Wilkerson
4532e20ec4
Update the coding_style doc
...
After lengthy consideration, I believe that this is the best policy for
the team overall. It also corresponds to what I thought we had already
agreed to in the past.
Change-Id: I952297bf966ace0bdb105a5e4539420c3c6b8983
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/345748
Commit-Queue: Brian Wilkerson <brianwilkerson@google.com >
Reviewed-by: Phil Quitslund <pquitslund@google.com >
Reviewed-by: Samuel Rawlins <srawlins@google.com >
2024-01-12 05:27:28 +00:00
pq
3b5f985aa5
document use of flutter_style_todos
...
We agreed to adopt this style (and I enabled the lint) but forgot to update the doc.
This fixes that!
Change-Id: I68c29471506b8621ee8e6069540f7ca7dc23138e
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/337286
Reviewed-by: Brian Wilkerson <brianwilkerson@google.com >
Commit-Queue: Phil Quitslund <pquitslund@google.com >
Reviewed-by: Konstantin Shcheglov <scheglov@google.com >
2023-11-21 00:06:59 +00:00
Konstantin Shcheglov
42e5cc2377
Specify using unnecessary_breaks in the coding style.
...
Change-Id: Ibedb2fcd0ad5fdb6bfc3dcc4b88a02c9a9d78152
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/337282
Reviewed-by: Samuel Rawlins <srawlins@google.com >
Reviewed-by: Brian Wilkerson <brianwilkerson@google.com >
Commit-Queue: Konstantin Shcheglov <scheglov@google.com >
2023-11-20 21:36:17 +00:00
Sam Rawlins
283dad4ddc
analysis_server: Enforce single quotes preference
...
Change-Id: I553befc2c45e66bfc569004d810b4e0a958d4baa
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/325544
Commit-Queue: Samuel Rawlins <srawlins@google.com >
Reviewed-by: Konstantin Shcheglov <scheglov@google.com >
2023-09-13 17:48:22 +00:00
Jonas Finnemann Jensen
43c8d637bd
Refactor PubspecValidator
...
Unclear, if this was intentionally written as classes.
It just seemed confusing to me. Since the classes were essentially
functions that had some of their arguments passed in the constructor
and some of their arguments passed in a method call.
It also seemed impossible to reuse the actual objects.
Change-Id: I56b341ee4851d24b9d176857a53b96f7eb941335
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/317883
Commit-Queue: Jonas Jensen <jonasfj@google.com >
Reviewed-by: Phil Quitslund <pquitslund@google.com >
2023-08-16 12:31:30 +00:00
Sam Rawlins
05f2b3222a
[analyzer] Add extension-naming to our style doc
...
Change-Id: I454df164b2cede7c4ae7d6fdf541e67fdf7090da
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/316525
Reviewed-by: Konstantin Shcheglov <scheglov@google.com >
Reviewed-by: Brian Wilkerson <brianwilkerson@google.com >
Reviewed-by: Kallen Tu <kallentu@google.com >
Commit-Queue: Samuel Rawlins <srawlins@google.com >
2023-07-26 20:32:59 +00:00
Brian Wilkerson
06be97c607
Capture the agreed on style for import prefix names
...
Change-Id: I6eba4a7e37a72677c58d219892cd2e4c74560356
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/314220
Reviewed-by: Samuel Rawlins <srawlins@google.com >
Commit-Queue: Brian Wilkerson <brianwilkerson@google.com >
Reviewed-by: Konstantin Shcheglov <scheglov@google.com >
2023-07-18 04:09:58 +00:00
Brian Wilkerson
a2dbcf7a56
Initial coding style documentation
...
Change-Id: I1f29d10a0eff99a98e8e79500288f9766fcc9a64
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/308700
Reviewed-by: Samuel Rawlins <srawlins@google.com >
Reviewed-by: Konstantin Shcheglov <scheglov@google.com >
Commit-Queue: Brian Wilkerson <brianwilkerson@google.com >
Reviewed-by: Phil Quitslund <pquitslund@google.com >
2023-06-13 01:11:56 +00:00
Paul Berry
a83a1a4c55
Revert "Update comments and readmes to specify dart run --no-pub when necessary."
...
This reverts commit d2df7ce24a .
Reason for revert: https://dart-review.googlesource.com/c/sdk/+/291500 was reverted
Original change's description:
> Update comments and readmes to specify `dart run --no-pub` when necessary.
>
> Now that https://dart-review.googlesource.com/c/sdk/+/291500 has
> landed, `dart run` now tries to invoke `dart pub` before execution.
> This doesn't work when running scripts inside the SDK, because the SDK
> doesn't use pub to get its dependencies. So scripts in the SDK now
> need to be run with `--no-pub`.
>
> Change-Id: Ic320b717b2d45278cd26d373ae0823c2935ce102
> Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/292720
> Reviewed-by: Johnni Winther <johnniwinther@google.com >
Change-Id: I6c13510abde17f71694f362a8071c9c7fa519a88
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/302364
Commit-Queue: Paul Berry <paulberry@google.com >
Reviewed-by: Samuel Rawlins <srawlins@google.com >
Reviewed-by: Brian Wilkerson <brianwilkerson@google.com >
2023-05-09 20:38:49 +00:00
Paul Berry
d2df7ce24a
Update comments and readmes to specify dart run --no-pub when necessary.
...
Now that https://dart-review.googlesource.com/c/sdk/+/291500 has
landed, `dart run` now tries to invoke `dart pub` before execution.
This doesn't work when running scripts inside the SDK, because the SDK
doesn't use pub to get its dependencies. So scripts in the SDK now
need to be run with `--no-pub`.
Change-Id: Ic320b717b2d45278cd26d373ae0823c2935ce102
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/292720
Reviewed-by: Johnni Winther <johnniwinther@google.com >
2023-04-03 12:11:49 +00:00
pq
8041daf7b0
+ pubspec diagnostic doc
...
This doc lives internally (@ go/analyzer-pub-diagnostics) but Jonas suggested it might better serve in the analyzer docs, so here it is! :)
Change-Id: Iec50c263c6621fe15d05282cfcac2eafea5a420e
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/285884
Reviewed-by: Brian Wilkerson <brianwilkerson@google.com >
Commit-Queue: Phil Quitslund <pquitslund@google.com >
2023-02-28 02:45:08 +00:00
Kallen Tu
9c7662cd7d
[analyzer] Tweak analyzer documentation for easier reading.
...
Broke up some larger paragraphs for easier reading. Made some additional sections to call out actionable work (since it seemed hidden within the paragraphs themselves).
Added some missing hyphens.
Change-Id: Icd84f16a6a6ff95e96e0423c83d7dbaedf7302bc
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/279323
Commit-Queue: Kallen Tu <kallentu@google.com >
Reviewed-by: Brian Wilkerson <brianwilkerson@google.com >
2023-01-19 22:47:18 +00:00
Brian Wilkerson
98ea469c0d
Add information about how to write diagnostic documentation
...
I thought it would be good to capture some of the information we have
about how the documentation for the analyzer diagnostics are currently
written.
I'm mostly interested in making sure that the description is clear.
We can update this if there are changes we decide to make going forward.
Change-Id: I27c78ce04fb86d0263a1081d7c8f42c3ebfa7b0a
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/278534
Reviewed-by: Phil Quitslund <pquitslund@google.com >
Commit-Queue: Brian Wilkerson <brianwilkerson@google.com >
Reviewed-by: Marya Belanger <mbelanger@google.com >
2023-01-06 19:18:49 +00:00
Brian Wilkerson
53e3d2b5bc
Fix one failure on the windows bot
...
Change-Id: I885b5cff40d60631602912a7b5751b4abd728cab
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/261446
Commit-Queue: Brian Wilkerson <brianwilkerson@google.com >
Reviewed-by: Konstantin Shcheglov <scheglov@google.com >
2022-09-29 17:33:27 +00:00
Brian Wilkerson
798c57bef9
Capture some conventions around writing tests
...
Change-Id: Idf23690d944eddfbd575bcb608d6949c10e7d1f3
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/261442
Commit-Queue: Brian Wilkerson <brianwilkerson@google.com >
Reviewed-by: Samuel Rawlins <srawlins@google.com >
Reviewed-by: Konstantin Shcheglov <scheglov@google.com >
2022-09-27 19:07:45 +00:00
Brian Wilkerson
b9052f85d6
Add documentation on adding new AST nodes
...
Change-Id: I13d7e7298c4094c3b85de931034c2d09da95d883
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/258508
Reviewed-by: Samuel Rawlins <srawlins@google.com >
Commit-Queue: Brian Wilkerson <brianwilkerson@google.com >
2022-09-10 05:02:55 +00:00
Brian Wilkerson
00e9dc8644
Add documentation on adding new diagnostics
...
Change-Id: Ice38a93e009cc9c07638ddce96e8960d986fa3c1
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/258509
Reviewed-by: Konstantin Shcheglov <scheglov@google.com >
Commit-Queue: Brian Wilkerson <brianwilkerson@google.com >
2022-09-09 21:53:36 +00:00
Brian Wilkerson
2f3c69c361
Rename a subdirectory under doc to match what analysis_server has
...
Change-Id: Ibb4447511570a61b71a8c92cf6d7fe738d6054a6
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/256216
Reviewed-by: Konstantin Shcheglov <scheglov@google.com >
Commit-Queue: Brian Wilkerson <brianwilkerson@google.com >
2022-08-24 19:00:39 +00:00