Next

.eslintrc.js

@@ -1,9 +1,24 @@
 module.exports = {
-  plugins: ['eslint-plugin-jsdoc'],
+  env: {
+    commonjs: true,
+    es2021: true,
+    node: true
+  },
+  plugins: ['prettier', 'jsdoc'],
   extends: [
+    'standard',
+    // resolve conflicts between prettier and eslint
+    'plugin:prettier/recommended',
     // from eslint-plugin-jsdoc
     // @see https://github.com/gajus/eslint-plugin-jsdoc#configuration
-    // warnings not work with prettier-standard therefore this ruleset not effective
     'plugin:jsdoc/recommended'
-  ]
+  ],
+  parser: 'babel-eslint',
+  parserOptions: {
+    ecmaVersion: 12
+  },
+  rules: {
+    'prefer-regex-literals': ['off'],
+    'jsdoc/no-undefined-types': ['off']
+  }
 }

.prettierrc.js

@@ -0,0 +1,7 @@
+module.exports = {
+  bracketSpacing: true,
+  singleQuote: true,
+  trailingComma: 'none',
+  arrowParens: 'avoid',
+  semi: false,
+};

README.md

@@ -20,6 +20,7 @@
 - [Development](#development)
   - [Commit Messages](#commit-messages)
   - [Code Quality](#code-quality)
+  - [Testing](#testing)
   - [Available Scripts](#available-scripts)
 - [Special Thanks](#special-thanks)
 - [License](#license)
@@ -80,23 +81,26 @@ Keeping code quality as good is a hard job in normally. Therefore, we are using
 
 In short, run `npm run lint` command.
 
+## Testing
+
+Writing tests is boring but also necessary. If you want to write a test look at other tests and don't forget apply proxy over Travis because of ridvanaltun/eksi-sozluk#16. The proxy server running over my local environment therefore sometimes it is not reacable, test fails on Travis when my local environment is turned off or the proxy server is turned off.
+
+I accept PRs by myself anyway so running tests over Travis is not a problem for a contributor. You can run tests on your local anytime.
+
 ## Available Scripts
 
 ```bash
 # commit your changes with commitizen
 npm run commit
 
-# check linter and prettier errors, fix prettier errors in default
+# check eslint issues
 npm run lint
 
-# check the linter and prettier errors
-npm run lint:check
-
-# run prettier
-npm run format
+# fix eslint issues
+npm run lint:fix
 
-# check prettier errors
-npm run format:check
+# run eslint-nibble
+npm run lint:active
 
 # run all tests
 npm run test

__tests__/agenda.test.js

@@ -1,6 +1,16 @@
 const { EksiSozluk } = require('../src/index')
+const HttpsProxyAgent = require('https-proxy-agent')
 
-const instance = new EksiSozluk()
+let httpClient = {};
+
+// use proxy over Travis
+if (process.env.TRAVIS) {
+  httpClient = {
+    httpsAgent: new HttpsProxyAgent(process.env.PROXY)
+  }
+}
+
+const instance = new EksiSozluk({httpClient})
 
 describe('Agenda Test', () => {
   test('Getting Agenda', () => {

__tests__/debe.test.js

@@ -1,6 +1,16 @@
 const { EksiSozluk } = require('../src/index')
+const HttpsProxyAgent = require('https-proxy-agent')
 
-const instance = new EksiSozluk()
+let httpClient = {};
+
+// use proxy over Travis
+if (process.env.TRAVIS) {
+  httpClient = {
+    httpsAgent: new HttpsProxyAgent(process.env.PROXY)
+  }
+}
+
+const instance = new EksiSozluk({httpClient})
 
 describe('Debe Test', () => {
   test('Getting Debe', () => {

__tests__/entries.test.js

@@ -1,6 +1,16 @@
 const { EksiSozluk } = require('../src/index')
+const HttpsProxyAgent = require('https-proxy-agent')
 
-const instance = new EksiSozluk()
+let httpClient = {};
+
+// use proxy over Travis
+if (process.env.TRAVIS) {
+  httpClient = {
+    httpsAgent: new HttpsProxyAgent(process.env.PROXY)
+  }
+}
+
+const instance = new EksiSozluk({httpClient})
 
 describe('Entries Test', () => {
   test('Getting Entries', () => {

__tests__/entry.test.js

@@ -1,6 +1,16 @@
 const { EksiSozluk } = require('../src/index')
+const HttpsProxyAgent = require('https-proxy-agent')
 
-const instance = new EksiSozluk()
+let httpClient = {};
+
+// use proxy over Travis
+if (process.env.TRAVIS) {
+  httpClient = {
+    httpsAgent: new HttpsProxyAgent(process.env.PROXY)
+  }
+}
+
+const instance = new EksiSozluk({httpClient})
 
 describe('Entry Test', () => {
   test('Getting Entry By Id', () => {

__tests__/questions.test.js

@@ -1,6 +1,16 @@
 const { EksiSozluk } = require('../src/index')
+const HttpsProxyAgent = require('https-proxy-agent')
 
-const instance = new EksiSozluk()
+let httpClient = {};
+
+// use proxy over Travis
+if (process.env.TRAVIS) {
+  httpClient = {
+    httpsAgent: new HttpsProxyAgent(process.env.PROXY)
+  }
+}
+
+const instance = new EksiSozluk({httpClient})
 
 describe('Questions Test', () => {
   test('Getting Questions in Agenda', () => {

__tests__/tags.test.js

@@ -1,6 +1,16 @@
 const { EksiSozluk } = require('../src/index')
+const HttpsProxyAgent = require('https-proxy-agent')
 
-const instance = new EksiSozluk()
+let httpClient = {};
+
+// use proxy over Travis
+if (process.env.TRAVIS) {
+  httpClient = {
+    httpsAgent: new HttpsProxyAgent(process.env.PROXY)
+  }
+}
+
+const instance = new EksiSozluk({httpClient})
 
 describe('Tags Test', () => {
   test('Getting Tags', () => {

__tests__/todayInHistory.test.js

@@ -1,6 +1,16 @@
 const { EksiSozluk } = require('../src/index')
+const HttpsProxyAgent = require('https-proxy-agent')
 
-const instance = new EksiSozluk()
+let httpClient = {};
+
+// use proxy over Travis
+if (process.env.TRAVIS) {
+  httpClient = {
+    httpsAgent: new HttpsProxyAgent(process.env.PROXY)
+  }
+}
+
+const instance = new EksiSozluk({httpClient})
 
 describe('Today in History Test', () => {
   test('Getting Today in History', () => {

__tests__/user.test.js

@@ -1,6 +1,16 @@
 const { EksiSozluk } = require('../src/index')
+const HttpsProxyAgent = require('https-proxy-agent')
 
-const instance = new EksiSozluk()
+let httpClient = {};
+
+// use proxy over Travis
+if (process.env.TRAVIS) {
+  httpClient = {
+    httpsAgent: new HttpsProxyAgent(process.env.PROXY)
+  }
+}
+
+const instance = new EksiSozluk({httpClient})
 
 describe('User Test', () => {
   test('Getting User', () => {

commitlint.config.js

@@ -1,6 +1,15 @@
 module.exports = {
   extends: ['@commitlint/config-conventional'],
   rules: {
-    "body-max-line-length": [1, "always", 100],
-  }
+    'body-max-line-length': [1, 'always', 100]
+  },
+  helpUrl: `
+  Commit messages must follow conventional commit format:
+  https://www.conventionalcommits.org/en/v1.0.0/#summary
+      type(optional-scope): subject
+
+      [optional body]
+  * To bypass pre-commit hooks run 'git commit --no-verify'
+  >>> Use "yarn commit" for interactive prompt. <<<
+  `
 }

jest.config.js

@@ -3,5 +3,6 @@ module.exports = {
   roots: ['__tests__/'],
   // This line solves: Cross origin http://localhost forbidden
   // @see https://github.com/axios/axios/issues/1754
-  testEnvironment: 'node'
+  testEnvironment: 'node',
+  testTimeout: 10000 // default 5 secs, we are using 10 secs
 }