Merge pull request #131 from remarkablemark/build/package

chore: upgrade dependencies, update docs, move TypeScript tests

Author: remarkablemark

.travis.yml

@@ -7,7 +7,7 @@ script:
   # Lint last commit message from history
   - npx commitlint --from=HEAD~1
   - npm run lint
-  - npm run dtslint
+  - npm run lint:dts
   - npm run test:coverage
   - npm run build
   - npm run benchmark

CONTRIBUTING.md

@@ -0,0 +1,96 @@
+# Contributing
+
+All pull requests are welcome! By participating in this project, you
+agree to abide by our **[code of conduct]**.
+
+[code of conduct]: https://github.com/remarkablemark/html-react-parser/blob/master/CODE_OF_CONDUCT.md
+
+[Fork], then clone the repository:
+
+[fork]: https://github.com/remarkablemark/html-react-parser/fork
+
+```sh
+# replace `<user>` with your username
+$ git clone git@github.com:<user>/html-react-parser.git
+$ cd html-react-parser
+```
+
+Install package dependencies:
+
+```sh
+$ npm install
+```
+
+Make your change. Add tests and/or documentation. Ensure all tests and lint pass:
+
+```sh
+$ npm test
+$ npm run lint
+```
+
+Push to your fork and [submit a pull request][pr].
+
+[pr]: https://github.com/remarkablemark/html-react-parser/compare/
+
+At this point you're waiting on us. We like to comment on pull requests
+within three business days (and, typically, one business day). We may suggest
+changes, improvements, or alternatives.
+
+Things that will improve the chance that your pull request will be accepted:
+
+- [ ] Write tests that pass [CI].
+- [ ] Write good documentation.
+- [ ] Write a [good commit message][commit].
+
+[ci]: https://travis-ci.org/remarkablemark/html-react-parser
+[commit]: https://www.conventionalcommits.org/
+
+## Test
+
+Run tests:
+
+```sh
+$ npm test
+```
+
+Run tests with coverage:
+
+```sh
+$ npm run test:coverage
+```
+
+View coverage report in your browser:
+
+```sh
+$ npm run test:coverage:report
+$ open coverage/index.html
+```
+
+## Lint
+
+Lint codebase:
+
+```sh
+$ npm run lint
+```
+
+Fix lint errors:
+
+```sh
+$ npm run lint:fix
+```
+
+Test TypeScript declaration file for style and correctness:
+
+```sh
+$ npm run lint:dts
+```
+
+## Release
+
+Only collaborators with credentials can release and publish:
+
+```sh
+$ npm run release
+$ npm publish && git push --follow-tags
+```

README.md

