What linting configuration should I use for my Agoric contracts?

[rowgraus]

context:

• Mainnet 2 Deployment Checklist #8280

p.s. edited to separate question from answer

[dckc]

Agoric recommends the following configuration:

Linting Configuration
Adapted from Jessie ESLint Configuration

1. Run:

yarn add -D \
 eslint \
 @agoric/eslint-config@dev \
 @endo/eslint-plugin \
 @jessie.js/eslint-plugin \
  eslint-config-airbnb-base \
 eslint-plugin-jsdoc \
 eslint-config-prettier \
 eslint-plugin-import \
 eslint-plugin-github

2. Add the following to your package.json

"eslintConfig" : {
  "parserOptions": {
      "sourceType": "module",
      "ecmaVersion": 6
  },
  "extends": [
    "@agoric"
  ]
}

3. Run yarn eslint '**/*.js' (or specify other files/directory globs)

[0xpatrickdev]

I think this may need to be "ecmaVersion": 12 or "ecmaVersion": 2021 to support things like bigint

[dckc]

@turadg does the advice above still look good?
no rush

[turadg]

incomplete. I'll try to find time to flesh it out. https://github.com/CrabblePitch/crabbleProtocol/pull/124 provides some direction

[dckc]

I see Agoric/dapp-offer-up#26 (comment) as well

[dckc]

@erights asked in Agoric/dapp-agoric-basics#29 (comment)

I yarn format in this repo?

Suggestions, anyone?

[erights]

Answered by @turadg at Agoric/dapp-agoric-basics#29 (comment)

[dckc]

@import is another recent relevant development:

• TypeScript 5.5 with @import tag #9149

[dckc]

I'm struggling to configure lint in another project. I think I'll promote the symptoms to their own question:

• @typescript-eslint/typescript-estree / typescript version conflict? #9892