chore: replace ESLint Standard with AirBnb (#62)

Author: Kocal

.eslintrc.json

@@ -1,8 +1,36 @@
 {
-  "extends": "standard",
+  "extends": [
+    "airbnb-base"
+  ],
   "env": {
     "es6": true,
     "node": true,
-    "jest": true
+    "jest": true,
+    "cypress/globals": true
+  },
+  "plugins": [
+    "cypress"
+  ],
+  "settings": {
+    "import/core-modules": [
+      "jsdoc/env"
+    ]
+  },
+  "rules": {
+    "no-param-reassign": ["error", {
+      "props": true,
+      "ignorePropertyModificationsFor": [
+        "doclet", // _isVueFile, ...
+        "e" // for e.doclet
+      ]
+    }],
+    "no-underscore-dangle": ["error", {
+      "allow": [
+        "_isVueDoc",
+        "_vueProps",
+        "_vueData",
+        "_vueComputed"
+      ]
+    }]
   }
-}
+}

__tests__/core/vueScriptExtractor.js

@@ -1,10 +1,10 @@
-const path = require('path')
-const extractVueScript = require('../../lib/core/vueScriptExtractor')
+const path = require('path');
+const extractVueScript = require('../../lib/core/vueScriptExtractor');
 
 describe('core.extractVueScript', () => {
-  const filename = path.join(__dirname, '__fixtures__', 'Component.vue')
+  const filename = path.join(__dirname, '__fixtures__', 'Component.vue');
 
   test('extract script', () => {
-    expect(extractVueScript(filename)).toMatchSnapshot()
-  })
-})
+    expect(extractVueScript(filename)).toMatchSnapshot();
+  });
+});

__tests__/guessers/guessRenderer.test.js

@@ -1,27 +1,29 @@
-const guessRenderer = require('../../lib/core/guessRenderer')
+/* eslint-disable no-console */
+
+const guessRenderer = require('../../lib/core/guessRenderer');
 
 describe('guessRenderer', () => {
   test('guess default', () => {
-    expect(guessRenderer()).toBe('default')
-    expect(guessRenderer('default')).toBe('default')
-  })
+    expect(guessRenderer()).toBe('default');
+    expect(guessRenderer('default')).toBe('default');
+  });
 
   test('guess docstrap', () => {
-    expect(guessRenderer('./node_modules/ink-docstrap/template')).toBe('docstrap')
-  })
+    expect(guessRenderer('./node_modules/ink-docstrap/template')).toBe('docstrap');
+  });
 
   test('guess minami', () => {
-    expect(guessRenderer('node_modules/minami')).toBe('minami')
-  })
+    expect(guessRenderer('node_modules/minami')).toBe('minami');
+  });
 
   test('guess tui', () => {
-    expect(guessRenderer('node_modules/tui-jsdoc-template')).toBe('tui')
-  })
+    expect(guessRenderer('node_modules/tui-jsdoc-template')).toBe('tui');
+  });
 
   test('guess unsupported', () => {
-    console.warn = jest.fn()
+    console.warn = jest.fn();
 
-    expect(guessRenderer('foo-bar')).toBe('default')
-    expect(console.warn).toHaveBeenCalledWith(`The template "foo-bar" is not recognized by jsdoc-vuejs. Using default template as fallback.`)
-  })
-})
+    expect(guessRenderer('foo-bar')).toBe('default');
+    expect(console.warn).toHaveBeenCalledWith('The template "foo-bar" is not recognized by jsdoc-vuejs. Using default template as fallback.');
+  });
+});

config.js

@@ -1,11 +1,11 @@
-const config = require('jsdoc/env')
-const guessRenderer = require('./lib/core/guessRenderer')
+const config = require('jsdoc/env');
+const guessRenderer = require('./lib/core/guessRenderer');
 
-config['jsdoc-vuejs'] = config['jsdoc-vuejs'] || {}
+config['jsdoc-vuejs'] = config['jsdoc-vuejs'] || {};
 
 // Detect JSDoc template if not specified
