mammouth 4.0.0-beta

     __  __                                       _   _     
    |  \/  |                                     | | | |    
    | \  / | __ _ _ __ ___  _ __ ___   ___  _   _| |_| |__  
    | |\/| |/ _` | '_ ` _ \| '_ ` _ \ / _ \| | | | __| '_ \ 
    | |  | | (_| | | | | | | | | | | | (_) | |_| | |_| | | |
    |_|  |_|\__,_|_| |_| |_|_| |_| |_|\___/ \__,_|\__|_| |_|

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

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:mammouth/sdk/core.dart';
import 'package:mammouth/sdk/runtime.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
0
Health:
Code health derived from static analysis. [more]
17
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
7
Overall:
Weighted score of the above. [more]
7
Learn more about scoring.

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

  • Dart: 2.7.1
  • pana: 0.13.5

Health issues and suggestions

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

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

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

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

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

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

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

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/codegen/codegen.dart. (-25 points)

Analysis of lib/src/codegen/codegen.dart reported 415 hints, including:

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

line 34 col 27: Unnecessary new keyword.

line 44 col 42: Unnecessary new keyword.

line 52 col 44: Unnecessary new keyword.

line 53 col 15: Unnecessary new keyword.

Fix lib/src/language/common/ast/token.dart. (-25 points)

Analysis of lib/src/language/common/ast/token.dart reported 152 hints, including:

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

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

line 18 col 8: Don't explicitly initialize variables to null.

line 20 col 9: Don't explicitly initialize variables to null.

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

Fix additional 41 files with analysis or formatting issues. (-287.82 points)

Additional issues in the following files:

  • lib/src/language/mammouth/ast/ast.dart (426 hints)
  • lib/src/language/mammouth/ast/implementation.dart (76 hints)
  • lib/src/language/mammouth/element/Cloner.dart (70 hints)
  • lib/src/language/php/ast/ast.dart (174 hints)
  • lib/src/syntactic/parser.dart (482 hints)
  • lib/src/syntactic/lexer.dart (35 hints)
  • lib/src/diagnostic/error.dart (34 hints)
  • lib/src/semantic/typeChecker.dart (30 hints)
  • lib/src/language/mammouth/type/type.dart (28 hints)
  • lib/src/language/mammouth/element/element.dart (23 hints)
  • lib/src/semantic/typeSystem.dart (21 hints)
  • lib/src/language/common/ast/ast.dart (17 hints)
  • lib/src/language/php/ast/implementation.dart (17 hints)
  • lib/src/mammouth.dart (17 hints)
  • lib/src/platform/vm/fileSystem.dart (16 hints)
  • lib/src/semantic/elementBuilder.dart (16 hints)
  • lib/src/syntactic/errors.dart (16 hints)
  • lib/src/language/common/ast/precedence.dart (15 hints)
  • lib/src/language/php/element/element.dart (10 hints)
  • bin/mammouth.dart (8 hints)
  • lib/src/language/common/ast/syntacticEntity.dart (5 hints)
  • lib/src/language/mammouth/type/implementation.dart (5 hints)
  • lib/src/basic/session.dart (3 hints)
  • lib/src/codegen/docgen.dart (3 hints)
  • lib/src/diagnostic/diagnosticEngine.dart (3 hints)
  • lib/src/basic/option.dart (2 hints)
  • lib/src/codegen/resolver.dart (2 hints)
  • lib/src/language/common/ast/implementation.dart (2 hints)
  • lib/src/language/common/ast/visitor.dart (2 hints)
  • lib/src/language/mammouth/ast/constants.dart (2 hints)
  • lib/src/semantic/parentResolver.dart (2 hints)
  • lib/src/semantic/scope.dart (2 hints)
  • lib/src/syntactic/codepoint.dart (2 hints)
  • lib/src/syntactic/indentation.dart (2 hints)
  • lib/src/basic/fileSystem/abstractFile.dart (1 hint)
  • lib/src/platform/vm/session.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/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.)

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.

Package is getting outdated. (-40.55 points)

The package was last published 73 weeks ago.

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.2
path ^1.6.2 1.6.4
yaml ^2.1.15 2.2.0
Transitive dependencies
charcode 1.1.3
collection 1.14.12
meta 1.1.8
source_span 1.6.0
string_scanner 1.0.5
term_glyph 1.1.0