unifmt 0.2.11

  • README.md
  • Installing
  • Versions
  • 46

unifmt

Pub Package

The universal code formatter for the MolView project. This program automatically formats all code in the current directory to match the style conventions. You can find out which conventions are used by looking at the source code of this tool. It will automatically alert you if you have to install a formatter on your system.

Getting started

Install

To install unifmt on your system, run:

pub global activate unifmt

Command line arguments

-h, --[no-]help

Displays usage information.

-v, --[no-]verbose

Output non-critical formatting messages.

-f, --[no-]force

Ignore errors in run-once mode (i.e. --no-watch).

-w, --[no-]watch

Watch current directory for changes and reformat them.

-e, --exclude

Exclude the given file globs.

Set copyright holder for license headers.

-l, --license

Set SPDX license ID for license headers.

Notes

Gitignore

unifmt parses the .gitignore file in the directory where it is executed and does not format files that are excluded in the .gitignore file. However, .gitignore files that are located in subdirectories are not parsed!

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  unifmt: "^0.2.11"

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter packages get

Alternatively, your editor might support pub get or packages get. Check the docs for your editor to learn more.

Version Uploaded Documentation Archive
0.2.11 Mar 13, 2017 Go to the documentation of unifmt 0.2.11 Download unifmt 0.2.11 archive
0.2.10 Mar 13, 2017 Go to the documentation of unifmt 0.2.10 Download unifmt 0.2.10 archive
0.2.9+2 Nov 3, 2016 Go to the documentation of unifmt 0.2.9+2 Download unifmt 0.2.9+2 archive
0.2.9+1 Oct 9, 2016 Go to the documentation of unifmt 0.2.9+1 Download unifmt 0.2.9+1 archive

Analysis

This feature is new.
We welcome feedback.
More details: scoring.

We analyzed this package, and provided a score, details, and suggestions below.

  • completed on Feb 3, 2018
  • Dart: 2.0.0-dev.20.0
  • pana: 0.10.1

Scores

Popularity:
Describes how popular the package is relative to other packages. [more]
0 / 100
Health:
Code health derived from static analysis. [more]
100 / 100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
80 / 100
Overall score:
Weighted score of the above. [more]
46

Platforms

Detected platforms: Flutter, web, other

No platform restriction found in libraries.

Suggestions

  • Maintain CHANGELOG.md.

    Changelog entries help clients to follow the progress in your code.

  • The description is too short.

    Add more detail about the package, what it does and what is its target use case. Try to write at least 60 characters.

  • Package is pre-v1 release.

    While there is nothing inherently wrong with versions of 0.*.*, it usually means that the author is still experimenting with the general direction API.

  • Maintain an example.

    Create a short demo in the example/ directory to show how to use this package. Common file name patterns include: main.dart, example.dart or you could also use unifmt.dart.

  • Use analysis_options.yaml.

    Rename old .analysis_options file to analysis_options.yaml.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=1.8.0 <2.0.0
args ^0.13.2 0.13.7 1.3.0
glob ^1.0.5 1.1.5
watcher ^0.9.7 0.9.7+7
which ^0.1.3 0.1.3
Transitive dependencies
async 2.0.3
charcode 1.1.1
collection 1.14.5
path 1.5.1
source_span 1.4.0
string_scanner 1.0.2
when 0.2.0