Try to be as concise as possible and, if it’s the case, include some code examples too. yaml file (see an example here)įully document your public API using triple slashes. Make sure to set up as many rules as possible in your analysis_options. I really encourage you to keep in mind these suggestions while writing your package: Write your code inside lib/ src and write tests inside the test/ folder. Import 'package:equations/equations.dart' … you can just import a single file and all of the other files will be automatically imported too! 1 Import 'package:equations/src/algebraic/types/quartic.dart' Import 'package:equations/src/algebraic/types/quadratic.dart'
Import 'package:equations/src/algebraic/types/cubic.dart' In practice, thanks to this approach, rather than importing multiple files… 1 This is like a “collector”: it grabs and exposes your sources altogether so that when it’s time to use the library, it can simply be referenced using a single import statement. dart: 1Įxport 'src/algebraic/types/constant.dart' Įxport 'src/algebraic/types/laguerre.dart' Įxport 'src/algebraic/types/linear.dart' Įxport 'src/algebraic/types/quadratic.dart' Įxport 'src/algebraic/types/quartic.dart' This makes sure that our library usage will only require a single import statement. The entire source code of the package lies inside the src folder: the only Dart file in there has the same name as the package and it only exports the public API. Here’s what you can find inside the lib/ folder for the equations package: When creating packages there are a few guidelines recommended by the official documentation and you should really follow those.
Creating the packageĪs you may guess, throwing the entire code inside a single. This command will prepare the equations package with all of the files and directories you need (including lib and pubspec. $ flutter create-template = package equations Instead of manually creating all the required files by hand, the Flutter command line tools can create a template for us. Of course it’s not enough for production because we also need to take care of testing, versioning, and licensing. That’s really all you need to create a simple package. yaml file: it describes various aspects of the package such as the name, the version, the dependencies, supported platforms, and so on. Lib/ directory: it contains the Dart source code If you want to create the simplest package ever you should at least make sure to have the following content in your folder: If you want to see an example of what we’re talking about here, take a look at the equations package. Are you looking for something not yet uploaded at pub.dev? Be the first one to publish it! It’s a big public repository where you can find packages for any platform (web, mobile, or desktop). Welcome to a new article about the Dart and Flutter universe! As you may already know, many developers around the world can contribute to Flutter’s growth by writing packages and publishing them at.
0 kommentar(er)