@@ -242,40 +242,6 @@ Although `<script>` tags and their contents are rendered on the server-side, the
 
 This is because [inline event handlers](https://developer.mozilla.org/docs/Web/Guide/Events/Event_handlers) (e.g., `onclick`) are parsed as a _string_ instead of a _function_. See [#73](https://github.com/remarkablemark/html-react-parser/issues/73).
 
-## Testing
-
-Run tests:
-
-```sh
-$ npm test
-```
-
-Run tests with coverage:
-
-```sh
-$ npm run test:coverage
-```
-
-View coverage in browser:
-
-```sh
-$ npm run test:coverage:report
-$ open coverage/index.html
-```
-
-Lint files:
-
-```sh
-$ npm run lint
-$ npm run dtslint
-```
-
-Fix lint errors:
-
-```sh
-$ npm run lint:fix
-```
-
 ## Benchmarks
 
 ```sh
@@ -290,44 +256,36 @@ html-to-react - Multiple x 139,780 ops/sec ±2.32% (87 runs sampled)
 html-to-react - Complex x 8,118 ops/sec ±2.99% (82 runs sampled)
 ```
 
-## Release
-
-Only collaborators with credentials can release and publish:
-
-```sh
-$ npm run release
-$ git push --follow-tags && npm publish
-```
-
 ## Contributors
 
 ### Code Contributors
 
-This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
-<a href="https://github.com/remarkablemark/html-react-parser/graphs/contributors"><img src="https://opencollective.com/html-react-parser/contributors.svg?width=890&button=false" /></a>
+This project exists thanks to all the people who contribute. [[Contribute](https://github.com/remarkablemark/html-react-parser/blob/master/CONTRIBUTING.md)].
+
+[![Code Contributors](https://opencollective.com/html-react-parser/contributors.svg?width=890&button=false)](https://github.com/remarkablemark/html-react-parser/graphs/contributors)
 
 ### Financial Contributors
 
 Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/html-react-parser/contribute)]
 
 #### Individuals
 
-<a href="https://opencollective.com/html-react-parser"><img src="https://opencollective.com/html-react-parser/individuals.svg?width=890"></a>
+[![Financial Contributors - Individuals](https://opencollective.com/html-react-parser/individuals.svg?width=890)](https://opencollective.com/html-react-parser)
 
 #### Organizations
 
 Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/html-react-parser/contribute)]
 
-<a href="https://opencollective.com/html-react-parser/organization/0/website"><img src="https://opencollective.com/html-react-parser/organization/0/avatar.svg"></a>
-<a href="https://opencollective.com/html-react-parser/organization/1/website"><img src="https://opencollective.com/html-react-parser/organization/1/avatar.svg"></a>
-<a href="https://opencollective.com/html-react-parser/organization/2/website"><img src="https://opencollective.com/html-react-parser/organization/2/avatar.svg"></a>
-<a href="https://opencollective.com/html-react-parser/organization/3/website"><img src="https://opencollective.com/html-react-parser/organization/3/avatar.svg"></a>
-<a href="https://opencollective.com/html-react-parser/organization/4/website"><img src="https://opencollective.com/html-react-parser/organization/4/avatar.svg"></a>
-<a href="https://opencollective.com/html-react-parser/organization/5/website"><img src="https://opencollective.com/html-react-parser/organization/5/avatar.svg"></a>
-<a href="https://opencollective.com/html-react-parser/organization/6/website"><img src="https://opencollective.com/html-react-parser/organization/6/avatar.svg"></a>
-<a href="https://opencollective.com/html-react-parser/organization/7/website"><img src="https://opencollective.com/html-react-parser/organization/7/avatar.svg"></a>
-<a href="https://opencollective.com/html-react-parser/organization/8/website"><img src="https://opencollective.com/html-react-parser/organization/8/avatar.svg"></a>
-<a href="https://opencollective.com/html-react-parser/organization/9/website"><img src="https://opencollective.com/html-react-parser/organization/9/avatar.svg"></a>
+[![Financial Contributors - Organization 0](https://opencollective.com/html-react-parser/organization/0/avatar.svg)](https://opencollective.com/html-react-parser/organization/0/website)
+[![Financial Contributors - Organization 1](https://opencollective.com/html-react-parser/organization/1/avatar.svg)](https://opencollective.com/html-react-parser/organization/1/website)
+[![Financial Contributors - Organization 2](https://opencollective.com/html-react-parser/organization/2/avatar.svg)](https://opencollective.com/html-react-parser/organization/2/website)
+[![Financial Contributors - Organization 3](https://opencollective.com/html-react-parser/organization/3/avatar.svg)](https://opencollective.com/html-react-parser/organization/3/website)
+[![Financial Contributors - Organization 4](https://opencollective.com/html-react-parser/organization/4/avatar.svg)](https://opencollective.com/html-react-parser/organization/4/website)
+[![Financial Contributors - Organization 5](https://opencollective.com/html-react-parser/organization/5/avatar.svg)](https://opencollective.com/html-react-parser/organization/5/website)
+[![Financial Contributors - Organization 6](https://opencollective.com/html-react-parser/organization/6/avatar.svg)](https://opencollective.com/html-react-parser/organization/6/website)
+[![Financial Contributors - Organization 7](https://opencollective.com/html-react-parser/organization/7/avatar.svg)](https://opencollective.com/html-react-parser/organization/7/website)
+[![Financial Contributors - Organization 8](https://opencollective.com/html-react-parser/organization/8/avatar.svg)](https://opencollective.com/html-react-parser/organization/8/website)
+[![Financial Contributors - Organization 9](https://opencollective.com/html-react-parser/organization/9/avatar.svg)](https://opencollective.com/html-react-parser/organization/9/website)
 
 ## Support
 

package.json

@@ -12,8 +12,8 @@
     "clean": "rimraf dist",
     "coveralls": "nyc report --reporter=text-lcov | coveralls",
     "lint": "eslint --ignore-path .gitignore --ignore-pattern /examples/ .",
+    "lint:dts": "dtslint .",
     "lint:fix": "npm run lint -- --fix",
-    "dtslint": "dtslint .",
     "prepublishOnly": "npm run lint && npm run dtslint && npm test && npm run build",
     "release": "standard-version --no-verify",
     "test": "mocha",
@@ -38,32 +38,32 @@
     "@types/domhandler": "2.4.1",
     "html-dom-parser": "0.2.3",
     "react-property": "1.0.1",
-    "style-to-object": "0.2.3"
+    "style-to-object": "0.3.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "^8.0.0",
-    "@commitlint/config-conventional": "^8.0.0",
-    "@types/react": "^16.8.22",
+    "@commitlint/cli": "^8.2.0",
+    "@commitlint/config-conventional": "^8.2.0",
+    "@types/react": "^16.9.11",
     "benchmark": "^2.1.4",
-    "coveralls": "^3.0.4",
-    "cross-env": "^5.2.0",
-    "dtslint": "^0.8.0",
-    "eslint": "^6.0.0",
-    "eslint-plugin-prettier": "^3.1.0",
-    "husky": "^2.4.1",
-    "lint-staged": "^8.2.1",
-    "mocha": "^6.1.4",
+    "coveralls": "^3.0.7",
+    "cross-env": "^6.0.3",
+    "dtslint": "^2.0.0",
+    "eslint": "^6.6.0",
+    "eslint-plugin-prettier": "^3.1.1",
+    "husky": "^3.0.9",
+    "lint-staged": "^9.4.2",
+    "mocha": "^6.2.2",
     "nyc": "^14.1.1",
-    "preact": "10.0.4",
-    "prettier": "^1.18.2",
+    "preact": "^10.0.4",
+    "prettier": "^1.19.1",
     "react": "^16",
     "react-dom": "^16",
-    "rimraf": "^2.6.3",
-    "rollup": "^1.16.2",
-    "rollup-plugin-commonjs": "^10.0.0",
-    "rollup-plugin-node-resolve": "^5.0.4",
-    "rollup-plugin-uglify": "^6.0.2",
-    "standard-version": "^6.0.1"
+    "rimraf": "^3.0.0",
+    "rollup": "^1.26.3",
+    "rollup-plugin-commonjs": "^10.1.0",
+    "rollup-plugin-node-resolve": "^5.2.0",
+    "rollup-plugin-uglify": "^6.0.3",
+    "standard-version": "^6"
   },
   "peerDependencies": {
     "react": "^0.14 || ^15 || ^16"

lint/types/index.test.tsx renamed to test/types/index.test.tsx

@@ -10,13 +10,16 @@
     "types": [],
     "noEmit": true,
     "forceConsistentCasingInFileNames": true,
-    "paths": { "html-react-parser": ["."], "html-react-parser/lib/*": ["./lib/*"] },
+    "paths": {
+      "html-react-parser": ["."],
+      "html-react-parser/lib/*": ["./lib/*"]
+    },
     "jsx": "react"
   },
   "files": [
     "index.d.ts",
     "lib/dom-to-react.d.ts",
-    "lint/types/index.test.tsx",
-    "lint/types/lib/dom-to-react.test.tsx"
+    "test/types/index.test.tsx",
+    "test/types/lib/dom-to-react.test.tsx"
   ]
 }