unifmt 0.2.12

  • README.md
  • Installing
  • Versions
  • 39

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!

Use this package as an executable

1. Install it

You can install the package from the command line:


$ pub global activate unifmt

2. Use it

The package has the following executables:


$ unifmt
Version Uploaded Documentation Archive
0.2.12 Aug 13, 2018 Go to the documentation of unifmt 0.2.12 Download unifmt 0.2.12 archive
0.2.11+3 Jun 29, 2018 Go to the documentation of unifmt 0.2.11+3 Download unifmt 0.2.11+3 archive
0.2.11+2 Jun 29, 2018 Go to the documentation of unifmt 0.2.11+2 Download unifmt 0.2.11+2 archive
0.2.11+1 Jun 29, 2018 Go to the documentation of unifmt 0.2.11+1 Download unifmt 0.2.11+1 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
Popularity:
Describes how popular the package is relative to other packages. [more]
0
Health:
Code health derived from static analysis. [more]
98
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
50
Overall:
Weighted score of the above. [more]
39
Learn more about scoring.

We analyzed this package on Feb 14, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.1.0
  • pana: 0.12.13

Platforms

Detected platforms: Flutter, web, other

No platform restriction found in libraries.

Health suggestions

Fix bin/src/formatter.dart. (-2.48 points)

Analysis of bin/src/formatter.dart reported 5 hints:

line 100 col 31: Use = to separate a named parameter from its default value.

line 101 col 35: Use = to separate a named parameter from its default value.

line 102 col 29: Use = to separate a named parameter from its default value.

line 103 col 29: Use = to separate a named parameter from its default value.

line 104 col 27: Use = to separate a named parameter from its default value.

Maintenance issues and suggestions

Provide a file named CHANGELOG.md. (-20 points)

Changelog entries help developers follow the progress of your package. See the example generated by stagehand.

The package description is too short. (-20 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.

Maintain an example. (-10 points)

Create a short demo in the example/ directory to show how to use this package.

Common filename patterns include main.dart, example.dart, and unifmt.dart. Packages with multiple examples should provide example/README.md.

For more information see the pub package layout conventions.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0-dev <3.0.0
args ^1.5.0 1.5.1
glob ^1.1.7 1.1.7
watcher ^0.9.7+10 0.9.7+10
Transitive dependencies
async 2.0.8
charcode 1.1.2
collection 1.14.11
meta 1.1.7
path 1.6.2
source_span 1.5.4
string_scanner 1.0.4
term_glyph 1.1.0