Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prettier precommit hook #126

Merged
merged 5 commits into from
Mar 21, 2018
Merged

Prettier precommit hook #126

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e4c045d
adds prettier setup
josh-lester Mar 20, 2018
ec8d94f
adds prettier badge to readme file
josh-lester Mar 20, 2018
6530a0d
make this file blank
josh-lester Mar 20, 2018
3ee52b0
fix typo
josh-lester Mar 20, 2018
1da89f9
changes printwidth to 80
josh-lester Mar 20, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .prettierignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# add files you wish to ignore here
5 changes: 5 additions & 0 deletions .prettierrc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"printWidth": 80,
"singleQuote": true,
"tabWidth": 2
}
12 changes: 8 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Angular ngrx-data

[![prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://prettier.io/)

## Zero Ngrx Boilerplate

**You may never write an action, reducer, selector, effect, or HTTP dataservice again.**
Expand All @@ -13,6 +15,7 @@ _Ngrx-data_ is an _ngrx_ extension that offers a gentle introduction to _ngrx/re
> **Try it!** See the [Quick Start](https://github.com/johnpapa/ngrx-data-lab/blob/master/README.md) for instructions on adding NgRx and ngrx-data to your app.

<a id="why"></a>

## Why use _ngrx-data_?

Many applications have substantial _domain models_ with 10s or 100s of [entity types](docs/faq.md/#entity)
Expand Down Expand Up @@ -51,8 +54,8 @@ You begin with a description of the entity model in a few lines of metadata.
```javascript
// Metadata for the entity model
export const entityMetadata: EntityMetadataMap = {
Hero: { },
Villain: { }
Hero: {},
Villain: {}
};

// Help ngrx-data pluralize entity type names
Expand Down Expand Up @@ -137,6 +140,7 @@ export class HeroesComponent implements OnInit {
Try the [Quick Start](https://github.com/johnpapa/ngrx-data-lab/blob/master/README.md) to experience NgRx and ngrx-data in your app.

<a id="explore"></a>

## Explore this repository

This repository contains the _ngrx-data_ source code and a
Expand All @@ -150,6 +154,7 @@ The key folders in this repository are:
* src/server ---> a node server for remote data access

<a id="docs-list"></a>

### Learn more in the docs

* [Quick Start](https://github.com/johnpapa/ngrx-data-lab/blob/master/README.md)
Expand All @@ -165,7 +170,6 @@ The key folders in this repository are:
* [Limitations](docs/limitations.md)
* [FAQ: Frequently Asked Questions](docs/faq.md)


### Install and run

The demo app is based on the Angular CLI. You may want to install the CLI globally if you have not already done so.
Expand Down Expand Up @@ -218,6 +222,7 @@ We welcome [PRs](https://github.com/johnpapa/angular-ngrx-data/pulls) that add t
Be sure to run these tests before submitting a PR for review.

<a id="redux-dev-tools"></a>

## Monitor the app with Redux DevTools

The demo app is [configured for monitoring](https://github.com/ngrx/platform/tree/master/docs/store-devtools) with the [Redux DevTools](https://github.com/zalmoxisus/redux-devtools-extension).
Expand Down Expand Up @@ -248,7 +253,6 @@ Obviously the package deployed in `node_modules` would not.

If you want to see how the demo app runs against the published package, you'll have to make **a few temporary changes** to the TypeScript configuration.


1. **_Remove_** the following from root `tsconfig.json` so that the IDE (e.g., VS Code) looks for `ngrx-data` in `node_modules/ngrx-data` instead of `src/lib`.

```bash
Expand Down
Loading