change 0.0.4

  • Readme
  • Changelog
  • Example
  • Installing
  • 48

change #

Changelog manipulation tool written in Dart.

Features #

  • Supports basic features of Markdown such as bold, italic, links, etc.
  • Automatic diff links generation.

Limitations #

  • Works with changelogs following keepachangelog format only.
  • Complex Markdown (e.g. inline HTML) will probably not work.

Installation #

pub global install change

Usage #

Adding entries to Unreleased section #

To add a change entry to the Unreleased section, run the following command change <type> <entry>.

  • <type> is one of the following: added, changed, deprecated, removed, fixed, security.
  • <entry> is an arbitrary line of markdown.

Example

By running these commands

change added "New *cool* feature"
change changed "Renamed foo to [bar](https://example.com/bar)"

you create two entries in the CHANGELOG:

## Unreleased
### Added
- New *cool* feature
### Changed
- Renamed foo to [bar](https://example.com/bar)

Releasing unreleased changes #

To release all unreleased changes under a new version, run

change release <version> -l <diff_link> -d <date>
  • <version> is the version for the new release.
  • optional <date is the release date. Default is today.
  • optional <diff_link> is the diff link template.

Example

CHANGELOG before:

## Unreleased
### Added
- New *cool* feature

### Changed
- Renamed foo to [bar](https://example.com/bar)

release command:

change release 0.1.0 -l "https://github.com/example/project/compare/%from%...%to%" -d "2020-06-07"

CHANGELOG after:

## Unreleased
## [0.1.0] - 
### Added
- New *cool* feature

### Changed
- Renamed foo to [bar](https://example.com/bar)

[Unreleased]: https://github.com/example/project/compare/0.1.0...HEAD

Changelog #

This project follows Semantic Versioning 2.0.0.

Unreleased #

0.0.4 - 2020-06-24 #

Added #

  • Support for multiple major versions in a single file

0.0.3 - 2020-06-23 #

Added #

  • Console app
  • Changelog model

Changed #

  • BREAKING Total rework of the package

0.0.2 - 2018-10-18 #

Added #

  • Changelog.writeFile()

0.0.1 - 2018-10-18 #

Added #

  • Parsing from markdown
  • Writing to markdown

example/main.dart

import 'dart:io';

import 'package:change/model.dart';
import 'package:markdown/markdown.dart';

/// This example shows how to parse a changelog.
/// Run it from the project root folder: `dart example/main.dart`
void main() async {
  final file = File('CHANGELOG.md');
  final markdown = Document().parseLines(await file.readAsLines());
  final changelog = Changelog.fromMarkdown(markdown);
  final releases = changelog.releases;
  final latest = releases.last;
  print('Changelog contains ${releases.length} releases');
  print('The latest is ${latest.version} released on ${latest.date}');
}

Use this package as an executable

1. Install it

You can install the package from the command line:


$ pub global activate change

2. Use it

The package has the following executables:


$ change

Use this package as a library

1. Depend on it

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


dependencies:
  change: ^0.0.4

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter pub get

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

3. Import it

Now in your Dart code, you can use:


import 'package:change/app.dart';
import 'package:change/model.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
0
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
90
Overall:
Weighted score of the above. [more]
48
Learn more about scoring.

We analyzed this package on Jul 1, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.8.4
  • pana: 0.13.9+1

Analysis suggestions

Package not compatible with runtime flutter-web of web

Because of the import of dart:io via the import chain package:change/app.dart->package:change/src/app/console.dart->dart:io

Package not compatible with runtime web

Because of the import of dart:io via the import chain package:change/app.dart->package:change/src/app/console.dart->dart:io

Maintenance suggestions

Package is pre-v0.1 release. (-10 points)

While nothing is inherently wrong with versions of 0.0.*, it might mean that the author is still experimenting with the general direction of the API.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.8.0 <3.0.0
args ^1.6.0 1.6.0
intl ^0.16.1 0.16.1
markdown ^2.0.2 2.1.5
marker ^0.1.0 0.1.0
maybe_just_nothing ^0.1.8 0.1.9
pub_semver ^1.4.4 1.4.4
Transitive dependencies
charcode 1.1.3
collection 1.14.13
path 1.7.0
Dev dependencies
pedantic ^1.9.0
pubspec_version ^0.6.1
test ^1.9.0