Merge pull request #157 from remarkablemark/build/devDependencies

remarkablemark · web-flow · commit 43c6775b951f · 2020-05-25T23:15:00.000-04:00
build: upgrade devDependencies
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -12,6 +12,8 @@
   },
   "plugins": ["prettier"],
   "rules": {
+    "no-debugger": "error",
+    "no-console": "error",
     "prettier/prettier": "error"
   }
 }
diff --git a/.huskyrc b/.huskyrc
diff --git a/.huskyrc.json b/.huskyrc.json
@@ -0,0 +1,6 @@
+{
+  "hooks": {
+    "commit-msg": "commitlint -E HUSKY_GIT_PARAMS",
+    "pre-commit": "npm run lint:dts && npm run test:coverage && lint-staged"
+  }
+}
diff --git a/.lintstagedrc b/.lintstagedrc
diff --git a/.lintstagedrc.json b/.lintstagedrc.json
@@ -0,0 +1,4 @@
+{
+  "*.js": "npm run lint:fix",
+  "*.{html,json,md,yml}": "prettier --write"
+}
diff --git a/.prettierrc b/.prettierrc
diff --git a/.prettierrc.json b/.prettierrc.json
@@ -0,0 +1,5 @@
+{
+  "arrowParens": "avoid",
+  "trailingComma": "none",
+  "singleQuote": true
+}
diff --git a/index.js b/index.js
@@ -7,10 +7,10 @@ var domParserOptions = { decodeEntities: true, lowerCaseAttributeNames: false };
 /**
  * Converts HTML string to React elements.
  *
- * @param  {String}   html              - The HTML string to parse to React.
- * @param  {Object}   [options]         - The parser options.
- * @param  {Function} [options.replace] - The replace method.
- * @return {ReactElement|Array|String}  - When parsed with HTML string, returns React elements; otherwise, returns string or empty array.
+ * @param  {String}   html                    - The HTML string to parse to React.
+ * @param  {Object}   [options]               - The parser options.
+ * @param  {Function} [options.replace]       - The replace method.
+ * @return {JSX.Element|JSX.Element[]|String} - Returns React element(s), string, or empty array.
  */
 function HTMLReactParser(html, options) {
   if (typeof html !== 'string') {
@@ -22,5 +22,6 @@ function HTMLReactParser(html, options) {
 HTMLReactParser.domToReact = domToReact;
 HTMLReactParser.htmlToDOM = htmlToDOM;
 
+// support CommonJS and ES Modules
 module.exports = HTMLReactParser;
 module.exports.default = HTMLReactParser;
diff --git a/lib/attributes-to-props.js b/lib/attributes-to-props.js
@@ -77,7 +77,7 @@ function cssToJs(style) {
   var styleObject = {};
 
   if (style) {
-    styleToObject(style, function(property, value) {
+    styleToObject(style, function (property, value) {
       // skip CSS comment
       if (property && value) {
         styleObject[camelCase(property)] = value;
diff --git a/lib/utilities.js b/lib/utilities.js
@@ -21,7 +21,7 @@ function camelCase(string) {
   // convert to camelCase
   return string
     .toLowerCase()
-    .replace(hyphenPatternRegex, function(_, character) {
+    .replace(hyphenPatternRegex, function (_, character) {
       return character.toUpperCase();
     });
 }
diff --git a/package.json b/package.json
@@ -6,14 +6,12 @@
   "main": "index.js",
   "scripts": {
     "benchmark": "node benchmark",
-    "build": "npm run clean && npm run build:min && npm run build:unmin",
-    "build:min": "cross-env NODE_ENV=production rollup --config --file dist/html-react-parser.min.js --sourcemap",
-    "build:unmin": "cross-env NODE_ENV=development rollup --config --file dist/html-react-parser.js",
+    "build": "rollup --config",
     "clean": "rimraf dist",
     "lint": "eslint --ignore-path .gitignore --ignore-pattern /examples/ .",
     "lint:dts": "dtslint .",
     "lint:fix": "npm run lint -- --fix",
-    "prepublishOnly": "npm run lint && npm run lint:dts && npm test && npm run build",
+    "prepublishOnly": "npm run lint && npm run lint:dts && npm test && npm run clean && npm run build",
     "release": "standard-version --no-verify",
     "test": "mocha",
     "test:coverage": "nyc npm test",
@@ -40,28 +38,28 @@
     "style-to-object": "0.3.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "^8.2.0",
-    "@commitlint/config-conventional": "^8.2.0",
-    "@types/react": "^16.9.11",
+    "@commitlint/cli": "^8.3.5",
+    "@commitlint/config-conventional": "^8.3.4",
+    "@types/react": "^16.9.35",
     "benchmark": "^2.1.4",
-    "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.19.1",
+    "dtslint": "^3.6.4",
+    "eslint": "^7.1.0",
+    "eslint-plugin-prettier": "^3.1.3",
+    "husky": "^4.2.5",
+    "lint-staged": "^10.2.6",
+    "mocha": "^7.2.0",
+    "nyc": "^15.0.1",
+    "preact": "^10.4.4",
+    "prettier": "^2.0.5",
     "react": "^16",
     "react-dom": "^16",
-    "rimraf": "^3.0.0",
-    "rollup": "^1.26.3",
+    "rimraf": "^3.0.2",
+    "rollup": "^1.32.1",
     "rollup-plugin-commonjs": "^10.1.0",
     "rollup-plugin-node-resolve": "^5.2.0",
-    "rollup-plugin-uglify": "^6.0.3",
-    "standard-version": "^6"
+    "rollup-plugin-uglify": "^6.0.4",
+    "standard-version": "^6",
+    "typescript": "^3.9.3"
   },
   "peerDependencies": {
     "react": "^0.14 || ^15 || ^16"
diff --git a/rollup.config.js b/rollup.config.js
@@ -2,21 +2,25 @@ import commonjs from 'rollup-plugin-commonjs';
 import resolve from 'rollup-plugin-node-resolve';
 import { uglify } from 'rollup-plugin-uglify';
 
-const config = {
+/**
+ * Build rollup config for development (default) or production (minify = true).
+ *
+ * @param {Boolean} [minify=false]
+ * @return {Object}
+ */
+const getConfig = (minify = false) => ({
   external: ['react'],
   input: 'index.js',
   output: {
+    file: `dist/html-react-parser${minify ? '.min' : ''}.js`,
     format: 'umd',
     globals: {
       react: 'React'
     },
-    name: 'HTMLReactParser'
+    name: 'HTMLReactParser',
+    sourcemap: true
   },
-  plugins: [commonjs(), resolve({ browser: true })]
-};
+  plugins: [commonjs(), resolve({ browser: true }), minify && uglify()]
+});
 
-if (process.env.NODE_ENV === 'production') {
-  config.plugins.push(uglify());
-}
-
-export default config;
+export default [getConfig(), getConfig(true)];
diff --git a/test/html-to-react.js b/test/html-to-react.js
@@ -1,9 +1,23 @@
 const assert = require('assert');
 const React = require('react');
-const parse = require('../');
+const parse = require('..');
 const { data, render } = require('./helpers/');
 
 describe('html-to-react', () => {
+  describe('exports', () => {
+    it('has default ES Module', () => {
+      assert.strictEqual(parse.default, parse);
+    });
+
+    it('has domToReact', () => {
+      assert.strictEqual(parse.domToReact, require('../lib/dom-to-react'));
+    });
+
+    it('contains htmlToDOM', () => {
+      assert.strictEqual(parse.htmlToDOM, require('html-dom-parser'));
+    });
+  });
+
   describe('parser', () => {
     [undefined, null, {}, [], 42].forEach(value => {
       it(`throws an error if first argument is ${value}`, () => {
@@ -13,10 +27,6 @@ describe('html-to-react', () => {
       });
     });
 
-    it('has default ES Module defined', () => {
-      assert.strictEqual(parse.default, parse);
-    });
-
     it('returns string if it cannot be parsed as HTML', () => {
       assert.strictEqual(parse('foo'), 'foo');
     });
@@ -77,7 +87,7 @@ describe('html-to-react', () => {
 
   describe('options', () => {
     describe('replace', () => {
-      it('overrides the element if replace is valid', () => {
+      it('overrides the element if a valid React element is returned', () => {
         const html = data.html.complex;
         const reactElement = parse(html, {
           replace: node => {
@@ -92,7 +102,7 @@ describe('html-to-react', () => {
         );
       });
 
-      it('does not override the element if replace is invalid', () => {
+      it('does not override the element if an invalid React element is returned', () => {
         const html = data.html.complex;
         const reactElement = parse(html, {
           replace: node => {
@@ -115,9 +125,3 @@ describe('html-to-react', () => {
     });
   });
 });
-
-describe('dom-to-react', () => {
-  it('exports domToReact', () => {
-    assert.strictEqual(parse.domToReact, require('../lib/dom-to-react'));
-  });
-});

Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,8 @@`
`12`	`12`	`},`
`13`	`13`	`"plugins": ["prettier"],`
`14`	`14`	`"rules": {`
	`15`	`+ "no-debugger": "error",`
	`16`	`+ "no-console": "error",`
`15`	`17`	`"prettier/prettier": "error"`
`16`	`18`	`}`
`17`	`19`	`}`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +{
 +  "*.js": "npm run lint:fix",
 +  "*.{html,json,md,yml}": "prettier --write"
 +}
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ function camelCase(string) {`
`21`	`21`	`// convert to camelCase`
`22`	`22`	`return string`
`23`	`23`	`.toLowerCase()`
`24`		`- .replace(hyphenPatternRegex, function(_, character) {`
	`24`	`+ .replace(hyphenPatternRegex, function (_, character) {`
`25`	`25`	`return character.toUpperCase();`
`26`	`26`	`});`
`27`	`27`	`}`