mammouth 4.0.0-beta

  • README.md
  • Installing
  • Versions
  • 6
     __  __                                       _   _     
    |  \/  |                                     | | | |    
    | \  / | __ _ _ __ ___  _ __ ___   ___  _   _| |_| |__  
    | |\/| |/ _` | '_ ` _ \| '_ ` _ \ / _ \| | | | __| '_ \ 
    | |  | | (_| | | | | | | | | | | | (_) | |_| | |_| | | |
    |_|  |_|\__,_|_| |_| |_|_| |_| |_|\___/ \__,_|\__|_| |_|

Mammouth is a small language that compiles into PHP, inspired by CoffeeScript. It's compiled to PHP codes/files that you can run in your PHP server.

For documentation, usage, and examples, see: http://mammouth.boutglay.com/

To suggest a feature, report a bug, or general discussion: http://github.com/btwael/mammouth/issues/

Use this package as a library

1. Depend on it

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


dependencies:
  mammouth: ^4.0.0-beta

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:mammouth/sdk/core.dart';
import 'package:mammouth/sdk/runtime.dart';
  
Version Uploaded Documentation Archive
4.0.0-beta Oct 1, 2018 Go to the documentation of mammouth 4.0.0-beta Download mammouth 4.0.0-beta archive
Popularity:
Describes how popular the package is relative to other packages. [more]
0
Health:
Code health derived from static analysis. [more]
0
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
28
Overall:
Weighted score of the above. [more]
6
Learn more about scoring.

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

  • Dart: 2.2.0
  • pana: 0.12.14

Platforms

Detected platforms:

Low code quality prevents platform classification.

Health issues and suggestions

Fix lib/src/language/mammouth/element/implementation.dart. (-77.54 points)

Analysis of lib/src/language/mammouth/element/implementation.dart failed with 5 errors, 11 hints, including:

line 195 col 7: 'ClassMemberElement.node' ('() → ClassMember') isn't a valid override of 'ConstructorElement.node' ('() → ConstructorDeclaration').

line 242 col 7: 'ClassMemberElement.node' ('() → ClassMember') isn't a valid override of 'FieldElement.node' ('() → FieldDeclaration').

line 410 col 7: 'ClassMemberElement.node' ('() → ClassMember') isn't a valid override of 'MethodElement.node' ('() → MethodDeclaration').

line 445 col 7: 'ClassMemberElement.node' ('() → ClassMember') isn't a valid override of 'OperatorElement.node' ('() → OperatorDeclaration').

line 480 col 7: 'ClassMemberElement.node' ('() → ClassMember') isn't a valid override of 'ConverterElement.node' ('() → ConverterDeclaration').

Document public APIs. (-1 points)

4 out of 4 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/language/mammouth/ast/ast.dart. (-88.12 points)

Analysis of lib/src/language/mammouth/ast/ast.dart reported 425 hints, including:

line 15 col 1: Prefer using /// for doc comments.

line 19 col 3: Prefer using /// for doc comments.

line 24 col 3: Prefer using /// for doc comments.

line 31 col 3: Prefer using /// for doc comments.

line 42 col 3: Avoid return types on setters.

Fix lib/src/language/php/ast/ast.dart. (-58.20 points)

Analysis of lib/src/language/php/ast/ast.dart reported 174 hints, including:

line 12 col 1: Prefer using /// for doc comments.

line 22 col 1: Prefer using /// for doc comments.

line 26 col 3: Prefer using /// for doc comments.

line 31 col 3: Prefer using /// for doc comments.

line 36 col 3: Prefer using /// for doc comments.

Fix additional 40 files with analysis or formatting issues. (-149.47 points)

Additional issues in the following files:

  • lib/src/syntactic/parser.dart (104 hints)
  • lib/src/language/mammouth/ast/implementation.dart (75 hints)
  • lib/src/diagnostic/error.dart (27 hints)
  • lib/src/language/common/ast/token.dart (23 hints)
  • lib/src/language/mammouth/element/element.dart (23 hints)
  • lib/src/language/mammouth/type/type.dart (18 hints)
  • lib/src/language/common/ast/ast.dart (17 hints)
  • lib/src/semantic/typeChecker.dart (11 hints)
  • lib/src/codegen/codegen.dart (8 hints)
  • bin/mammouth.dart (4 hints)
  • lib/src/language/common/ast/syntacticEntity.dart (4 hints)
  • lib/src/syntactic/lexer.dart (4 hints)
  • lib/src/basic/option.dart (2 hints)
  • lib/src/basic/session.dart (2 hints)
  • lib/src/codegen/docgen.dart (2 hints)
  • lib/src/language/common/ast/implementation.dart (2 hints)
  • lib/src/language/common/ast/precedence.dart (2 hints)
  • lib/src/language/common/ast/visitor.dart (2 hints)
  • lib/src/semantic/typeSystem.dart (2 hints)
  • lib/src/syntactic/codepoint.dart (2 hints)
  • lib/src/basic/fileSystem/abstractFile.dart (1 hint)
  • lib/src/language/php/ast/implementation.dart (1 hint)
  • lib/src/language/php/element/element.dart (1 hint)
  • lib/src/semantic/elementBuilder.dart (1 hint)
  • lib/src/semantic/parentResolver.dart (1 hint)
  • lib/src/semantic/scope.dart (1 hint)
  • lib/sdk/core.dart (Run dartfmt to format lib/sdk/core.dart.)
  • lib/sdk/runtime.dart (Run dartfmt to format lib/sdk/runtime.dart.)
  • lib/src/codegen/namePicker.dart (Run dartfmt to format lib/src/codegen/namePicker.dart.)
  • lib/src/codegen/resolver.dart (Run dartfmt to format lib/src/codegen/resolver.dart.)
  • lib/src/diagnostic/diagnosticEngine.dart (Run dartfmt to format lib/src/diagnostic/diagnosticEngine.dart.)
  • lib/src/language/mammouth/element/Cloner.dart (Run dartfmt to format lib/src/language/mammouth/element/Cloner.dart.)
  • lib/src/language/mammouth/type/implementation.dart (Run dartfmt to format lib/src/language/mammouth/type/implementation.dart.)
  • lib/src/language/php/ast/visitor.dart (Run dartfmt to format lib/src/language/php/ast/visitor.dart.)
  • lib/src/language/php/version.dart (Run dartfmt to format lib/src/language/php/version.dart.)
  • lib/src/mammouth.dart (Run dartfmt to format lib/src/mammouth.dart.)
  • lib/src/platform/vm/fileSystem.dart (Run dartfmt to format lib/src/platform/vm/fileSystem.dart.)
  • lib/src/platform/vm/session.dart (Run dartfmt to format lib/src/platform/vm/session.dart.)
  • lib/src/syntactic/errors.dart (Run dartfmt to format lib/src/syntactic/errors.dart.)
  • lib/src/syntactic/indentation.dart (Run dartfmt to format lib/src/syntactic/indentation.dart.)

Maintenance issues and suggestions

Fix platform conflicts. (-20 points)

Low code quality prevents platform classification.

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. (-17 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 mammouth.dart. Packages with multiple examples should provide example/README.md.

For more information see the pub package layout conventions.

Package is pre-release. (-5 points)

Pre-release versions should be used with caution; their API can change in breaking ways.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0 <3.0.0
args ^1.5.0 1.5.1
path ^1.6.2 1.6.2
yaml ^2.1.15 2.1.15
Transitive dependencies
charcode 1.1.2
collection 1.14.11
meta 1.1.7
source_span 1.5.5
string_scanner 1.0.4
term_glyph 1.1.0