yumemi-inc / flutter-yumemi-lints Goto Github PK

Use review-assign-action action and GitHub Actions variables.

FYI:

• https://docs.github.com/actions/learn-github-actions/variables#using-the-vars-context-to-access-configuration-variable-values
• https://github.com/GitHubSecurityLab/actions-permissions

Unnecessary items:

• analysis_options.yaml
• lib/src/yumemi_lints_base.dart
• lib/yumemi_lints.dart
• example/yumemi_lints_example.dart

FYI:

• https://github.com/dart-lang/lints

Describe

• No need to align the Dart version for 'yumemi_lints' as it's not feasible
• Manage the 'tools' directory using 'melos'
• Utilize DVM for managing Dart versions

Screenshots

N/A

Environment

• Commit SHA: c0045ee

Additional context

No response

Describe

analyzer:
  errors:
    invalid_use_of_visible_for_testing_member: error

https://dart.dev/tools/diagnostic-messages#invalid_use_of_visible_for_testing_member

Screenshots

N/A

Environment

• Commit SHA: 649b386

Additional context

No response

Describe

Conflict between main branch and release/2.0.0 branch, submit a pull request to resolve the conflict.

Screenshots

N/A

Environment

• Commit SHA: e22c4fe

Additional context

No response

Describe

• Document the steps, precautions, and reference links for enabling GitHub Copilot in docs/COPILOT.md.
• Add activation settings for VS Code.

Screenshots

N/A

Environment

• Commit SHA: 649b386

Additional context

yumemi-inc/flutter-mobile-project-template#103

https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository

https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository

Describe

The following warning was issued in the GitHub Actions workflow:

https://github.com/yumemi-inc/flutter-yumemi-lints/actions/runs/7749596165/job/21134434497

Warning: Input 'app_id' has been deprecated with message: 'app_id' is deprecated and will be removed in a future version. Use 'app-id' instead.
Warning: Input 'private_key' has been deprecated with message: 'private_key' is deprecated and will be removed in a future version. Use 'private-key' instead.

Screenshots

N/A

Environment

• Commit SHA: 649b386

Additional context

No response

Describe

To enhance code quality and maintainability, I propose defining a set of recommended warning levels for Lint rules as per Yumemi's best practices. This initiative aims to standardize the warning levels across our projects, ensuring that all developers adhere to the same quality checks and coding standards. Implementing these levels will help in identifying potential code issues more effectively.

Screenshots

N/A

Environment

• Commit SHA: f637db3

Additional context

This improvement will not only streamline our code review processes but also decrease the learning curve for new team members by providing them with a clear set of coding guidelines. Additional discussions and inputs from the team to refine these warning levels would be appreciated.

https://www.notion.so/yumemi/Lint-6888ae0f29184da7b8691e6930107285

https://github.com/BobAnkh/add-contributors

Describe

The lint rule use_setters_to_change_properties feels cumbersome because it issues warnings even when creating methods for simple state updates in Riverpod's Notifiers.

Screenshots

N/A

Environment

• Commit SHA: 649b386

Additional context

No response

Is your feature request related to a problem? Please describe

When updating the Dart/Flutter SDK version for the project, it would be more appropriate to also update the lint rules used, but currently, they have to be updated manually, which is somewhat costly.

Describe the solution you'd like

#...

environment:
  sdk: ^3.1.0

include: package:yumemi_lints/dart/2.17.0/recommended.yaml

↓

dart run yumemi_lints update

↓

include: package:yumemi_lints/dart/3.1.0/recommended.yaml

Describe alternatives you've considered

No response

Additional context

No response

Describe

Conflict between main branch and release/2.0.0 branch, submit a pull request to resolve the conflict.

Screenshots

N/A

Environment

• Commit SHA: 3e6b2f5

Additional context

N/A

Describe the bug

As the title suggests.

To Reproduce

1. Introducing yumemi_lints
   • yumemi_lints: v2.0.0
   • project flutter version: v3.22.0
2. Run dart run yumemi_lints update
   • lint version is 3.22 but does not exist

Expected behavior

1. If the corresponding lint version does not exist, tell the user in a console message.
2. Let the user choose whether to apply the previous supported version.
   • If yes, update the lint version.
   • If not, do nothing.

Environment

• yumemi lints version: v2.0.0
• Flutter Version: v3.22.0

Additional context

No response

It seems appropriate to schedule for every Friday morning since Dart is released every Wednesday and Flutter every Thursday.

• https://dart.dev/get-dart/archive
• https://docs.flutter.dev/release/archive

https://docs.github.com/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors

Simplified version of github/docs

Is your feature request related to a problem? Please describe

After a pull request updating the package version is merged, the tag must be pushed manually.

Describe the solution you'd like

Since it's cumbersome to push tags manually, set up a GitHub Actions workflow to run automatically when a pull request that updates the package version is merged.

Describe alternatives you've considered

No response

Additional context

No response

Run a GitHub Actions workflow everyday.
Watch for updates to Flutter/Dart lint rules and create pull requests when updates are made.

※ Call and update the CLI tool created in issue #6 .

Tasks

• Create a empty workflow for updating lint rules
  • #18
• Implement a workflow for updating lint rules
  • #29

Additional items:

• pubspec.yaml
• pubspec.lock
• main.dart
• analysis_options.yaml
• .gitignore

FYI:

• https://github.com/dart-lang/lints/tree/main/example
• https://github.com/mono0926/pedantic_mono/tree/main/example

Update as follows:

• description
  • Customizable Linter library which enforces coding standards and best practice for Flutter/Dart apps, packages and plugins.
• repository
  • https://github.com/yumemi-inc/flutter-yumemi-lints
