firn 0.0.2

  • Readme
  • Changelog
  • Installing
  • 56

firn logo

firn #

The chillest IRC library.

NOTICE #

This library is still in heavy development, things are very likely to change in the future.

What is firn? #

Firn is modern IRC v3 library written in pure dart. Used in Igloo IRC for android.

How does it work? #

Firn relies on an object-based event stream. Any important messages coming from a server are parsed and sent through this event stream. This stream can have any number of listeners.

Examples #

Examples can be found in /examples.

  • basic.dart shows off Firn in a single-server enviroment
  • pool.dart shows how Firn can be used in multiple servers at the same time

[0.0.2] - some time later #

  • Added multi-server support
  • Added lots of documentation to make the library easier to understand

[0.0.1] - time is a fake concept. #

  • initial release
  • only basic support for stuff

Use this package as a library

1. Depend on it

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


dependencies:
  firn: ^0.0.2

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:firn/FirnClient.dart';
import 'package:firn/datatypes/Channel.dart';
import 'package:firn/datatypes/FirnConfig.dart';
import 'package:firn/datatypes/IRCPrefix.dart';
import 'package:firn/datatypes/Message.dart';
import 'package:firn/events/ChannelEvent.dart';
import 'package:firn/events/FirnEvent.dart';
import 'package:firn/events/MessageRecievedEvent.dart';
import 'package:firn/events/NickNameChangedEvent.dart';
import 'package:firn/events/ServerConnectEvent.dart';
import 'package:firn/parser/IRCMessageParser.dart';
import 'package:firn/parser/IRCPrefixParser.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
20
Health:
Code health derived from static analysis. [more]
95
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
90
Overall:
Weighted score of the above. [more]
56
Learn more about scoring.

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

  • Dart: 2.8.4
  • pana: 0.13.13

Analysis suggestions

Package not compatible with runtime flutter-web on web

Because of the import of dart:io via the import chain package:firn/FirnClient.dartpackage:firn/datatypes/FirnConfig.dartdart:io

Package not compatible with runtime web

Because of the import of dart:io via the import chain package:firn/FirnClient.dartpackage:firn/datatypes/FirnConfig.dartdart:io

Health suggestions

Fix lib/FirnClient.dart. (-3.45 points)

Analysis of lib/FirnClient.dart reported 7 hints, including:

line 154 col 9: Use isNotEmpty instead of length

line 225 col 34: Unnecessary new keyword.

line 250 col 34: Unnecessary new keyword.

line 267 col 34: Unnecessary new keyword.

line 276 col 34: Unnecessary new keyword.

Fix lib/parser/IRCMessageParser.dart. (-1 points)

Analysis of lib/parser/IRCMessageParser.dart reported 2 hints:

line 2 col 8: Unused import: 'package:firn/datatypes/IRCPrefix.dart'.

line 11 col 22: Unnecessary new keyword.

Fix lib/parser/IRCPrefixParser.dart. (-1 points)

Analysis of lib/parser/IRCPrefixParser.dart reported 2 hints:

line 8 col 33: Always false because length is always greater or equal 0.

line 20 col 24: Unnecessary new keyword.

Fix additional 9 files with analysis or formatting issues.

Additional issues in the following files:

  • lib/datatypes/Channel.dart (Run dartfmt to format lib/datatypes/Channel.dart.)
  • lib/datatypes/FirnConfig.dart (Run dartfmt to format lib/datatypes/FirnConfig.dart.)
  • lib/datatypes/IRCPrefix.dart (Run dartfmt to format lib/datatypes/IRCPrefix.dart.)
  • lib/datatypes/Message.dart (Run dartfmt to format lib/datatypes/Message.dart.)
  • lib/events/ChannelEvent.dart (Run dartfmt to format lib/events/ChannelEvent.dart.)
  • lib/events/FirnEvent.dart (Run dartfmt to format lib/events/FirnEvent.dart.)
  • lib/events/MessageRecievedEvent.dart (Run dartfmt to format lib/events/MessageRecievedEvent.dart.)
  • lib/events/NickNameChangedEvent.dart (Run dartfmt to format lib/events/NickNameChangedEvent.dart.)
  • lib/events/ServerConnectEvent.dart (Run dartfmt to format lib/events/ServerConnectEvent.dart.)

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.

Maintain an example.

None of the files in the package's example/ directory matches known example patterns.

Common filename patterns include main.dart, example.dart, and firn.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.7.0 <3.0.0
Dev dependencies
test ^1.14.5