Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add eslint and fix lint errors #2459

Merged
merged 5 commits into from
Nov 15, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: docs
on:
push:
branches:
- main
pull_request:
branches:
- main
paths:
- 'docs/**'
- .github/workflows/docs.yml
jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Set up Node
uses: actions/setup-node@v3
with:
node-version: '16.x'
check-latest: true
- name: Enforce consistent Yarn version
run: ./tools/install-yarn.sh
- name: node_modules cache
id: node-modules-cache
uses: actions/cache@v3
with:
path: |
**/node_modules
key: ${{ runner.os }}-node-modules-${{ hashFiles('**/yarn.lock') }}
- name: Install dependencies
if: steps.node-modules-cache.outputs.cache-hit != 'true'
run: yarn --cwd docs/_website install
- name: lint
run: yarn --cwd docs/_website lint
72 changes: 72 additions & 0 deletions docs/_website/.eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
module.exports = {
env: {
browser: true,
es2021: true,
},
extends: [
"eslint:recommended",
"plugin:react/recommended",
"plugin:prettier/recommended",
"standard-with-typescript",
],
overrides: [],
parserOptions: {
ecmaVersion: "latest",
sourceType: "module",
project: "./tsconfig.json",
// Required for VSCode to properly find tsconfig within docs dir.
// See https://github.com/typescript-eslint/typescript-eslint/issues/251 for more info
tsconfigRootDir: __dirname,
},
plugins: ["react"],
settings: {
react: {
version: "detect",
},
},
rules: {
// prettier enforces trailing commas
"comma-dangle": ["error", "only-multiline"],
// prettier enforces double quotes
quotes: ["error", "double"],
// prettier enforces trailing semicolons
semi: ["error", "always"],
// prettier enforces indentation
indent: ["off"],
// prettier enforces multiline ternary logic
"multiline-ternary": ["off"],
// prettier enforces double quotes
"@typescript-eslint/quotes": ["error", "double"],
// prettier enforces trailing semicolons
"@typescript-eslint/semi": ["error", "always"],
// prettier enforces indentation
"@typescript-eslint/indent": ["off"],
// prettier enforces trailing semicolons
"@typescript-eslint/member-delimiter-style": [
"error",
{
multiline: {
delimiter: "semi",
requireLast: true,
},
singleline: {
delimiter: "semi",
requireLast: false,
},
},
],
// prettier enforces trailing commas
"@typescript-eslint/comma-dangle": ["error", "only-multiline"],
// see https://eslint.org/docs/latest/rules/space-before-function-paren#anonymous-always-named-never-asyncarrow-always for more info
"@typescript-eslint/space-before-function-paren": [
"error",
{
anonymous: "always",
named: "never",
asyncArrow: "always",
},
],
// Prevents casting with `as` keyword
"@typescript-eslint/consistent-type-assertions": ["off"],
},
};
Loading