https://github.com/angular/angular-hint
run-time hinting for AngularJS applications
https://github.com/angular/angular-hint
Last synced: 6 months ago
JSON representation
run-time hinting for AngularJS applications
- Host: GitHub
- URL: https://github.com/angular/angular-hint
- Owner: angular
- Archived: true
- Created: 2014-06-23T22:46:16.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2017-11-22T15:44:08.000Z (over 7 years ago)
- Last Synced: 2024-05-09T10:10:26.359Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 271 KB
- Stars: 363
- Watchers: 35
- Forks: 45
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# Angular Hint [](https://travis-ci.org/angular/angular-hint) [](https://codeclimate.com/github/angular/angular-hint)
Runtime hinting for AngularJS.
## Usage
Add `` to your app's `index.html` immediately after the
`angular.js` script.
This will load the set of AngularHint modules. Now you are set to use the `ng-hint` directive.
Including the `ng-hint` directive with no parameters will install all the AngularHint modules.
Example:
```html
...
...
```
For more fine-grained hints, you can use `ng-hint-include` to include certain AngularHint modules or
`ng-hint-exclude` to exclude certain AngularHint modules.
Example:
```html
...
...
```
```html
...
...
```
## Building
```shell
$ yarn install
```
```shell
$ yarn build
```
## Example
In the `example` directory, you can find a sample application that appears
superficially correct but violates many Angular best practices. When AngularHint is in operation
it produces hints for correcting the sample application. In the `correctExample` directory
there is an improved version of the sample application.
## Interested in Contributing?
See the [Contributing Guidelines](https://github.com/angular/angular-hint/blob/master/CONTRIBUTING.md)
## License
Apache 2.0