• environment
  • sdk: '>=2.17.0 <4.0.0'
• dependencies, dev_dependencies
  • (empty)
• topics
  • lint
  • lints
  • linter
  • analysis
  • code-style

FYI:

• https://dart.dev/tools/pub/pubspec

Describe

analyzer:
  errors:
    implementation_imports: error

https://dart.dev/tools/linter-rules/implementation_imports

Screenshots

N/A

Additional context

No response

Create lint rules for each Flutter/Dart version

• dart
  • 2.17.0
    • all.yaml
  • 2.17.1
    • …
• flutter
  • 3.0.0
    • all.yaml
  • 3.0.1
    • …

NOTE:

• Dart version 2.17.0 or higher is required.
• Flutter version 3.0.0 or higher is required.
• YUMEMI Inc. recommended lint rules will be addressed in another Issue.

Tasks

• Create a base cli project update_lint_rules
  • #19
• Implement a process to get all lint rules
  • #20
• Implement a process to extract lint rules for Flutter and Dart
  • #21
• Implement a process to get stable release info of Dart SDK
  • #22
• Implement a process to get stable release info of Flutter SDK
  • #23
• Implement a process to output Dart or Flutter all lint rules to a file
  • #24
• Address a 'duplicate_ignore' warning
  • #25
• Modify the method of determining whether it is a Lint rule for Flutter
  • #26
• Update README of the update_lint_rules package
  • #27

Configure only updates for Dependabot's GitHub Actions.

FYI:

• https://docs.github.com/ja/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates
• https://docs.github.com/ja/code-security/dependabot/dependabot-version-updates/customizing-dependency-updates
• https://docs.github.com/ja/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#github-actions

Incorporate the automatic generation of lint rules (recommended.yaml) recommended by YUMEMI Inc. into the update_lint_rules package.

Create recommended.yaml in a format that disables unnecessary lint rules by specifying include all.yaml in the file.

FYI:
https://github.com/FlutterKaigi/2023/blob/main/analysis_options.yaml

※ Beforehand, YUMEMI Inc. team members should decide which lint rules to disable.

Describe

This issue focuses on the need for a robust mechanism within our system that can flexibly handle and absorb flaws originating from our automated generation source. Currently, our automated processes rely on this source for critical data, but it is prone to occasional inaccuracies and inconsistencies. These flaws can lead to errors in our final output, affecting the overall quality and reliability of our products or services. The proposed mechanism should be capable of identifying these flaws early in the process, possibly through advanced monitoring and error-detection algorithms. Once detected, the system should have the ability to either correct these errors or adapt its output to mitigate the impact of these flaws. The goal is to create a more resilient and reliable automated process, which maintains high-quality output even in the presence of source data imperfections.

Screenshots

No response

Environment

• Package Version: 1.1.0
• Commit SHA: fe97203

Additional context

dart-lang/sdk#53852

Set IGNORED_CONTRIBUTORS
https://github.com/BobAnkh/add-contributors

Ignore:

• GitHub Web Flow
  • https://github.com/web-flow

Example:

• https://github.com/benbarth/hacktoberfest-swag/blob/1339bd79dc2716cc0052a53f800f60c7a04899bf/.github/workflows/UpdateReadme.yml#L109

BSD-3-Clause

FYI:

• https://dart.dev/tools/pub/publishing
• https://dart.dev/tools/pub/automated-publishing

Describe

I'm looking to create a GitHub Workflow that automatically approves pull requests (PRs) when they contain LintRules identical to the previous version. Specifically, when a PR auto-generates files like dart/3.1.0/all.yaml and dart/3.2.0/all.yaml, it should be automatically approved if its contents match those of the immediately preceding version, in this case, dart/3.0.7/all.yaml. This would significantly streamline our update process, ensuring that identical lint rules across versions do not require manual approval. The details of which user will handle the approvals will be determined separately.

Screenshots

N/A

Environment

• Commit SHA: fb110b3

Additional context

No response

• Add CONTRIBUTING.md link
• Add Contributors section

Describe the bug

There seems to be an issue where Flutter-specific lint rules are mistakenly included in the Dart lint configuration. This could potentially mislead or cause errors for Dart-only projects. The specific rules identified so far include use_colored_box and use_decorated_box. There might be additional Flutter-specific rules that need to be evaluated and possibly removed or correctly categorized.

Screenshots

N/A

To Reproduce

1. Open the Dart project lint configuration file.
2. Observe the inclusion of use_colored_box and use_decorated_box.
3. These rules should not be applicable to pure Dart projects as they are specific to Flutter.

Expected behavior

The Dart lint configuration should not include Flutter-specific lint rules unless explicitly intended for a Flutter project. Correcting this will avoid confusion and potential misuse in Dart-only environments.

Environment

• Commit SHA: f637db3

Additional context

No response

Describe

lib
├── dart
│   ├── 2.17.0
│   ├── 2.17.1
│   ├── 2.17.3
│   ├── 2.17.5
│   ├── ...
│   ├── 2.18.0
│   ├── 2.18.1
│   ├── 2.18.2
│   ├── 2.18.3
│   ├── ...
└── flutter
    ├── 3.0.0
    ├── 3.0.1
    ├── 3.0.2
    ├── 3.0.3
    ├── ...
    ├── 3.3.0
    ├── 3.3.1
    ├── 3.3.2
    ├── 3.3.3
    ├── ...

↓

lib
├── dart
│   ├── 2.17
│   ├── 2.18
│   ├── ...
└── flutter
    ├── 3.0
    ├── 3.3
    ├── ...

Modifications to the check_lint_rules_identity are also necessary.

Screenshots

N/A

Environment

• Commit SHA: 649b386

Additional context

No response