-if (!config['jsdoc-vuejs'].hasOwnProperty('renderer')) {
-  config['jsdoc-vuejs'].renderer = guessRenderer(config.opts.template || 'default')
+if (!Object.prototype.hasOwnProperty.call(config['jsdoc-vuejs'], 'renderer')) {
+  config['jsdoc-vuejs'].renderer = guessRenderer(config.opts.template || 'default');
 }
 
-module.exports = config
+module.exports = config;

cypress/integration/renderers/default.spec.js

@@ -1,17 +1,17 @@
 describe('Renderers: default', () => {
   beforeEach(() => {
-    cy.visit('/../../../example/docs/BetterCounter.html')
-  })
+    cy.visit('/../../../example/docs/BetterCounter.html');
+  });
 
   it('should renders props correctly', () => {
-    cy.get('[data-vue="section-props"]').contains('Props')
-  })
+    cy.get('[data-vue="section-props"]').contains('Props');
+  });
 
   it('should renders data correctly', () => {
-    cy.get('[data-vue="section-data"]').contains('Data')
-  })
+    cy.get('[data-vue="section-data"]').contains('Data');
+  });
 
   it('should renders computed correctly', () => {
-    cy.get('[data-vue="section-computed"]').contains('Computed')
-  })
-})
+    cy.get('[data-vue="section-computed"]').contains('Computed');
+  });
+});

cypress/integration/renderers/docstrap.spec.js

@@ -1,17 +1,17 @@
 describe('Renderers: docstrap', () => {
   beforeEach(() => {
-    cy.visit('/../../../example/docs-docstrap/BetterCounter.html')
-  })
+    cy.visit('/../../../example/docs-docstrap/BetterCounter.html');
+  });
 
   it('should renders props correctly', () => {
-    cy.get('[data-vue="section-props"]').contains('Props')
-  })
+    cy.get('[data-vue="section-props"]').contains('Props');
+  });
 
   it('should renders data correctly', () => {
-    cy.get('[data-vue="section-data"]').contains('Data')
-  })
+    cy.get('[data-vue="section-data"]').contains('Data');
+  });
 
   it('should renders computed correctly', () => {
-    cy.get('[data-vue="section-computed"]').contains('Computed')
-  })
-})
+    cy.get('[data-vue="section-computed"]').contains('Computed');
+  });
+});

cypress/integration/renderers/minami.spec.js

@@ -1,17 +1,17 @@
 describe('Renderers: minami', () => {
   beforeEach(() => {
-    cy.visit('/../../../example/docs-minami/BetterCounter.html')
-  })
+    cy.visit('/../../../example/docs-minami/BetterCounter.html');
+  });
 
   it('should renders props correctly', () => {
-    cy.get('[data-vue="section-props"]').contains('Props')
-  })
+    cy.get('[data-vue="section-props"]').contains('Props');
+  });
 
   it('should renders data correctly', () => {
-    cy.get('[data-vue="section-data"]').contains('Data')
-  })
+    cy.get('[data-vue="section-data"]').contains('Data');
+  });
 
   it('should renders computed correctly', () => {
-    cy.get('[data-vue="section-computed"]').contains('Computed')
-  })
-})
+    cy.get('[data-vue="section-computed"]').contains('Computed');
+  });
+});

cypress/integration/renderers/tui.spec.js

@@ -1,17 +1,17 @@
 describe('Renderers: tui', () => {
   beforeEach(() => {
-    cy.visit('/../../../example/docs-tui/BetterCounter.html')
-  })
+    cy.visit('/../../../example/docs-tui/BetterCounter.html');
+  });
 
   it('should renders props correctly', () => {
-    cy.get('[data-vue="section-props"]').contains('Props')
-  })
+    cy.get('[data-vue="section-props"]').contains('Props');
+  });
 
   it('should renders data correctly', () => {
-    cy.get('[data-vue="section-data"]').contains('Data')
-  })
+    cy.get('[data-vue="section-data"]').contains('Data');
+  });
 
   it('should renders computed correctly', () => {
-    cy.get('[data-vue="section-computed"]').contains('Computed')
-  })
-})
+    cy.get('[data-vue="section-computed"]').contains('Computed');
+  });
+});

cypress/plugins/index.js

@@ -11,7 +11,8 @@
 // This function is called when a project is opened or re-opened (e.g. due to
 // the project's config changing)
 
+// eslint-disable-next-line no-unused-vars
 module.exports = (on, config) => {
   // `on` is used to hook into various events Cypress emits
   // `config` is the resolved Cypress config
-}
+};

cypress/support/index.js

@@ -14,7 +14,7 @@
 // ***********************************************************
 
 // Import commands.js using ES2015 syntax:
-import './commands'
+import './commands';
 
 // Alternatively you can use CommonJS syntax:
 // require('./commands')