Skip to content
This repository was archived by the owner on Mar 20, 2022. It is now read-only.

Commit c2ab080

Browse files
paularmstrongpaularmstrong
committed
end: no longer maintained
1 parent a213bbc commit c2ab080

File tree

4 files changed

+132
-113
lines changed

4 files changed

+132
-113
lines changed

Diff for: ‎.github/workflows/close-pull-request.yml

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
name: Close Pull Request
2+
3+
on:
4+
pull_request_target:
5+
types: [opened]
6+
7+
jobs:
8+
run:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: superbrothers/close-pull-request@v3
12+
with:
13+
comment: 'Normalizr is no longer maintained and does not accept pull requests. Please maintain your own fork of this repository.'

Diff for: ‎README.md

+9-109
Original file line numberDiff line numberDiff line change
@@ -1,119 +1,19 @@
11
# normalizr [![build status](https://img.shields.io/travis/paularmstrong/normalizr/master.svg?style=flat-square)](https://travis-ci.org/paularmstrong/normalizr) [![Coverage Status](https://img.shields.io/coveralls/paularmstrong/normalizr/master.svg?style=flat-square)](https://coveralls.io/github/paularmstrong/normalizr?branch=master) [![npm version](https://img.shields.io/npm/v/normalizr.svg?style=flat-square)](https://www.npmjs.com/package/normalizr) [![npm downloads](https://img.shields.io/npm/dm/normalizr.svg?style=flat-square)](https://www.npmjs.com/package/normalizr)
22

3-
# [📣 🤝 Maintainer help wanted ](https://github.com/paularmstrong/normalizr/discussions/493)
3+
# 📣 Normalizr is no longer maintained
44

