Skip to content

Commit c0c9d1d

Browse files
committed
fix: change package names to be user scoped
1 parent d95d90c commit c0c9d1d

39 files changed

+504
-443
lines changed

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ We follow the [Conventional Commits](https://conventionalcommits.org/) guideline
1212

1313
## Canary Releases
1414

15-
This repo is setup to automatically release canary builds for every commit that is pushed to master. In order to access those builds, run `npm install ngredux-store@canary` (or whichever package you are looking to use)
15+
This repo is setup to automatically release canary builds for every commit that is pushed to master. In order to access those builds, run `npm install @adrian.insua/ngredux-store@canary` (or whichever package you are looking to use)
1616

1717
## Stable Releases
1818

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@ Project forked from unmantained [angular-redux/platform](https://github.com/angu
88

99
## Packages
1010

11-
- [ngredux-store](packages/store) - Bindings between Redux and Angular
12-
- [ngredux-form](packages/form) - Bindings between Angular Forms and your Redux state
13-
- [ngredux-router](packages/router) - Bindings between Angular Router and your Redux state
11+
- [@adrian.insua/ngredux-store](packages/store) - Bindings between Redux and Angular
12+
- [@adrian.insua/ngredux-form](packages/form) - Bindings between Angular Forms and your Redux state
13+
- [@adrian.insua/ngredux-router](packages/router) - Bindings between Angular Router and your Redux state

docs/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
# Packages
66

7-
- [ngredux-store](store/) - Bindings between Redux and Angular
8-
- [ngredux-form](form/) - Bindings between Angular Forms and your Redux state
9-
- [ngredux-router](router/) - Bindings between Angular Router and your Redux state
7+
- [@adrian.insua/ngredux-store](store/) - Bindings between Redux and Angular
8+
- [@adrian.insua/ngredux-form](form/) - Bindings between Angular Forms and your Redux state
9+
- [@adrian.insua/ngredux-router](router/) - Bindings between Angular Router and your Redux state
1010

1111
# Examples
1212

docs/form/README.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
[![npm version](https://img.shields.io/npm/v/ngredux-form.svg)](https://www.npmjs.com/package/ngredux-form)
2-
[![downloads per month](https://img.shields.io/npm/dm/ngredux-form.svg)](https://www.npmjs.com/package/ngredux-form)
1+
[![npm version](https://img.shields.io/npm/v/@adrian.insua/ngredux-form.svg)](https://www.npmjs.com/package/@adrian.insua/ngredux-form)
2+
[![downloads per month](https://img.shields.io/npm/dm/@adrian.insua/ngredux-form.svg)](https://www.npmjs.com/package/@adrian.insua/ngredux-form)
33

44
This library is a thin layer of connective tissue between Angular 2+ forms and
55
Redux. It provides unidirectional data binding between your Redux state and
@@ -49,12 +49,12 @@ the class that is responsible for connecting your forms to your Redux state.
4949
There are two ways of doing this: either using an `Redux.Store<T>` object or
5050
an `NgRedux<T>` object. There are no substantial differences between these
5151
approaches, but if you are already using
52-
[ngredux-store](https://github.com/angular-redux/platform/blob/master/packages/store) or you wish to integrate
52+
[@adrian.insua/ngredux-store](https://github.com/angular-redux/platform/blob/master/packages/store) or you wish to integrate
5353
it into your project, then you would do something like this:
5454

5555
```typescript
56-
import { NgReduxModule } from 'ngredux-store';
57-
import { NgReduxFormModule } from 'ngredux-form';
56+
import { NgReduxModule } from '@adrian.insua/ngredux-store';
57+
import { NgReduxFormModule } from '@adrian.insua/ngredux-form';
5858

5959
@NgModule({
6060
imports: [BrowserModule, ReactiveFormsModule, FormsModule, NgReduxFormModule, NgReduxModule],
@@ -63,11 +63,11 @@ import { NgReduxFormModule } from 'ngredux-form';
6363
export class ExampleModule {}
6464
```
6565

66-
Or if you are using Redux without `ngredux-store`, then your bootstrap call would look
66+
Or if you are using Redux without `@adrian.insua/ngredux-store`, then your bootstrap call would look
6767
more like this (substitute your own store creation code):
6868

6969
```typescript
70-
import { provideReduxForms } from 'ngredux-form';
70+
import { provideReduxForms } from '@adrian.insua/ngredux-form';
7171

7272
const storeCreator = compose(applyMiddleware(logger))(createStore);
7373
const store = create(reducers, <MyApplicationState>{});
@@ -81,7 +81,7 @@ export class ExampleModule {}
8181
```
8282

8383
The essential bit of code in the above samples is the call to `provideReduxForms(...)`.
84-
This configures `ngredux-form` and provides access to your Redux store or NgRedux
84+
This configures `@adrian.insua/ngredux-form` and provides access to your Redux store or NgRedux
8585
instance. The shape of the object that `provideReduxForms` expects is very
8686
basic:
8787

@@ -186,7 +186,7 @@ the `path` property on our first `<select>` element, it would look like this:
186186
['form1', 'dependents', 0, 'type']
187187
```
188188

189-
From there, `ngredux-form` is able to take that path and extract the value for
189+
From there, `@adrian.insua/ngredux-form` is able to take that path and extract the value for
190190
that element from the Redux state.
191191

192192
# Reactive Forms
@@ -212,14 +212,14 @@ the easy part and is unlikely to cause any problems for you. Slightly more diffi
212212
is _updating your Redux state_ when the form values change. There are two approaches
213213
that you can take in order to do this.
214214

215-
The first, and by far the simplest, is to use the reducer that comes with `ngredux-form`
215+
The first, and by far the simplest, is to use the reducer that comes with `@adrian.insua/ngredux-form`
216216
and uses the value supplied in `connect` and the form input names in order to update
217217
your Redux state automatically. If you do not need to do any special processing on
218218
your data when the user updates form inputs, then you should use this default reducer.
219219
To use it, you need to combine it with your existing reducers like so:
220220

221221
```typescript
222-
import { composeReducers, defaultFormReducer } from 'ngredux-form';
222+
import { composeReducers, defaultFormReducer } from '@adrian.insua/ngredux-form';
223223

224224
const reducer = composeReducers(
225225
defaultFormReducer(),
@@ -284,4 +284,4 @@ you have to use `composeReducers` distasteful, then this is another route availa
284284
to you.
285285

286286
The unit tests in `*.test.ts` files also contain useful examples of how to build
287-
forms using `ngredux-form`.
287+
forms using `@adrian.insua/ngredux-form`.

docs/router/README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
[![npm version](https://img.shields.io/npm/v/ngredux-router.svg)](https://www.npmjs.com/package/ngredux-router)
2-
[![downloads per month](https://img.shields.io/npm/dm/ngredux-router.svg)](https://www.npmjs.com/package/ngredux-router)
1+
[![npm version](https://img.shields.io/npm/v/@adrian.insua/ngredux-router.svg)](https://www.npmjs.com/package/@adrian.insua/ngredux-router)
2+
[![downloads per month](https://img.shields.io/npm/dm/@adrian.insua/ngredux-router.svg)](https://www.npmjs.com/package/@adrian.insua/ngredux-router)
33

4-
Bindings to connect @angular/router to ngredux-core
4+
Bindings to connect @angular/router to @adrian.insua/ngredux-core
55

66
# Setup
77

88
1. Use npm to install the bindings:
99

1010
```
11-
npm install ngredux-router --save
11+
npm install @adrian.insua/ngredux-router --save
1212
```
1313

1414
2. Use the `routerReducer` when providing `Store`:
1515

1616
```ts
1717
import { combineReducers } from 'redux';
18-
import { routerReducer } from 'ngredux-router';
18+
import { routerReducer } from '@adrian.insua/ngredux-router';
1919

2020
export default combineReducers<IAppState>({
2121
// your reducers..
@@ -27,8 +27,8 @@ export default combineReducers<IAppState>({
2727

2828
```ts
2929
import { NgModule } from '@angular/core';
30-
import { NgReduxModule, NgRedux } from 'ngredux-core';
31-
import { NgReduxRouterModule, NgReduxRouter } from 'ngredux-router';
30+
import { NgReduxModule, NgRedux } from '@adrian.insua/ngredux-core';
31+
import { NgReduxRouterModule, NgReduxRouter } from '@adrian.insua/ngredux-router';
3232
import { RouterModule } from '@angular/router';
3333
import { routes } from './routes';
3434

@@ -68,4 +68,4 @@ getting the URL from there.
6868

6969
# Examples
7070

71-
- [Example-app: An example of using ngredux-router along with the other companion packages.](https://github.com/angular-redux/platform/tree/master/packages/example-app)
71+
- [Example-app: An example of using @adrian.insua/ngredux-router along with the other companion packages.](https://github.com/angular-redux/platform/tree/master/packages/example-app)

docs/store/README.md

+14-14
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
[![npm version](https://img.shields.io/npm/v/ngredux-store.svg)](https://www.npmjs.com/package/ngredux-store)
2-
[![downloads per month](https://img.shields.io/npm/dm/ngredux-store.svg)](https://www.npmjs.com/package/ngredux-store)
1+
[![npm version](https://img.shields.io/npm/v/@adrian.insua/ngredux-store.svg)](https://www.npmjs.com/package/@adrian.insua/ngredux-store)
2+
[![downloads per month](https://img.shields.io/npm/dm/@adrian.insua/ngredux-store.svg)](https://www.npmjs.com/package/@adrian.insua/ngredux-store)
33

44
# Getting Started
55

@@ -9,10 +9,10 @@
99

1010
## Quickstart
1111

12-
`ngredux-store` has a peer dependency on redux, so we need to install it.
12+
`@adrian.insua/ngredux-store` has a peer dependency on redux, so we need to install it.
1313

1414
```sh
15-
npm install --save redux ngredux-store
15+
npm install --save redux @adrian.insua/ngredux-store
1616
```
1717

1818
```typescript
@@ -29,7 +29,7 @@ can configure your Redux store with reducers, initial state,
2929
and optionally middlewares and enhancers as you would in Redux directly.
3030

3131
```typescript
32-
import { NgReduxModule, NgRedux } from 'ngredux-store';
32+
import { NgReduxModule, NgRedux } from '@adrian.insua/ngredux-store';
3333
import { createLogger } from 'redux-logger';
3434
import { rootReducer } from './reducers';
3535

@@ -53,7 +53,7 @@ Or if you prefer to create the Redux store yourself you can do that and use the
5353

5454
```typescript
5555
import { applyMiddleware, Store, combineReducers, compose, createStore } from 'redux';
56-
import { NgReduxModule, NgRedux } from 'ngredux-store';
56+
import { NgReduxModule, NgRedux } from '@adrian.insua/ngredux-store';
5757
import { createLogger } from 'redux-logger';
5858
import { rootReducer } from './reducers';
5959

@@ -76,7 +76,7 @@ class AppModule {
7676

7777
> Note that we're also using a Redux middleware from the community here:
7878
> [redux-logger](https://www.npmjs.com/package/redux-logger). This is just to show
79-
> off that `ngredux-store` is indeed compatible with Redux middlewares as you
79+
> off that `@adrian.insua/ngredux-store` is indeed compatible with Redux middlewares as you
8080
> might expect.
8181
>
8282
> Note that to use it, you'll need to install it with `npm install --save redux-logger`
@@ -86,7 +86,7 @@ Now your Angular app has been reduxified! Use the `@select` decorator to
8686
access your store state, and `.dispatch()` to dispatch actions:
8787

8888
```typescript
89-
import { select } from 'ngredux-store';
89+
import { select } from '@adrian.insua/ngredux-store';
9090

9191
@Component({
9292
template: '<button (click)="onClick()">Clicked {{ count | async }} times</button>',
@@ -106,8 +106,8 @@ class App {
106106

107107
# Companion Packages
108108

109-
- [Reduxify your Routing with ngredux-router](https://github.com/angular-redux/platform/blob/master/packages/router)
110-
- [Reduxify your Forms with ngredux-form](https://github.com/angular-redux/platform/blob/master/packages/form)
109+
- [Reduxify your Routing with @adrian.insua/ngredux-router](https://github.com/angular-redux/platform/blob/master/packages/router)
110+
- [Reduxify your Forms with @adrian.insua/ngredux-form](https://github.com/angular-redux/platform/blob/master/packages/form)
111111

112112
# Resources
113113

@@ -117,7 +117,7 @@ class App {
117117

118118
# In-Depth Usage
119119

120-
`ngredux-store` uses an approach to redux based on RxJS Observables to `select` and transform
120+
`@adrian.insua/ngredux-store` uses an approach to redux based on RxJS Observables to `select` and transform
121121
data on its way out of the store and into your UI or side-effect handlers. Observables
122122
are an efficient analogue to `reselect` for the RxJS-heavy Angular world.
123123

@@ -150,7 +150,7 @@ parameter at all.
150150
```typescript
151151
import { Component } from '@angular/core';
152152
import { Observable } from 'rxjs/Observable';
153-
import { select } from 'ngredux-store';
153+
import { select } from '@adrian.insua/ngredux-store';
154154

155155
@Component({
156156
selector: 'counter-value-printed-many-times',
@@ -198,7 +198,7 @@ import { Component } from '@angular/core';
198198
import { Observable } from 'rxjs/Observable';
199199
import { Counter } from '../components/Counter';
200200
import * as CounterActions from '../actions/CounterActions';
201-
import { NgRedux } from 'ngredux-store';
201+
import { NgRedux } from '@adrian.insua/ngredux-store';
202202

203203
interface IAppState {
204204
counter: number;
@@ -251,5 +251,5 @@ class Foo {
251251
- [Using Angular's Dependency Injector with Middlewares](store/articles/cookbooks#using-angular-2-services-in-your-middleware)
252252
- [Managing Side-Effects with redux-observable Epics](store/articles/cookbooks#side-effect-management-using-epics)
253253
- [Using the Redux DevTools Chrome Extension](store/articles/cookbooks#using-devtools)
254-
- [ngredux-store and ImmutableJS](store/articles/cookbooks#using-immutablejs)
254+
- [@adrian.insua/ngredux-store and ImmutableJS](store/articles/cookbooks#using-immutablejs)
255255
- [Strongly Typed Reducers](store/articles/cookbooks#strongly-typed-reducers)

docs/store/articles/cookbooks.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ and a simple `RandomNumberService` to show a side effect.
1717

1818
```typescript
1919
import { Injectable } from '@angular/core';
20-
import { NgRedux } from 'ngredux-store';
20+
import { NgRedux } from '@adrian.insua/ngredux-store';
2121
import * as Redux from 'redux';
2222
import { RootState } from '../store';
2323
import { RandomNumberService } from '../services/random-number';
@@ -68,7 +68,7 @@ them into our component:
6868

6969
```typescript
7070
import { Component } from '@angular/core';
71-
import { NgRedux, select } from 'ngredux-store';
71+
import { NgRedux, select } from '@adrian.insua/ngredux-store';
7272
import { CounterActions } from '../actions/counter-actions';
7373
import { RandomNumberService } from '../services/random-number';
7474

@@ -132,7 +132,7 @@ properly-bound function context.
132132

133133
```typescript
134134
import { NgModule } from '@angular/core';
135-
import { NgReduxModule, NgRedux } from 'ngredux-store';
135+
import { NgReduxModule, NgRedux } from '@adrian.insua/ngredux-store';
136136
import reduxLogger from 'redux-logger';
137137
import { LogRemoteName } from './middleware/log-remote-name';
138138

@@ -154,7 +154,7 @@ export class AppModule {
154154

155155
## Side-Effect Management Using Epics
156156

157-
`ngredux-store` also works well with the `Epic` feature of
157+
`@adrian.insua/ngredux-store` also works well with the `Epic` feature of
158158
[redux-observable](https://github.com/redux-observable). For
159159
example, a common use case for a side-effect is making an API call; while
160160
we can use asynchronous actions for this, epics provide a much cleaner
@@ -167,7 +167,7 @@ create some trivial actions:
167167

168168
```typescript
169169
import { Injectable } from '@angular/core';
170-
import { NgRedux } from 'ngredux-store';
170+
import { NgRedux } from '@adrian.insua/ngredux-store';
171171
import { IAppState } from '../reducers';
172172

173173
@Injectable()
@@ -241,7 +241,7 @@ This allows us to configure our Redux store with the new epic as follows:
241241

242242
```typescript
243243
import { NgModule } from '@angular/core';
244-
import { NgReduxModule, NgRedux } from 'ngredux-store';
244+
import { NgReduxModule, NgRedux } from '@adrian.insua/ngredux-store';
245245
import { createEpicMiddleware } from 'redux-observable';
246246
import rootReducer from './reducers';
247247
import { SessionEpics } from './epics';
@@ -269,7 +269,7 @@ side effects as a set of simple RxJS epics.
269269

270270
## Using DevTools
271271

272-
`ngredux-store` is fully compatible with the Chrome extension version of the Redux dev
272+
`@adrian.insua/ngredux-store` is fully compatible with the Chrome extension version of the Redux dev
273273
tools:
274274

275275
https://github.com/zalmoxisus/redux-devtools-extension
@@ -284,7 +284,7 @@ tools that handles this for you.
284284
Here's how to hook the extension up to your app:
285285

286286
```typescript
287-
import { NgReduxModule, NgRedux, DevToolsExtension } from 'ngredux-store';
287+
import { NgReduxModule, NgRedux, DevToolsExtension } from '@adrian.insua/ngredux-store';
288288

289289
// Add the dev tools enhancer your ngRedux.configureStore called
290290
// when you initialize your root component:
@@ -435,7 +435,7 @@ constructor() {
435435
436436
### Post 3.3.0:
437437
438-
In `ngredux-store` 3.3.0 we've allowed you to have your cake and eat it too: the
438+
In `@adrian.insua/ngredux-store` 3.3.0 we've allowed you to have your cake and eat it too: the
439439
`@select` decorator can now detect if the selected state is an ImmutableJS
440440
construct and call `.get` or `.getIn` for you.
441441

0 commit comments

Comments
 (0)