Merge `package:lints` #578

mosuem · 2024-10-18T10:13:23Z

Move and fix workflow files, labeler.yaml, and badges in the README.md
Rev the version of the package, so that pub.dev points to the correct site
Add a line to the changelog:

* Move to `dart-lang/core` monorepo.

Add the package to the top-level readme of the monorepo:

| [lints](pkgs/lints/) | Official Dart lint rules. Defines the 'core' and 'recommended' set of lints suggested by the Dart team.
 | [![pub package](https://img.shields.io/pub/v/lints.svg)](https://pub.dev/packages/lints) |

Important! Merge the PR with 'Create a merge commit' (enabling then disabling the Allow merge commits admin setting)
Add the lints project to this repo
Update the auto-publishing settings on https://pub.dev/packages/lints/admin
Add the following text to https://github.com/dart-lang/lints/:'

> [!IMPORTANT]  
> This repo has moved to https://github.com/dart-lang/core/tree/main/pkgs/lints

Publish using the autopublish workflow
Push tags to GitHub using git tag --list 'lints*' | xargs git push origin
Close open PRs in dart-lang/lints with the following message:

Closing as the [dart-lang/lints](https://github.com/dart-lang/lints) repository is merged into the [dart-lang/core](https://github.com/dart-lang/core) monorepo. Please re-open this PR there!

Transfer issues by running dart run pkgs/repo_manage/bin/report.dart transfer-issues --source-repo dart-lang/lints --target-repo dart-lang/core --add-label package:lints --apply-changes
Archive https://github.com/dart-lang/lints/

I’ve reviewed the contributor guide and applied the relevant portions to this PR.

Contribution guidelines:

See our contributor guide for general expectations for PRs.
Larger or significant changes should be discussed in an issue before creating a PR.
Contributions to our repos should follow the Dart style guide and use dart format.
Most changes should add an entry to the changelog and may need to rev the pubspec package version.
Changes to packages require corresponding tests.

Note that many Dart repos have a weekly cadence for reviewing PRs - please allow for some latency before initial review feedback.

* simple package validation * => dart extensions * check for dirs * lib check

* initial rulesets * + include

* move build badge * re-order

Update the Github Actions link to filter to `main` branch

* dev version * drop Flutter refs

* + entries * bump version

Update README.md

* + example * publish_to: none * docs

* add feedback notes * typo

…lang/lints#46) * Tweak the README a bit and add a section on evolution process. * Fix typo. * "pre-defined" -> "predefined".

* + issue templates * + lint proposal * + linter issue link outs * + flutter callout * drop flutter link

For people migrating from `pedantic`, point them to the new `unawaited` in `dart_async`.

Bumps [actions/checkout](https://github.com/actions/checkout) from 3.0.2 to 3.1.0. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](actions/checkout@2541b12...93ea575) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [actions/checkout](https://github.com/actions/checkout) from 3.1.0 to 3.2.0. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](actions/checkout@93ea575...755da8c) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [actions/checkout](https://github.com/actions/checkout) from 3.2.0 to 3.3.0. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](actions/checkout@755da8c...ac59398) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [dart-lang/setup-dart](https://github.com/dart-lang/setup-dart) from 1.6.4 to 1.6.5. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/dart-lang/setup-dart/releases">dart-lang/setup-dart's releases</a>.</em></p> <blockquote> <h2>v1.6.5</h2> <ul> <li>Fix zip path handling on Windows 11 (<a href="https://redirect.github.com/dart-lang/setup-dart/issues/118">dart-lang/lints#118</a>[])</li> </ul> <p><a href="https://redirect.github.com/dart-lang/setup-dart/issues/118">dart-lang/lints#118</a>: <a href="https://redirect.github.com/dart-lang/setup-dart/issues/118">dart-lang/setup-dartdart-lang/lints#118</a></p> </blockquote> </details> <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/dart-lang/setup-dart/blob/main/CHANGELOG.md">dart-lang/setup-dart's changelog</a>.</em></p> <blockquote> <h2>v1.6.5</h2> <ul> <li>Fix zip path handling on Windows 11 (<a href="https://redirect.github.com/dart-lang/setup-dart/issues/118">dart-lang/lints#118</a>[])</li> </ul> <p><a href="https://redirect.github.com/dart-lang/setup-dart/issues/118">dart-lang/lints#118</a>: <a href="https://redirect.github.com/dart-lang/setup-dart/issues/118">dart-lang/setup-dartdart-lang/lints#118</a></p> <h2>v1.6.4</h2> <ul> <li>Rebuild JS code.</li> </ul> <h2>v1.6.3</h2> <ul> <li>Roll <code>undici</code> dependency to address <a href="https://github.com/nodejs/undici/security/advisories/GHSA-m4v8-wqvr-p9f7">CVE-2024-30260</a> and <a href="https://github.com/nodejs/undici/security/advisories/GHSA-9qxr-qj54-h672">CVE-2024-30261</a>.</li> </ul> <h2>v1.6.2</h2> <ul> <li>Switch to running the workflow on <code>node20`` from </code>node16`. See also <a href="https://github.blog/changelog/2023-09-22-github-actions-transitioning-from-node-16-to-node-20/">Transitioning from Node 16 to Node 20</a>.</li> </ul> <h2>v1.6.1</h2> <ul> <li>Updated the google storage url for <code>main</code> channel releases.</li> </ul> <h2>v1.6.0</h2> <ul> <li>Enable provisioning of the latest Dart SDK patch release by specifying just the major and minor version (e.g. <code>3.2</code>).</li> </ul> <h2>v1.5.1</h2> <ul> <li>No longer test the <code>setup-dart</code> action on pre-2.12 SDKs.</li> <li>Upgrade JS interop code to use extension types (the new name for inline classes).</li> <li>The upcoming rename of the <code>be</code> channel to <code>main</code> is now supported with forward compatibility that switches when the rename happens.</li> </ul> <h2>v1.5.0</h2> <ul> <li>Re-wrote the implementation of the action into Dart.</li> <li>Auto-detect the platform architecture (<code>x64</code>, <code>ia32</code>, <code>arm</code>, <code>arm64</code>).</li> <li>Improved the caching and download resilience of the sdk.</li> <li>Added a new action output: <code>dart-version</code> - the installed version of the sdk.</li> </ul> <h2>v1.4.0</h2> </blockquote> <p>... (truncated)</p> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/dart-lang/setup-dart/commit/0a8a0fc875eb934c15d08629302413c671d3f672"><code>0a8a0fc</code></a> rev to v1.6.5 in prep for publishing (<a href="https://redirect.github.com/dart-lang/setup-dart/issues/135">dart-lang/lints#135</a>)</li> <li><a href="https://github.com/dart-lang/setup-dart/commit/4e61f04f255b227a0511bf9ef0f5ddc7c8542531"><code>4e61f04</code></a> fix: Use <code>.zip</code> in archive path (<a href="https://redirect.github.com/dart-lang/setup-dart/issues/119">dart-lang/lints#119</a>)</li> <li><a href="https://github.com/dart-lang/setup-dart/commit/2986c8e337a31eb7b455ce93dc984e9bf5797756"><code>2986c8e</code></a> blast_repo fixes (<a href="https://redirect.github.com/dart-lang/setup-dart/issues/132">dart-lang/lints#132</a>)</li> <li><a href="https://github.com/dart-lang/setup-dart/commit/40a7d12289757ab3aaa39d47d6f99a9cb1dd701e"><code>40a7d12</code></a> Bump dart-lang/setup-dart from 1.6.2 to 1.6.4 (<a href="https://redirect.github.com/dart-lang/setup-dart/issues/131">dart-lang/lints#131</a>)</li> <li><a href="https://github.com/dart-lang/setup-dart/commit/40f1ce0b1c8f24a4e9cb7eb026e4dbbdb431eb76"><code>40f1ce0</code></a> Update dart.yml (<a href="https://redirect.github.com/dart-lang/setup-dart/issues/130">dart-lang/lints#130</a>)</li> <li>See full diff in <a href="https://github.com/dart-lang/setup-dart/compare/f0ead981b4d9a35b37f30d36160575d60931ec30...0a8a0fc875eb934c15d08629302413c671d3f672">compare view</a></li> </ul> </details> <br /> [![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=dart-lang/setup-dart&package-manager=github_actions&previous-version=1.6.4&new-version=1.6.5)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details>

* add unnecessary_library_name to recommended * update the workflow config * link to the lint's docs

…nt set (dart-lang/lints#199)

…-lang/lints#201)

* Fixes formatting error in the rules.md table The content after the rule `invalid_runtime_check_with_js_interop_types` was not formatted in a table due to syntax error * Fix multiline descriptions formatting in markdown generation - Updated the `_createRuleTableRow` function to properly handle multiline descriptions by replacing line breaks with spaces - Trimmed leading/trailing whitespace and reduced consecutive spaces to a single space - This ensures that the generated markdown table rows in rules.md are correctly formatted, preventing description content from breaking across lines or having inconsistent spacing

* add unintended_html_in_doc_comment; rev to 5.1.0 * use 3.6 beta

github-actions · 2024-10-18T10:14:42Z

PR Health

Changelog Entry ✔️

Package	Changed Files

Changes to files need to be accounted for in their respective changelogs.

Coverage ✔️

File	Coverage

This check for test coverage is informational (issues shown here will not fail the PR).

API leaks ✔️

The following packages contain symbols visible in the public API, but not exported by the library. Export these symbols or remove them from your publicly visible API.

Package	Leaked API symbols

License Headers ✔️

// Copyright (c) 2024, the Dart project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.

Files
no missing headers

All source files should start with a license header.

mosuem · 2024-10-18T12:16:35Z

Should this package not be auto-published? @devoncarew

devoncarew · 2024-10-18T17:55:57Z

Should this package not be auto-published? @devoncarew

I think it's fine to auto-publish. We will want to upgrade our publishing automation a bit; with many packages living in a repo, we'll want to have some precision about which commits we publish from (i.e., not just the head commit). I'll open an issue for that.

devoncarew

lgtm; note a few in-line edits and a file rename

.github/ISSUE_TEMPLATE/lint-propoposal.md

mosuem · 2024-10-21T07:42:05Z

I think it's fine to auto-publish. We will want to upgrade our publishing automation a bit; with many packages living in a repo, we'll want to have some precision about which commits we publish from (i.e., not just the head commit). I'll open an issue for that.

I am asking because the publish workflow is failing because of the dependency on a pre-release SDK version, and I don't know how SDK versioning is handled with package:lints.

Co-authored-by: Devon Carew <[email protected]>

devoncarew · 2024-10-21T16:00:46Z

I am asking because the publish workflow is failing because of the dependency on a pre-release SDK version, and I don't know how SDK versioning is handled with package:lints.

Ah, I see;

Package validation found the following potential issue:
Packages with an SDK constraint on a pre-release of the Dart SDK should themselves be published as a pre-release version. If this package needs Dart version 3.6.0-0, consider publishing the package as a pre-release instead.

And once this package is in a monorepo, every PR will need to apply a label to ignore failures from the publishing bot. That's a bit annoying.

We could either solve that - allow per-package configuration of publishing validation - or delay adding this package to the monorepo until after the next stable sdk release. We don't typically need to depend on a pre-release sdk for package:lints.

mit-mit and others added 30 commits April 26, 2021 10:43

Create LICENSE

92e021c

simple package validation (dart-lang/lints#3)

cd1348c

* simple package validation * => dart extensions * check for dirs * lib check

Add initial files (dart-lang/lints#1)

7c619d0

add build badge (dart-lang/lints#6)

a9ab173

Add pub badge to readme (dart-lang/lints#7)

ebead69

add initial rulesets (dart-lang/lints#4)

2917260

* initial rulesets * + include

move build badge (dart-lang/lints#8)

b1ec4f0

* move build badge * re-order

rename (dart-lang/lints#11)

76ddfb4

Update README.md (dart-lang/lints#13)

9598133

Update the Github Actions link to filter to `main` branch

bump to dev version (dart-lang/lints#14)

9ce04cf

* dev version * drop Flutter refs

Update README.md (dart-lang/lints#18)

735b895

Prep for publishing (dart-lang/lints#22)

fa62baa

add instruction to call pub get (dart-lang/lints#21)

1d31156

add pubspec entries tagged missing by pana (dart-lang/lints#31)

133e80e

* + entries * bump version

Update README.md (dart-lang/lints#33)

2113ad3

+ 1.0.1 (dart-lang/lints#34)

a24bdb2

Update README.md (dart-lang/lints#27)

4fee86b

Update README.md

+ example (dart-lang/lints#36)

d33a960

* + example * publish_to: none * docs

add feedback notes (dart-lang/lints#43)

b836ad5

* add feedback notes * typo

Add notes regarding migrating from pedantic (dart-lang/lints#41)

b165f7f

Tweak the README a bit and add a section on evolution process. (dart-…

1c8b030

…lang/lints#46) * Tweak the README a bit and add a section on evolution process. * Fix typo. * "pre-defined" -> "predefined".

+ issue templates (dart-lang/lints#49)

e93106e

* + issue templates * + lint proposal * + linter issue link outs * + flutter callout * drop flutter link

Update README.md (dart-lang/lints#52)

9619bfe

Mention dart:async unawaited (dart-lang/lints#53)

bd10aba

For people migrating from `pedantic`, point them to the new `unawaited` in `dart_async`.

Update validate.yml

ec576f0

Add lints for v2.0 (dart-lang/lints#72)

4bc3e26

update lint files docs (dart-lang/lints#88)

69eb537

dependabot bot and others added 12 commits June 1, 2024 10:52

add unnecessary_library_name to recommended (dart-lang/lints#198)

37cbcc2

* add unnecessary_library_name to recommended * update the workflow config * link to the lint's docs

add invalid_runtime_check_with_js_interop_types to the recommended li…

d82f9c3

…nt set (dart-lang/lints#199)

Remove avoid_null_checks_in_equality_operators from recommended (dart…

1940026

…-lang/lints#201)

rev to 5.0.0 in preparation for publishing (dart-lang/lints#210)

532cbe4

add unintended_html_in_doc_comment; rev to 5.1.0 (dart-lang/lints#211)

7f2bf15

* add unintended_html_in_doc_comment; rev to 5.1.0 * use 3.6 beta

Merge package:lints into the core monorepo

09bd977

Add issue template and other fixes

a53c185

Moving fixes

b0d8ad5

mosuem requested a review from devoncarew October 18, 2024 10:16

mosuem added the skip-breaking-check label Oct 18, 2024

mosuem added 3 commits October 18, 2024 12:49

Ignore coverage for lints

71a815b

Use dev sdk

924ddb1

Use dev SDK for publishing

3b8d652

mosuem changed the title ~~Merge lints package~~ Merge package:lints Oct 18, 2024

mosuem mentioned this pull request Oct 18, 2024

Update README.md before archiving dart-lang/lints#214

Merged

1 task

devoncarew approved these changes Oct 18, 2024

View reviewed changes

mosuem and others added 4 commits October 21, 2024 09:45

Update .github/ISSUE_TEMPLATE/lint-propoposal.md

08eecb6

Co-authored-by: Devon Carew <[email protected]>

Update .github/ISSUE_TEMPLATE/lint-propoposal.md

864c863

Co-authored-by: Devon Carew <[email protected]>

Update .github/ISSUE_TEMPLATE/lint-propoposal.md

50510b0

Co-authored-by: Devon Carew <[email protected]>

Rename issue tempalte

f961213

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Merge `package:lints` #578

Merge `package:lints` #578

mosuem commented Oct 18, 2024 •

edited

Loading

github-actions bot commented Oct 18, 2024 •

edited

Loading

mosuem commented Oct 18, 2024

devoncarew commented Oct 18, 2024

devoncarew left a comment

mosuem commented Oct 21, 2024

devoncarew commented Oct 21, 2024

Merge package:lints #578

Are you sure you want to change the base?

Merge package:lints #578

Conversation

mosuem commented Oct 18, 2024 • edited Loading

github-actions bot commented Oct 18, 2024 • edited Loading

PR Health

mosuem commented Oct 18, 2024

devoncarew commented Oct 18, 2024

devoncarew left a comment

Choose a reason for hiding this comment

mosuem commented Oct 21, 2024

devoncarew commented Oct 21, 2024

Merge `package:lints` #578

Merge `package:lints` #578

mosuem commented Oct 18, 2024 •

edited

Loading

github-actions bot commented Oct 18, 2024 •

edited

Loading