@bigpicturemedical/eslint-config

eslint-config

A ESLint config for Big Picture Medical

Installation

npm i --save-dev @bigpicturemedical/eslint-config

Usage

Vue

In .eslintrc.js:

module.exports = {
  extends: [ "@bigpicturemedical/eslint-config/vue" ]
}

In package.json:

"scripts": {
  "lint": "eslint ./src/ --ext .ts,.vue"
}

Configure VSCODE

Install the eslint extension: dbaeumer.vscode-eslint

in settings.json

"eslint.options": {
  "extensions": [
    ".html",
    ".js",
    ".jsx",
    ".ts",
    ".vue"
  ]
},
"eslint.validate": [
  {
    "language": "typescript",
    "autoFix": true
  },
  {
    "language": "vue",
    "autoFix": true
  },
],

How to contribute

1. Create a PR to submit changes

Code Style

Our style basis is a work in progress.

Whitespace

Let your code breath a little...use whitespace. Generally leave a line between function declaration and code in the function (and before closing brace):

const patch = (req: Request, res: Response, next: NextFunction) => {

  const { id, code, email } = req.params

  return update({ id, code, email }, req.body)
    .then(() => {
      return getByEmail({ id, code, email })
    })
    .then((user) => {
      res.json(user)
    })
    .catch(next)

}

Group logical chunks of code together - use whitespace like paragraphs, communicate your intent to the person who comes after you...

const abc = (param) => {

  const { aaa, bbb, ccc } = param;
  const x = 1;
  const y = 2;

  if (aaa === 123) {
    someService.doSomething(bbb, ccc);
    someService.doSomethingElse(ccc);
    someService.andThen(ccc);
  }

  someService.xxx(bbb);
  someService.yyy(ccc);
  someService.zzz(ccc);

};

Same for test specs

describe(suiteName(__filename), () => {

  afterEach(() => {
    jest.resetAllMocks();
  });

  describe('get', () => {

    it('correct values returned', async () => {

      const user: any = {};
      // more code