Skip to content

Commit

Permalink
Maintenance and upgrade (#168)
Browse files Browse the repository at this point in the history
* replace ci workflow, add badges to README.md, update CODEOWNERS

* update to latest angular 8

* upgraded to angular 9

* upgrade to angular 10
  • Loading branch information
emielb authored Jun 15, 2021
1 parent 53615a1 commit 607a331
Show file tree
Hide file tree
Showing 16 changed files with 11,515 additions and 7,590 deletions.
File renamed without changes.
26 changes: 0 additions & 26 deletions .circleci/config.yml

This file was deleted.

43 changes: 43 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: CI

on:
push:
branches: [main]
pull_request:
branches: [main]

jobs:
build:
name: Build and Test
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [12.x, 14.x]
steps:
- uses: actions/checkout@v2
- name: Use node.js ${{ matrix.node-version }}
uses: actions/setup-node@v1
with:
node-version: ${{ matrix.node-version }}
- name: Cache node_modules
id: cache-modules
uses: actions/[email protected]
with:
path: node_modules
key: ${{ matrix.node-version }}-${{ runner.OS }}-build-${{ hashFiles('package.json') }}

- name: Install
if: steps.cache-modules.output.cache-hit != 'true'
run: npm install

- name: Test
run: npm run build:test

- name: Lint
run: npm run lint

- name: Build
run: npm run build:build

- name: E2E
run: npm run e2e
10 changes: 0 additions & 10 deletions .travis.yml

This file was deleted.

2 changes: 1 addition & 1 deletion CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Code owners are automatically requested for review when someone opens a pull request.

* @pavadeli @wvanderdeijl @njirem @WouterSpaak
* @emielb @yasinkocak
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# Ngx Sherlock

[![Greenkeeper badge](https://badges.greenkeeper.io/politie/ngx-sherlock.svg)](https://greenkeeper.io/)
[![Coverage Status](https://coveralls.io/repos/github/politie/ngx-sherlock/badge.svg?branch=master)](https://coveralls.io/github/politie/ngx-sherlock?branch=master)
[![CI](https://github.com/politie/ngx-sherlock/actions/workflows/build.yml/badge.svg)](https://github.com/politie/ngx-sherlock/actions/workflows/build.yml)
[![Known Vulnerabilities](https://snyk.io/test/github/politie/ngx-sherlock/badge.svg)](https://snyk.io/test/github/politie/ngx-sherlock)
[![npm version](https://img.shields.io/npm/v/@politie/ngx-sherlock)](https://www.npmjs.com/package/@politie/ngx-sherlock)
[![license](https://img.shields.io/npm/l/@politie/ngx-sherlock?color=blue)](https://github.com/politie/ngx-sherlock/blob/main/LICENSE)

**NgxSherlock** is a set of Angular bindings for the [Sherlock](https://github.com/politie/sherlock)
reactive state management library.
Expand All @@ -13,7 +15,7 @@
Install **NgxSherlock** by running:

```bash
$ npm install @politie/ngx-sherlock
npm install @politie/ngx-sherlock
```

Add the `NgxSherlockModule` to your `AppModule`:
Expand All @@ -32,6 +34,7 @@ export class AppModule { }
### `autoDetectChanges`

**Signature**:

```typescript
class AutoChangeDetectorService {
init(): Promise<void>;
Expand All @@ -47,6 +50,7 @@ The `AutoChangeDetectorService` service guarantees model and view fidelity, mean
#### Example

`trusty-sidekick.component.ts`:

```typescript
import { Component, ChangeDetectionStrategy, ChangeDetectorRef, Input } from '@angular/core';
import { AutoChangeDetectorService } from '@politie/ngx-sherlock';
Expand Down Expand Up @@ -109,12 +113,14 @@ performance.
#### Example

`my.component.html`:

```html
<h1>My awesome counter</h1>
<p>We're already at: <strong>{{ counter$ | value }}</strong></p>
```

`my.component.ts`:

```typescript
import { Component, OnInit, ChangeDetectionStrategy } from '@angular/core';
import { atom } from '@politie/sherlock';
Expand Down
Loading

0 comments on commit 607a331

Please sign in to comment.