chore: prettier (#24)

Add prettier settings for code style.
kaltura · Jul 16, 2018 · ad63326 · ad63326
1 parent e461745
commit ad63326
Show file tree

Hide file tree

Showing 17 changed files with 1,106 additions and 215 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -1,14 +1,7 @@
 {
   "parser": "babel-eslint",
-  "extends": [
-    "eslint:recommended",
-    "plugin:flowtype/recommended"
-  ],
-  "plugins": [
-    "import",
-    "flowtype",
-    "mocha-no-only"
-  ],
+  "extends": ["eslint:recommended", "plugin:flowtype/recommended"],
+  "plugins": ["prettier", "import", "flowtype", "mocha-no-only"],
   "env": {
     "browser": true,
     "es6": true,
@@ -23,12 +16,9 @@
     "__NAME__": true
   },
   "rules": {
+    "prettier/prettier": "error",
     "mocha-no-only/mocha-no-only": "off",
-    "require-jsdoc": [
-      "error"
-    ],
-    "valid-jsdoc": [
-      "error"
-    ]
+    "require-jsdoc": ["error"],
+    "valid-jsdoc": ["error"]
   }
 }
diff --git a/.flowconfig b/.flowconfig
@@ -1,6 +1,5 @@
 [ignore]
-.*/node_modules/conventional-changelog-core/test/fixtures/_malformation.json
-.*/node_modules/playkit-js/src/
+.*/node_modules
 [include]
 [libs]
 node_modules/playkit-js/flow-typed/

diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,8 @@
+/dist
+/src/index.html
+CHANGELOG.md
+yarn.lock
+yarn-error.log
+LICENSE
+/samples
+src/youbora.lib.min.js
diff --git a/.prettierrc b/.prettierrc
@@ -0,0 +1,12 @@
+{
+  "printWidth": 150,
+  "tabWidth": 2,
+  "useTabs": false,
+  "semi": true,
+  "singleQuote": true,
+  "trailingComma": "none",
+  "bracketSpacing": false,
+  "jsxBracketSameLine": true,
+  "arrowParens": "avoid",
+  "proseWrap": "preserve"
+}
diff --git a/README.md b/README.md
@@ -1,25 +1,27 @@
 # PlayKit JS Youbora - [Youbora analytics SDK] plugin for the [PlayKit JS Player]
 
 [![Build Status](https://travis-ci.org/kaltura/playkit-js-youbora.svg?branch=master)](https://travis-ci.org/kaltura/playkit-js-youbora)
+[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
 
 PlayKit JS Youbora plugin integrates [Youbora analytics SDK] with the [PlayKit JS Player].
- 
+
 PlayKit JS Youbora is written in [ECMAScript6], statically analysed using [Flow] and transpiled in ECMAScript5 using [Babel].
 
-[Youbora analytics SDK]: https://nicepeopleatwork.com/youbora/
-[NPAW developer portal]: http://developer.nicepeopleatwork.com/
-[Flow]: https://flow.org/
-[ECMAScript6]: https://github.com/ericdouglas/ES6-Learning#articles--tutorials
-[Babel]: https://babeljs.io
+[youbora analytics sdk]: https://nicepeopleatwork.com/youbora/
+[npaw developer portal]: http://developer.nicepeopleatwork.com/
+[flow]: https://flow.org/
+[ecmascript6]: https://github.com/ericdouglas/ES6-Learning#articles--tutorials
+[babel]: https://babeljs.io
 
 ## Getting Started
 
 ### Prerequisites
+
 The plugin requires [PlayKit JS Player] to be loaded first.
 
 The plugin uses the [Youbora analytics SDK] for HTML5.
 
-[Playkit JS Player]: https://github.com/kaltura/playkit-js
+[playkit js player]: https://github.com/kaltura/playkit-js
 
 ### Installing
 
@@ -77,12 +79,14 @@ For full Youbora options see: http://developer.nicepeopleatwork.com/apidocs/js/$
 
 Tests can be run locally via [Karma], which will run on Chrome, Firefox and Safari
 
-[Karma]: https://karma-runner.github.io/1.0/index.html
+[karma]: https://karma-runner.github.io/1.0/index.html
+
 ```
 yarn run test
 ```
 
 You can test individual browsers:
+
 ```
 yarn run test:chrome
 yarn run test:firefox
@@ -97,7 +101,6 @@ See [ESLint config](.eslintrc.json) for full configuration.
 
 We also use [.editorconfig](.editorconfig) to maintain consistent coding styles and settings, please make sure you comply with the styling.
 
-
 ## Compatibility
 
 TBD
@@ -108,7 +111,7 @@ Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c6
 
 ## Versioning
 
-We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/kaltura/playkit-js-youbora/tags). 
+We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/kaltura/playkit-js-youbora/tags).
 
 ## License
 

diff --git a/flow-typed/modules/playkit-js.js b/flow-typed/modules/playkit-js.js
@@ -0,0 +1,4 @@
+// @flow
+declare module 'playkit-js' {
+  declare module.exports: any;
+}
diff --git a/karma.conf.js b/karma.conf.js
@@ -14,39 +14,26 @@ const customLaunchers = {
   }
 };
 
-module.exports = function (config) {
+module.exports = function(config) {
   let karmaConf = {
     logLevel: config.LOG_INFO,
-    browsers: [
-      'Chrome',
-      'Firefox'
-    ],
+    browsers: ['Chrome', 'Firefox'],
     concurrency: 1,
     singleRun: true,
     colors: true,
-    frameworks: [
-      'mocha'
-    ],
+    frameworks: ['mocha'],
     files: [
-      'test/setup/karma.js', {
+      'test/setup/karma.js',
+      {
         pattern: 'src/assets/audios.mp4',
         included: false
       }
     ],
     preprocessors: {
-      'src/**/*.js': [
-        'webpack',
-        'sourcemap'
-      ],
-      'test/setup/karma.js': [
-        'webpack',
-        'sourcemap'
-      ]
+      'src/**/*.js': ['webpack', 'sourcemap'],
+      'test/setup/karma.js': ['webpack', 'sourcemap']
     },
-    reporters: [
-      'progress',
-      'coverage'
-    ],
+    reporters: ['progress', 'coverage'],
     webpack: webpackConfig,
     webpackServer: {
       noInfo: true
@@ -61,9 +48,7 @@ module.exports = function (config) {
 
   if (process.env.TRAVIS) {
     karmaConf.customLaunchers = customLaunchers;
-    karmaConf.browsers = [
-      'Chrome_travis_ci'
-    ];
+    karmaConf.browsers = ['Chrome_travis_ci'];
   } else {
     if (isWindows) {
       karmaConf.browsers.push('IE');

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "playkit-js-youbora",
-  "version": "0.4.2",
+  "version": "0.4.3",
   "main": "dist/playkit-youbora.js",
   "scripts": {
     "clean": "rm -rf ./dist",
@@ -13,7 +13,18 @@
     "publish": "git push --follow-tags --no-verify origin master",
     "eslint": "eslint . --color",
     "flow": "flow check",
-    "commit:dist": "git add --force --all dist && (git commit -m 'chore: update dist' || exit 0)"
+    "commit:dist": "git add --force --all dist && (git commit -m 'chore: update dist' || exit 0)",
+    "precommit": "lint-staged"
+  },
+  "lint-staged": {
+    "*.{js,jsx}": [
+      "eslint --fix",
+      "git add"
+    ],
+    "*.{json,md,scss}": [
+      "prettier --write",
+      "git add"
+    ]
   },
   "standard-version": {
     "scripts": {
@@ -34,11 +45,14 @@
     "cross-env": "^3.1.4",
     "css-loader": "^0.28.4",
     "eslint": "^3.10.0",
+    "eslint-config-prettier": "^2.9.0",
     "eslint-loader": "^1.6.1",
     "eslint-plugin-flowtype": "^2.30.0",
     "eslint-plugin-import": "^2.2.0",
     "eslint-plugin-mocha-no-only": "^0.0.5",
+    "eslint-plugin-prettier": "^2.6.2",
     "flow-bin": "latest",
+    "husky": "^0.14.3",
     "istanbul": "^0.4.5",
     "karma": "^1.5.0",
     "karma-chai": "^0.1.0",
@@ -51,10 +65,11 @@
     "karma-safari-launcher": "^1.0.0",
     "karma-sourcemap-loader": "^0.3.7",
     "karma-webpack": "^2.0.2",
+    "lint-staged": "^7.2.0",
     "mocha": "^3.2.0",
     "mocha-cli": "^1.0.1",
     "playkit-js": "https://github.com/kaltura/playkit-js.git#v0.31.2",
-    "pre-push": "^0.1.1",
+    "prettier": "^1.13.7",
     "sinon": "^2.0.0",
     "sinon-chai": "^2.8.0",
     "standard-version": "^4.2.0",

diff --git a/samples/index.js b/samples/index.js
@@ -1,3 +1,3 @@
-import * as Playkit from 'playkit-js'
+import * as Playkit from 'playkit-js';
 
 window.Playkit = Playkit;
diff --git a/src/index.js b/src/index.js
@@ -1,6 +1,6 @@
 // @flow
-import {registerPlugin} from 'playkit-js'
-import Youbora from './youbora'
+import {registerPlugin} from 'playkit-js';
+import Youbora from './youbora';
 
 declare var __VERSION__: string;
 declare var __NAME__: string;
@@ -13,9 +13,8 @@ export {__VERSION__ as VERSION, __NAME__ as NAME};
  * @type {string}
  * @const
  */
-const pluginName = "youbora";
+const pluginName = 'youbora';
 /**
  * Register the plugin in player's registry.
  */
 registerPlugin(pluginName, Youbora);
-