Linesman

Linesman helps you enforce boundaries between different parts of your codebase by providing a way to define and validate valid imports between modules, components, or any other logical units in your Dart application.

Install

Linesman is currently only available as a (custom_lint)https://pub.dev/packages/custom_lint plugin. To use it, follow the instructions for that package, then add you rules to analysis_options.yaml, e.g:

custom_lint:
  rules:
    - linesman_lint:
      allowByDefault: false
      rules:
        - type: allow
          source: test.dart
          target: some_file.dart
        - type: deny
          source: test.dart
          target: some_other_file.dart
        - type: deny
          source: test.dart
          target: package:some_package/some_other_file.dart

Usage

The allowed imports in your code are defined by a list of rules set in your config in analysis_options.yaml.

There are two types of rules:

• allow: Allows imports of files that match the target glob into files that match the source glob.
• deny: Denies imports of files that match the target glob into files that match the source glob.

Matching is performed using the glob package, which means you can use wildcards and other glob patterns to specify your source and target files.

Globs can be specified with a package:<package_name>/ prefix to match files in a specific package. If no such prefix is present, the glob will only match files in the current package.

The ordering of rules matters. Subsequent rules will override previous ones if they match the same source and target.

If no rules are defined, or if a particular rule is not defined, the default behavior is defined by the allowByDefault setting, which itself defaults to true.

Contributing

PRs accepted.

License

Apache 2.0 © Thomas Järvstrand