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

Commit

Permalink
Merge cf4118e into 460b182
Browse files Browse the repository at this point in the history
  • Loading branch information
paularmstrong committed Dec 28, 2016
2 parents 460b182 + cf4118e commit c282cf4
Show file tree
Hide file tree
Showing 76 changed files with 6,964 additions and 3,977 deletions.
4 changes: 4 additions & 0 deletions .eslintignore
@@ -0,0 +1,4 @@
dist/*
node_modules/*
examples/*/node_modules/*
coverage/*
154 changes: 154 additions & 0 deletions .eslintrc
@@ -0,0 +1,154 @@
{
// babel parser to support ES6/7 features
"parser": "babel-eslint",
"parserOptions": {
"ecmaVersion": 7,
"ecmaFeatures": {
"experimentalObjectRestSpread": true,
"jsx": true
},
"sourceType": "module"
},
"plugins": [],
"env": {
"es6": true,
"node": true
},
"globals": {
"document": false,
"navigator": false,
"window": false
},
"rules": {
"accessor-pairs": 2,
"array-bracket-spacing": ["error", "always"],
"arrow-parens": [2, "always"],
"arrow-spacing": [2, { "before": true, "after": true }],
"block-spacing": [2, "always"],
"brace-style": [2, "1tbs", { "allowSingleLine": true }],
"camelcase": 0,
"comma-dangle": [2, "never"],
"comma-spacing": [2, { "before": false, "after": true }],
"comma-style": [2, "last"],
"computed-property-spacing": ["error", "never"],
"constructor-super": 2,
"curly": [2, "all"],
"default-case": [2, { commentPattern: '^no default$' }],
"dot-location": [2, "property"],
"eol-last": 2,
"eqeqeq": [2, "allow-null"],
"generator-star-spacing": [2, { "before": true, "after": true }],
"handle-callback-err": [2, "^(err|error)$" ],
"indent": [2, 2, { "SwitchCase": 1 }],
"key-spacing": [2, { "beforeColon": false, "afterColon": true }],
"keyword-spacing": [2, { "before": true, "after": true }],
"max-len": [2, 120, 4],
"new-cap": [2, { "newIsCap": true, "capIsNew": false }],
"new-parens": 2,
"no-alert": 1,
"no-array-constructor": 2,
"no-caller": 2,
"no-case-declarations": 2,
"no-class-assign": 2,
"no-cond-assign": 2,
"no-const-assign": 2,
"no-control-regex": 2,
"no-debugger": 2,
"no-delete-var": 2,
"no-dupe-args": 2,
"no-dupe-class-members": 2,
"no-dupe-keys": 2,
"no-duplicate-case": 2,
"no-duplicate-imports": 2,
"no-empty-character-class": 2,
"no-empty-pattern": 2,
"no-eval": 2,
"no-ex-assign": 2,
"no-extend-native": 2,
"no-extra-bind": 2,
"no-extra-boolean-cast": 2,
"no-extra-parens": [2, "functions"],
"no-extra-semi": 2,
"no-fallthrough": 2,
"no-floating-decimal": 2,
"no-func-assign": 2,
"no-implied-eval": 2,
"no-inner-declarations": [2, "functions"],
"no-invalid-regexp": 2,
"no-irregular-whitespace": 2,
"no-iterator": 2,
"no-label-var": 2,
"no-labels": [2, { "allowLoop": false, "allowSwitch": false }],
"no-lone-blocks": 2,
"no-loop-func": 2,
"no-mixed-spaces-and-tabs": 2,
"no-multi-spaces": 2,
"no-multi-str": 2,
"no-multiple-empty-lines": [2, { "max": 1 }],
"no-native-reassign": 2,
"no-negated-in-lhs": 2,
"no-new": 2,
"no-new-func": 2,
"no-new-object": 2,
"no-new-require": 2,
"no-new-symbol": 2,
"no-new-wrappers": 2,
"no-obj-calls": 2,
"no-octal": 2,
"no-octal-escape": 2,
"no-path-concat": 2,
"no-proto": 2,
"no-redeclare": 2,
"no-regex-spaces": 2,
"no-return-assign": [2, "except-parens"],
"no-script-url": 2,
"no-self-assign": 2,
"no-self-compare": 2,
"no-sequences": 2,
"no-shadow-restricted-names": 2,
"no-spaced-func": 2,
"no-sparse-arrays": 2,
"no-this-before-super": 2,
"no-throw-literal": 2,
"no-trailing-spaces": 2,
"no-undef": 2,
"no-undef-init": 2,
"no-unexpected-multiline": 2,
"no-unmodified-loop-condition": 2,
"no-unneeded-ternary": [2, { "defaultAssignment": false }],
"no-unreachable": 2,
"no-unsafe-finally": 2,
"no-unused-vars": [2, { "vars": "all", "args": "none" }],
"no-useless-call": 2,
"no-useless-computed-key": 2,
"no-useless-concat": 2,
"no-useless-constructor": 2,
"no-useless-escape": 2,
"no-var": 2,
"no-whitespace-before-property": 2,
"no-with": 2,
"object-curly-spacing": ["error", "always"],
"operator-linebreak": [2, "after"],
"padded-blocks": [2, "never"],
"prefer-const": 2,
"prefer-rest-params": 2,
"prefer-template": 2,
"quotes": [2, "single", "avoid-escape"],
"radix": 2,
"rest-spread-spacing": ["error"],
"semi": [2, "always"],
"semi-spacing": [2, { "before": false, "after": true }],
"space-before-blocks": [2, "always"],
"space-before-function-paren": [2, { "anonymous": "always", "named": "never" }],
"space-in-parens": [2, "never"],
"space-infix-ops": 2,
"space-unary-ops": [2, { "words": true, "nonwords": false }],
"spaced-comment": [2, "always", { "markers": ["global", "globals", "eslint", "eslint-disable", "*package", "!", ","] }],
"template-curly-spacing": [2, "never"],
"use-isnan": 2,
"valid-typeof": 2,
"wrap-iife": [2, "outside"],
"yield-star-spacing": [2, "both"],
"yoda": [2, "never"]
}
}
Empty file added .flowconfig
Empty file.
31 changes: 23 additions & 8 deletions .github/ISSUE_TEMPLATE.md
@@ -1,3 +1,7 @@
<!--
If you're looking for help implementing something with normalizr or dealing with data after it's been normalized, you're more likely to get a quick response from somewhere like StackOverflow: http://stackoverflow.com/questions/tagged/normalizr
-->

# Problem

A short explanation of your problem or use-case is helpful!
Expand All @@ -7,19 +11,30 @@ A short explanation of your problem or use-case is helpful!
Here's how I'm using normalizr:

```js
// Add as much relevant code and input as possible
// const mySchema = new Schema('myschema');
// normalize({ .../* fill in some input */ }, mySchema);
// Add as much relevant code and input as possible.
const myData = {
// This section is really helpful! A minimum test case goes a long way!
};
const mySchema = new schema.Entity('myschema');
normalize(myData, mySchema);
```

**Output**

Here's what I expect to see when I run the above:

```js
// What you expect to see after running normalizr with your provided input, schema, etc (above)
// {
// result: [1, 2],
// entities: { ... }
// }
{
result: [1, 2],
entities: { ... }
}
```

Here's what I *actually* see when I run the above:

```js
{
result: [1, 2],
entities: { ... }
}
```
9 changes: 6 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
@@ -1,3 +1,6 @@
<!--
Thank you so much for contributing to open source and the Normalizr project!
-->
# Problem

Explain the problem that this pull request aims to resolve.
Expand All @@ -8,6 +11,6 @@ Explain your approach. Sometimes it helps to justify your approach against some

# TODO

*Fill in the following:*

- [ ] Add & Update Tests
- [ ] Add & update tests
- [ ] Ensure CI is passing (lint, tests, flow)
- [ ] Update relevant documentation
10 changes: 6 additions & 4 deletions .gitignore
@@ -1,5 +1,7 @@
.DS_Store
node_modules
dist
lib
npm-debug.log

node_modules/*
dist/*
*.log
coverage/*
.coveralls.yml
6 changes: 5 additions & 1 deletion .travis.yml
Expand Up @@ -2,5 +2,9 @@ language: node_js
node_js:
- "6"
script:
- npm test
- npm run lint
- npm run flow
- npm run test
- npm run build
after_success:
- npm run test:coverage
25 changes: 25 additions & 0 deletions CHANGELOG.md
@@ -0,0 +1,25 @@
# v3.0.0

The entire normalizr package has been rewritten from v2.x for this version. Please refer to the [documentation](/docs) for all changes.

## Added

* `schema.Entity`
* `processStrategy` for modifying `Entity` objects before they're moved to the `entities` stack.
* `mergeStrategy` for merging with multiple entities with the same ID.
* Added `schema.Object`, with a shorthand of `{}`
* Added `schema.Array`, with a shorthand of `[ schema ]`

## Changed

* `Schema` has been moved to a `schema` namespace, available at `schema.Entity`
* `arrayOf` has been replaced by `schema.Array` or `[]`
* `unionOf` has been replaced by `schema.Union`
* `valuesOf` has been replaced by `schema.Values`

## Removed

* `normalize` no longer accepts an optional `options` argument. All options are assigned at the schema level.
* Entity schema no longer accepts `defaults` as an option. Use a custom `processStrategy` option to apply defaults as needed.
* `assignEntity` has been replaced by `processStrategy`
* `meta` option. See `processStrategy`
41 changes: 41 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,41 @@
# Contributing

## Submitting a Pull Request

First, thank you so much for contributing to open source and the Normalizr project!

Follow the instructions on the Pull Request Template (shown when you open a new PR) and make sure you've done the following:

- [ ] Add & update tests
- [ ] Ensure CI is passing (lint, tests)
- [ ] Update relevant documentation

## Setup

Normalizr uses [yarn](https://yarnpkg.com) for development dependency management. Ensure you have it installed before continuing.

```sh
yarn
```

## Running Tests

```sh
npm run test
```

## Lint

Standard code style is nice. ESLint is used to ensure we continue to write similar code. The following command will also fix simple issues, like spacing and alphabetized imports:

```sh
npm run lint
```

## Building

Normalizr aims to keep its byte-size as low as possible. Ensure your changes don't incur more space than seems necessary for your feature or change:

```sh
npm run build
```
2 changes: 1 addition & 1 deletion LICENSE
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2014 Dan Abramov
Copyright (c) 2016 Dan Abramov, Paul Armstrong

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down

0 comments on commit c282cf4

Please sign in to comment.