feat: add lint config

Author: yugasun

.eslintignore

@@ -1,3 +1,4 @@
 coverage
 dist
 node_modules
+lib

.eslintrc.js

@@ -36,7 +36,7 @@ module.exports = {
     'id-length': [
       'error',
       {
-        min: 2,
+        min: 1,
         max: 50,
         properties: 'never',
         exceptions: ['e', 'i', 'n', 't', 'x', 'y', 'z', '_', '$']

.gitignore

@@ -64,3 +64,5 @@ obj/
 # Tests
 !tests/**/*.zip
 
+yarn.lock
+package-lock.json

.travis.yml

@@ -7,10 +7,4 @@ install:
   - npm install
 
 script:
-  - npm test
-
-notifications:
-  email:
-    recipients:
-      - wjielai@tencent.com
-      - fysntian@tencent.com
+  - npm test

commitlint.config.js

@@ -0,0 +1,9 @@
+const Configuration = {
+  /*
+   * Resolve and load @commitlint/config-conventional from node_modules.
+   * Referenced packages must be installed
+   */
+  extends: ['@commitlint/config-conventional']
+}
+
+module.exports = Configuration

lib/cos/base.js

@@ -2834,7 +2834,7 @@ function submitRequest(params, callback) {
 
   // 处理 headers
   !params.headers && (params.headers = {})
-  params.headers['User-Agent'] = "ServerlessFramework"
+  params.headers['User-Agent'] = 'ServerlessFramework'
 
   // 处理 query
   !params.qs && (params.qs = {})

lib/request/lib/auth.js

@@ -1,13 +1,11 @@
-'use strict'
-
 var caseless = require('caseless')
 var uuid = require('uuid/v4')
 var helpers = require('./helpers')
 
 var md5 = helpers.md5
 var toBase64 = helpers.toBase64
 
-function Auth (request) {
+function Auth(request) {
   // define all public properties here
   this.request = request
   this.hasAuth = false
@@ -17,7 +15,7 @@ function Auth (request) {
   this.pass = null
 }
 
-Auth.prototype.basic = function (user, pass, sendImmediately) {
+Auth.prototype.basic = function(user, pass, sendImmediately) {
   var self = this
   if (typeof user !== 'string' || (pass !== undefined && typeof pass !== 'string')) {
     self.request.emit('error', new Error('auth() received invalid user or password'))
@@ -33,7 +31,7 @@ Auth.prototype.basic = function (user, pass, sendImmediately) {
   }
 }
 
-Auth.prototype.bearer = function (bearer, sendImmediately) {
+Auth.prototype.bearer = function(bearer, sendImmediately) {
   var self = this
   self.bearerToken = bearer
   self.hasAuth = true
@@ -47,7 +45,7 @@ Auth.prototype.bearer = function (bearer, sendImmediately) {
   }
 }
 
-Auth.prototype.digest = function (method, path, authHeader) {
+Auth.prototype.digest = function(method, path, authHeader) {
   // TODO: More complete implementation of RFC 2617.
   //   - handle challenge.domain
   //   - support qop="auth-int" only
@@ -78,19 +76,25 @@ Auth.prototype.digest = function (method, path, authHeader) {
    * If the algorithm directive's value is "MD5-sess", then HA1 is
    *   HA1=MD5(MD5(username:realm:password):nonce:cnonce)
    */
-  var ha1Compute = function (algorithm, user, realm, pass, nonce, cnonce) {
+  var ha1Compute = function(algorithm, user, realm, pass, nonce, cnonce) {
     var ha1 = md5(user + ':' + realm + ':' + pass)
     if (algorithm && algorithm.toLowerCase() === 'md5-sess') {
       return md5(ha1 + ':' + nonce + ':' + cnonce)
-    } else {
-      return ha1
     }
+    return ha1
   }
 
   var qop = /(^|,)\s*auth\s*($|,)/.test(challenge.qop) && 'auth'
   var nc = qop && '00000001'
   var cnonce = qop && uuid().replace(/-/g, '')
-  var ha1 = ha1Compute(challenge.algorithm, self.user, challenge.realm, self.pass, challenge.nonce, cnonce)
+  var ha1 = ha1Compute(
+    challenge.algorithm,
+    self.user,
+    challenge.realm,
+    self.pass,
+    challenge.nonce,
+    cnonce
+  )
   var ha2 = md5(method + ':' + path)
   var digestResponse = qop
     ? md5(ha1 + ':' + challenge.nonce + ':' + nc + ':' + cnonce + ':' + qop + ':' + ha2)
@@ -123,7 +127,7 @@ Auth.prototype.digest = function (method, path, authHeader) {
   return authHeader
 }
 
-Auth.prototype.onRequest = function (user, pass, sendImmediately, bearer) {
+Auth.prototype.onRequest = function(user, pass, sendImmediately, bearer) {
   var self = this
   var request = self.request
 
@@ -140,11 +144,13 @@ Auth.prototype.onRequest = function (user, pass, sendImmediately, bearer) {
   }
 }
 
-Auth.prototype.onResponse = function (response) {
+Auth.prototype.onResponse = function(response) {
   var self = this
   var request = self.request
 
-  if (!self.hasAuth || self.sentAuth) { return null }
+  if (!self.hasAuth || self.sentAuth) {
+    return null
+  }
 
   var c = caseless(response.headers)
 

lib/request/lib/oauth.js

@@ -1,5 +1,3 @@
-'use strict'
-
 var url = require('url')
 var qs = require('qs')
 var caseless = require('caseless')
@@ -8,12 +6,12 @@ var oauth = require('oauth-sign')
 var crypto = require('crypto')
 var Buffer = require('safe-buffer').Buffer
 
-function OAuth (request) {
+function OAuth(request) {
   this.request = request
   this.params = null
 }
 
-OAuth.prototype.buildParams = function (_oauth, uri, method, query, form, qsLib) {
+OAuth.prototype.buildParams = function(_oauth, uri, method, query, form, qsLib) {
   var oa = {}
   for (var i in _oauth) {
     oa['oauth_' + i] = _oauth[i]
@@ -61,10 +59,16 @@ OAuth.prototype.buildParams = function (_oauth, uri, method, query, form, qsLib)
   return oa
 }
 
-OAuth.prototype.buildBodyHash = function (_oauth, body) {
+OAuth.prototype.buildBodyHash = function(_oauth, body) {
   if (['HMAC-SHA1', 'RSA-SHA1'].indexOf(_oauth.signature_method || 'HMAC-SHA1') < 0) {
-    this.request.emit('error', new Error('oauth: ' + _oauth.signature_method +
-      ' signature_method not supported with body_hash signing.'))
+    this.request.emit(
+      'error',
+      new Error(
+        'oauth: ' +
+          _oauth.signature_method +
+          ' signature_method not supported with body_hash signing.'
+      )
+    )
   }
 
   var shasum = crypto.createHash('sha1')
@@ -74,24 +78,28 @@ OAuth.prototype.buildBodyHash = function (_oauth, body) {
   return Buffer.from(sha1, 'hex').toString('base64')
 }
 
-OAuth.prototype.concatParams = function (oa, sep, wrap) {
+OAuth.prototype.concatParams = function(oa, sep, wrap) {
   wrap = wrap || ''
 
-  var params = Object.keys(oa).filter(function (i) {
-    return i !== 'realm' && i !== 'oauth_signature'
-  }).sort()
+  var params = Object.keys(oa)
+    .filter(function(i) {
+      return i !== 'realm' && i !== 'oauth_signature'
+    })
+    .sort()
 
   if (oa.realm) {
     params.splice(0, 0, 'realm')
   }
   params.push('oauth_signature')
 
-  return params.map(function (i) {
-    return i + '=' + wrap + oauth.rfc3986(oa[i]) + wrap
-  }).join(sep)
+  return params
+    .map(function(i) {
+      return i + '=' + wrap + oauth.rfc3986(oa[i]) + wrap
+    })
+    .join(sep)
 }
 
-OAuth.prototype.onRequest = function (_oauth) {
+OAuth.prototype.onRequest = function(_oauth) {
   var self = this
   self.params = _oauth
 
@@ -115,8 +123,12 @@ OAuth.prototype.onRequest = function (_oauth) {
     query = uri.query
   }
   if (transport === 'body' && (method !== 'POST' || contentType !== formContentType)) {
-    self.request.emit('error', new Error('oauth: transport_method of body requires POST ' +
-      'and content-type ' + formContentType))
+    self.request.emit(
+      'error',
+      new Error(
+        'oauth: transport_method of body requires POST ' + 'and content-type ' + formContentType
+      )
+    )
   }
 
   if (!form && typeof _oauth.body_hash === 'boolean') {
@@ -131,7 +143,7 @@ OAuth.prototype.onRequest = function (_oauth) {
       break
 
     case 'query':
-      var href = self.request.uri.href += (query ? '&' : '?') + self.concatParams(oa, '&')
+      var href = (self.request.uri.href += (query ? '&' : '?') + self.concatParams(oa, '&'))
       self.request.uri = url.parse(href)
       self.request.path = self.request.uri.path
       break

package.json

@@ -1,7 +1,7 @@
 {
   "name": "tencent-cloud-sdk",
   "description": "Tencent Cloud SDK For Serverless Framework",
-  "version": "0.0.7",
+  "version": "0.0.8",
   "main": "./index.js",
   "publishConfig": {
     "access": "public"
@@ -12,11 +12,26 @@
     "Cloud function"
   ],
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "lint": "eslint . --fix --cache"
+    "test": "npm run lint",
+    "commitlint": "commitlint -f HEAD@{15}",
+    "lint": "eslint --ext .js,.ts,.tsx .",
+    "lint:fix": "eslint --fix --ext .js,.ts,.tsx ."
   },
-  "author": "Dfounderliu",
-  "license": "Apache",
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged",
+      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS",
+      "pre-push": "npm run lint"
+    }
+  },
+  "lint-staged": {
+    "**/*.{js,ts,tsx}": [
+      "npm run lint",
+      "git add ."
+    ]
+  },
+  "author": "Tencent Cloud, Inc.",
+  "license": "MIT",
   "dependencies": {
     "caseless": "0.12.0",
     "combined-stream": "1.0.6",
@@ -44,11 +59,15 @@
     "xml2js": "0.4.19"
   },
   "devDependencies": {
+    "@commitlint/cli": "^8.3.5",
+    "@commitlint/config-conventional": "^8.3.4",
     "babel-eslint": "9.0.0",
     "eslint": "5.6.0",
     "eslint-config-prettier": "^3.6.0",
     "eslint-plugin-import": "^2.18.0",
     "eslint-plugin-prettier": "^3.0.1",
+    "husky": "^4.2.5",
+    "lint-staged": "^10.2.2",
     "prettier": "^1.18.2"
   }
 }