Skip to content
This repository has been archived by the owner on Sep 26, 2024. It is now read-only.

Consider renaming main library file for consistency #1

Closed
Aqudi opened this issue Mar 12, 2024 · 1 comment
Closed

Consider renaming main library file for consistency #1

Aqudi opened this issue Mar 12, 2024 · 1 comment
Assignees
Labels
convention Need to follow code guidelines

Comments

@Aqudi
Copy link

Aqudi commented Mar 12, 2024

Hey there! 👋

The Dart document (https://dart.dev/guides/libraries/create-library-packages) recommends that the main library file for a package should be named lib/<package-name>.dart. However, the current entry point file for the lottie-thorvg package is named lottiel.dart, which deviates from the recommended naming convention.

For consistency with the guidelines and better discoverability, it might be worth considering renaming the lottiel.dart file to lottie-thorvg.dart.

Thank you!

@Aqudi Aqudi changed the title Consider renaming entry point file for consistency Consider renaming main library file for consistency Mar 12, 2024
@tinyjin tinyjin added the convention Need to follow code guidelines label Mar 14, 2024
@tinyjin
Copy link
Owner

tinyjin commented Mar 14, 2024

@Aqudi Thanks for reaching out to the project.

The purpose of the naming was to align the import statement with lottie-flutter as much as possible.

However, I have overlooked the proper package standard. I fully agree with the guidelines and will ensure that this is corrected in next release. The import statement will be import 'package:lottie_thorvg/lottie_thorvg.dart';

Thank you.

@tinyjin tinyjin self-assigned this Mar 17, 2024
tinyjin added a commit that referenced this issue Mar 17, 2024
@tinyjin tinyjin closed this as completed Mar 17, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
convention Need to follow code guidelines
Projects
None yet
Development

No branches or pull requests

2 participants