htgen 0.0.4

  • README.md
  • Installing
  • Versions
  • 49

Functions for generating HTML #

This library contains functions for generating HTML content. There are two libraries that you can import. One for server-side HTML generation: htgen/static.dart, and one for dynamic HTML generation: htgen/dynamic.dart. The static generation is basically a function that returns an XML string. Its nothing more than a mirrors based hack that allows you to write your HTML nodes as a set of nested functions returned by a Dart function instead of using HTML templates. The dynamic generation does not use mirrors, but instead are mostly shortcuts for creating DOM nodes and assigning attributes and children to them.

Use this package as a library

1. Depend on it

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


dependencies:
  htgen: ^0.0.4

2. Install it

You can install packages from the command line:

with pub:


$ pub get

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

3. Import it

Now in your Dart code, you can use:


import 'package:htgen/dart2js.dart';
import 'package:htgen/mirrors.dart';
  
Version Uploaded Documentation Archive
0.0.4 Sep 10, 2018 Go to the documentation of htgen 0.0.4 Download htgen 0.0.4 archive
0.0.3+1 Sep 10, 2018 Go to the documentation of htgen 0.0.3+1 Download htgen 0.0.3+1 archive
0.0.3 Sep 9, 2018 Go to the documentation of htgen 0.0.3 Download htgen 0.0.3 archive
0.0.2+1 Nov 7, 2017 Go to the documentation of htgen 0.0.2+1 Download htgen 0.0.2+1 archive
0.0.2 Nov 7, 2017 Go to the documentation of htgen 0.0.2 Download htgen 0.0.2 archive
0.0.1+1 Oct 9, 2017 Go to the documentation of htgen 0.0.1+1 Download htgen 0.0.1+1 archive
0.0.1 May 15, 2017 Go to the documentation of htgen 0.0.1 Download htgen 0.0.1 archive
Popularity:
Describes how popular the package is relative to other packages. [more]
23
Health:
Code health derived from static analysis. [more]
99
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
40
Overall:
Weighted score of the above. [more]
49
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: web

Platform components identified in package: html, mirrors.

Health issues and suggestions

Document public APIs. (-0.68 points)

93 out of 94 API elements have no dartdoc comment.Providing good documentation for libraries, classes, functions, and other API elements improves code readability and helps developers find and use your API.

Fix lib/src/with_mirrors.dart. (-0.50 points)

Analysis of lib/src/with_mirrors.dart reported 1 hint:

line 104 col 47: 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 htgen.dart. Packages with multiple examples should provide example/README.md.

For more information see the pub package layout conventions.

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.0.0-dev <3.0.0
Dev dependencies
build_runner any
build_web_compilers any
test ^1.3.0