Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
planttheidea committed Jan 26, 2019
1 parent 8524ed9 commit 6bdf82c
Show file tree
Hide file tree
Showing 6 changed files with 1,301 additions and 1,088 deletions.
3 changes: 2 additions & 1 deletion .npmrc
@@ -1 +1,2 @@
package-lock=false
package-lock=false
scripts-prepend-node-path=true
4 changes: 4 additions & 0 deletions CHANGELOG.md
@@ -1,5 +1,9 @@
# fast-copy CHANGELOG

## 1.2.4

- Ensure `Date` copy uses realm-specific constructor

## 1.2.3

- Support custom prototype applied to plain object via `Object.create()`
Expand Down
9 changes: 2 additions & 7 deletions README.md
Expand Up @@ -153,18 +153,13 @@ Standard practice, clone the repo and `npm i` to get the dependencies. The follo

- benchmark => run benchmark tests against other equality libraries
- build => build dist files with `rollup`
- clean => run `clean:dist`, `clean:es`, and `clean:lib` scripts
- clean:dist => run `rimraf` on the `dist` folder
- clean:es => run `rimraf` on the `es` folder
- clean:lib => run `rimraf` on the `lib` folder
- clean => run `rimraf` on the `dist` folder
- dev => start webpack playground App
- dist => run `build` and `build:minified` scripts
- lint => run ESLint on all files in `src` folder (also runs on `dev` script)
- lint:fix => run `lint` script, but with auto-fixer
- prepublish:compile => run `lint`, `test:coverage`, `transpile:lib`, `transpile:es`, and `dist` scripts
- prepublish:compile => run `lint`, `test:coverage`, and `dist` scripts
- start => run `dev`
- test => run AVA with NODE_ENV=test on all files in `test` folder
- test:coverage => run same script as `test` with code coverage calculation via `nyc`
- test:watch => run same script as `test` but keep persistent watcher
- transpile:es => run Babel on all files in `src` folder (transpiled to `es` folder without transpilation of ES2015 export syntax)
- transpile:lib => run Babel on all files in `src` folder (transpiled to `lib` folder)
19 changes: 7 additions & 12 deletions package.json
Expand Up @@ -31,7 +31,7 @@
"clone": "^2.1.2",
"decircularize": "^1.0.0",
"deep-clone": "^3.0.3",
"deep-eql": "^3.0.1",
"deep-eql": "^4.0.0",
"deep-equal": "^1.0.1",
"deepclone": "^1.0.2",
"eslint": "^5.7.0",
Expand All @@ -51,9 +51,9 @@
"react": "^16.5.2",
"react-dom": "^16.5.2",
"react-fast-compare": "^2.0.2",
"rollup": "^0.66.6",
"rollup": "^1.1.2",
"rollup-plugin-babel": "^4.0.1",
"rollup-plugin-node-resolve": "^3.4.0",
"rollup-plugin-node-resolve": "^4.0.0",
"rollup-plugin-terser": "^4.0.3",
"shallow-equal-fuzzy": "^0.0.2",
"sinon": "^7.0.0",
Expand All @@ -80,22 +80,17 @@
"scripts": {
"benchmark": "npm run build && node benchmark/index.js",
"build": "NODE_ENV=production rollup -c",
"clean": "npm run clean:es && npm run clean:lib && npm run clean:dist",
"clean:dist": "rimraf dist",
"clean:es": "rimraf es",
"clean:lib": "rimraf lib",
"clean": "rimraf dist",
"dev": "NODE_ENV=development webpack-dev-server --colors --progress --config=webpack/webpack.config.dev.js",
"dist": "npm run clean:dist && npm run build",
"dist": "npm run clean && npm run build",
"lint": "NODE_ENV=test eslint src --max-warnings 0",
"lint:fix": "NODE_ENV=test eslint src --fix",
"prepublish": "if in-publish; then npm run prepublish:compile; fi",
"prepublish:compile": "npm run lint && npm run test:coverage && npm run transpile:lib && npm run transpile:es && npm run dist",
"prepublish:compile": "npm run lint && npm run test:coverage && npm run dist",
"start": "npm run dev",
"test": "NODE_PATH=. BABEL_ENV=test ava",
"test:coverage": "nyc npm test",
"test:watch": "npm test -- --watch",
"transpile:es": "npm run clean:es && BABEL_ENV=es babel src --out-dir es",
"transpile:lib": "npm run clean:lib && BABEL_ENV=lib babel src --out-dir lib"
"test:watch": "npm test -- --watch"
},
"types": "index.d.ts",
"version": "1.2.3"
Expand Down
2 changes: 1 addition & 1 deletion src/utils.js
@@ -1,4 +1,4 @@
const {create, keys: getKeys, getOwnPropertySymbols: getSymbols, getPrototypeOf} = Object;
const {create, getOwnPropertySymbols: getSymbols, getPrototypeOf} = Object;
const {hasOwnProperty, propertyIsEnumerable} = Object.prototype;

/**
Expand Down

0 comments on commit 6bdf82c

Please sign in to comment.