https://github.com/realityforge/grim

https://github.com/realityforge/grim

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/realityforge/grim
• Owner: realityforge
• License: apache-2.0
• Created: 2019-10-11T04:58:08.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-07-26T02:54:40.000Z (5 months ago)
• Last Synced: 2024-10-04T16:27:21.959Z (2 months ago)
• Language: Java
• Homepage:
• Size: 352 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• gwt-boot-awesome-lili - grim - Assert unexpected symbols are eliminated from output :sparkling_heart: (Testing)

README

        
# Grim: Ensure dead code is eliminated

[![Build Status](https://api.travis-ci.com/realityforge/grim.svg?branch=master)](http://travis-ci.com/realityforge/grim)

[](https://search.maven.org/search?q=g:org.realityforge.grim%20a:grim-annotations)

[![codecov](https://codecov.io/gh/realityforge/grim/branch/master/graph/badge.svg)](https://codecov.io/gh/realityforge/grim)

## What is Grim?

Grim is a tool that helps enforce dead code is eliminated from GWT libraries. Grim consists of a set of annotations

that developers use to declare which methods or fields are expected to be eliminated from the javascript output

under different conditions. Grim also contains an annotation processor that processes the annotations to generate

a set of output rules that indicates the members that will be eliminated with specific values for compile time

settings. Grim also contains an assertion library that takes one or more output rules and verifies that the results

of a GWT compilation complied with the rules.

### Getting Started

The tool is released to Maven Central and can be downloaded using normal dependency download mechanisms.

The Maven dependency is:

```xml

  org.realityforge.grim

  grim-annotations

  0.09

  org.realityforge.grim

  grim-processor

  0.09

  org.realityforge.grim

  grim-asserts

  0.09

```

# Contributing

The project was released as open source so others could benefit from the project. We are thankful for any

contributions from the community. A [Code of Conduct](CODE_OF_CONDUCT.md) has been put in place and

a [Contributing](CONTRIBUTING.md) document is under development.

# License

The project is licensed under [Apache License, Version 2.0](LICENSE).

# Credit

* [Stock Software](http://www.stocksoftware.com.au/) for providing significant support in building and maintaining

  the library, particularly at it's inception.