5-
## Install
5+
Due to lack of ability to find an invested maintainer and inability to find time to do routine maintenance and community building, this package is no longer maintained. Please see the discussion [🤝 Maintainer help wanted](https://github.com/paularmstrong/normalizr/discussions/493) for more information.
66

7-
Install from the NPM repository using yarn or npm:
7+
## FAQs
88

9-
```shell
10-
yarn add normalizr
11-
```
9+
### Should I still use Normalizr?
1210

13-
```shell
14-
npm install normalizr
15-
```
11+
If you need it, yes. Normalizr is and has been at a stable release for a very long time, used by thousands of others without issue.
1612

17-
## Motivation
13+
### What should I do if I want other features or found a bug?
1814

19-
Many APIs, public or not, return JSON data that has deeply nested objects. Using data in this kind of structure is often very difficult for JavaScript applications, especially those using [Flux](http://facebook.github.io/flux/) or [Redux](http://redux.js.org/).
15+
Fork [Normalizr on Github](https://github.com/paularmstrong/normalizr) and maintain a version yourself.
2016

21-
## Solution
17+
### Can I contribute back to Normalizr?
2218

23-
Normalizr is a small, but powerful utility for taking JSON with a schema definition and returning nested entities with their IDs, gathered in dictionaries.
24-
25-
## Documentation
26-
27-
* [Introduction](/docs/introduction.md)
28-
* [Build Files](/docs/introduction.md#build-files)
29-
* [Quick Start](/docs/quickstart.md)
30-
* [API](/docs/api.md)
31-
* [normalize](/docs/api.md#normalizedata-schema)
32-
* [denormalize](/docs/api.md#denormalizeinput-schema-entities)
33-
* [schema](/docs/api.md#schema)
34-
* [Using with JSONAPI](/docs/jsonapi.md)
35-
36-
## Examples
37-
38-
* [Normalizing GitHub Issues](/examples/github)
39-
* [Relational Data](/examples/relationships)
40-
* [Interactive Redux](/examples/redux)
41-
42-
## Quick Start
43-
44-
Consider a typical blog post. The API response for a single post might look something like this:
45-
46-
```json
47-
{
48-
"id": "123",
49-
"author": {
50-
"id": "1",
51-
"name": "Paul"
52-
},
53-
"title": "My awesome blog post",
54-
"comments": [
55-
{
56-
"id": "324",
57-
"commenter": {
58-
"id": "2",
59-
"name": "Nicole"
60-
}
61-
}
62-
]
63-
}
64-
```
65-
66-
We have two nested entity types within our `article`: `users` and `comments`. Using various `schema`, we can normalize all three entity types down:
67-
68-
```js
69-
import { normalize, schema } from 'normalizr';
70-
71-
// Define a users schema
72-
const user = new schema.Entity('users');
73-
74-
// Define your comments schema
75-
const comment = new schema.Entity('comments', {
76-
commenter: user
77-
});
78-
79-
// Define your article
80-
const article = new schema.Entity('articles', {
81-
author: user,
82-
comments: [comment]
83-
});
84-
85-
const normalizedData = normalize(originalData, article);
86-
```
87-
88-
Now, `normalizedData` will be:
89-
90-
```js
91-
{
92-
result: "123",
93-
entities: {
94-
"articles": {
95-
"123": {
96-
id: "123",
97-
author: "1",
98-
title: "My awesome blog post",
99-
comments: [ "324" ]
100-
}
101-
},
102-
"users": {
103-
"1": { "id": "1", "name": "Paul" },
104-
"2": { "id": "2", "name": "Nicole" }
105-
},
106-
"comments": {
107-
"324": { id: "324", "commenter": "2" }
108-
}
109-
}
110-
}
111-
```
112-
113-
## Dependencies
114-
115-
None.
116-
117-
## Credits
118-
119-
Normalizr was originally created by [Dan Abramov](http://github.com/gaearon) and inspired by a conversation with [Jing Chen](https://twitter.com/jingc). Since v3, it was completely rewritten and maintained by [Paul Armstrong](https://twitter.com/paularmstrong). It has also received much help, enthusiasm, and contributions from [community members](https://github.com/paularmstrong/normalizr/graphs/contributors).
19+
There are no current plans to resurrect this origin of Normalizr. If a forked version becomes sufficiently maintained and popular, please reach out about merging the fork and changing maintainers.

Diff for: ‎docs/README.md

+109-3
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,117 @@
1-
# Table of Contents
1+
# normalizr [![build status](https://img.shields.io/travis/paularmstrong/normalizr/master.svg?style=flat-square)](https://travis-ci.org/paularmstrong/normalizr) [![Coverage Status](https://img.shields.io/coveralls/paularmstrong/normalizr/master.svg?style=flat-square)](https://coveralls.io/github/paularmstrong/normalizr?branch=master) [![npm version](https://img.shields.io/npm/v/normalizr.svg?style=flat-square)](https://www.npmjs.com/package/normalizr) [![npm downloads](https://img.shields.io/npm/dm/normalizr.svg?style=flat-square)](https://www.npmjs.com/package/normalizr)
2+
3+
## Install
4+
5+
Install from the NPM repository using yarn or npm:
6+
7+
```shell
8+
yarn add normalizr
9+
```
10+
11+
```shell
12+
npm install normalizr
13+
```
14+
15+
## Motivation
16+
17+
Many APIs, public or not, return JSON data that has deeply nested objects. Using data in this kind of structure is often very difficult for JavaScript applications, especially those using [Flux](http://facebook.github.io/flux/) or [Redux](http://redux.js.org/).
18+
19+
## Solution
20+
21+
Normalizr is a small, but powerful utility for taking JSON with a schema definition and returning nested entities with their IDs, gathered in dictionaries.
22+
23+
## Documentation
224

3-
- [Read Me](/README.md)
425
- [Introduction](/docs/introduction.md)
26+
- [Build Files](/docs/introduction.md#build-files)
527
- [Quick Start](/docs/quickstart.md)
628
- [API](/docs/api.md)
729
- [normalize](/docs/api.md#normalizedata-schema)
830
- [denormalize](/docs/api.md#denormalizeinput-schema-entities)
931
- [schema](/docs/api.md#schema)
10-
- [Frequently Asked Questions](/docs/faqs.md)
1132
- [Using with JSONAPI](/docs/jsonapi.md)
33+
34+
## Examples
35+
36+
- [Normalizing GitHub Issues](/examples/github)
37+
- [Relational Data](/examples/relationships)
38+
- [Interactive Redux](/examples/redux)
39+
40+
## Quick Start
41+
42+
Consider a typical blog post. The API response for a single post might look something like this:
43+
44+
```json
45+
{
46+
"id": "123",
47+
"author": {
48+
"id": "1",
49+
"name": "Paul"
50+
},
51+
"title": "My awesome blog post",
52+
"comments": [
53+
{
54+
"id": "324",
55+
"commenter": {
56+
"id": "2",
57+
"name": "Nicole"
58+
}
59+
}
60+
]
61+
}
62+
```
63+
64+
We have two nested entity types within our `article`: `users` and `comments`. Using various `schema`, we can normalize all three entity types down:
65+
66+
```js
67+
import { normalize, schema } from 'normalizr';
68+
69+
// Define a users schema
70+
const user = new schema.Entity('users');
71+
72+
// Define your comments schema
73+
const comment = new schema.Entity('comments', {
74+
commenter: user,
75+
});
76+
77+
// Define your article
78+
const article = new schema.Entity('articles', {
79+
author: user,
80+
comments: [comment],
81+
});
82+
83+
const normalizedData = normalize(originalData, article);
84+
```
85+
86+
Now, `normalizedData` will be:
87+
88+
```js
89+
{
90+
result: "123",
91+
entities: {
92+
"articles": {
93+
"123": {
94+
id: "123",
95+
author: "1",
96+
title: "My awesome blog post",
97+
comments: [ "324" ]
98+
}
99+
},
100+
"users": {
101+
"1": { "id": "1", "name": "Paul" },
102+
"2": { "id": "2", "name": "Nicole" }
103+
},
104+
"comments": {
105+
"324": { id: "324", "commenter": "2" }
106+
}
107+
}
108+
}
109+
```
110+
111+
## Dependencies
112+
113+
None.
114+
115+
## Credits
116+
117+
Normalizr was originally created by [Dan Abramov](http://github.com/gaearon) and inspired by a conversation with [Jing Chen](https://twitter.com/jingc). Since v3, it was completely rewritten and maintained by [Paul Armstrong](https://twitter.com/paularmstrong). It has also received much help, enthusiasm, and contributions from [community members](https://github.com/paularmstrong/normalizr/graphs/contributors).

Diff for: ‎package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "normalizr",
3-
"version": "3.6.1",
3+
"version": "3.6.2",
44
"description": "Normalizes and denormalizes JSON according to schema for Redux and Flux applications",
55
"bugs": {
66
"url": "https://github.com/paularmstrong/normalizr/issues"

0 commit comments

Comments
 (0)