Merge pull request #110 from rollbar/matux/eslint-prettier-config

Standardize eslint and prettier for the entire project with ci checks

.eslintignore

@@ -0,0 +1,10 @@
+.github
+.next
+build
+bundles
+coverage
+dist
+lib
+node_modules
+out
+public

.github/workflows/ci.yaml

@@ -1,27 +1,57 @@
-name: rollbar-react CI
+name: ci
 
 on:
   push:
-    branches: [ '**' ]
+    branches:
+      - main
   pull_request:
-    branches: [ main ]
+    branches:
+      - main
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
-        node-version: [14.x]
+        node: [14, 16, 18, 20]
 
     steps:
-    - uses: actions/checkout@v2
-
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
-      with:
-        node-version: ${{ matrix.node-version }}
-    - run: npm install
-    - run: npm run lint
-    - run: npm run test
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up node ${{ matrix.node }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node }}
+
+      - name: Cache
+        uses: actions/cache@v4
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ matrix.node }}-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-${{ matrix.node }}-
+            ${{ runner.os }}-node-
+            ${{ runner.os }}-
+
+      - name: Install library dependencies
+        run: npm ci
+      - name: Install examples/create-react-app dependencies
+        run: cd examples/create-react-app && npm ci
+      - name: Install examples/nextjs dependencies
+        run: cd examples/nextjs && npm ci
+      - name: Install examples/typescript dependencies
+        run: cd examples/typescript && npm ci
+
+      - name: Lint
+        uses: wearerequired/lint-action@v2
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          prettier: false
+          eslint: false
+          eslint_args: '--max-warnings 0'
+          eslint_extensions: js,jsx,ts,tsx
+
+      - name: Test
+        run: npm run test

.github/workflows/publish.yaml

@@ -6,16 +6,16 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
-    # Setup .npmrc file to publish to GitHub Packages
-    - uses: actions/setup-node@v2
-      with:
-        node-version: '12.x'
-        registry-url: 'https://registry.npmjs.org'
-        # Defaults to the user or organization that owns the workflow file
-        # scope: '@rollbar'
-    - run: npm install
-    - run: npm run build
-    - run: npm publish --access public
-      env:
-        NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - uses: actions/checkout@v2
+      # Setup .npmrc file to publish to GitHub Packages
+      - uses: actions/setup-node@v2
+        with:
+          node-version: "14.x"
+          registry-url: "https://registry.npmjs.org"
+          # Defaults to the user or organization that owns the workflow file
+          # scope: '@rollbar'
+      - run: npm install
+      - run: npm run build
+      - run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.prettierignore

@@ -0,0 +1,10 @@
+.github
+.next
+build
+bundles
+coverage
+dist
+lib
+node_modules
+out
+public

.vscode/settings.json

@@ -0,0 +1,38 @@
+{
+  "[github-actions-workflow]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true
+  },
+  "[javascript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true
+  },
+  "[javascriptreact]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true
+  },
+  "[json5]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true
+  },
+  "[jsonc]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true
+  },
+  "[typescript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true
+  },
+  "[typescriptreact]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true
+  },
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "editor.formatOnSave": true,
+  "editor.formatOnSaveMode": "file",
+  "editor.tabSize": 2,
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "explicit"
+  },
+  "files.trimTrailingWhitespace": true
+}

examples/create-react-app/package.json

@@ -21,6 +21,7 @@
     "eject": "react-scripts eject"
   },
   "eslintConfig": {
+    "root": true,
     "extends": [
       "react-app",
       "react-app/jest"

examples/nextjs/babel.config.js

@@ -0,0 +1 @@
+module.exports = {}

examples/nextjs/eslint.config.js

@@ -0,0 +1,6 @@
+/** @type {import('eslint').Linter.Config} */
+module.exports = {
+  root: true,
+  extends: 'next/core-web-vitals',
+  ignorePatterns: ['node_modules'],
+}

examples/nextjs/package.json

@@ -16,6 +16,7 @@
     "rollbar": "^2.24.0"
   },
   "devDependencies": {
+    "@types/eslint": "^8.56.3",
     "@types/node": "17.0.21",
     "@types/react": "17.0.39",
     "eslint": "8.10.0",

examples/typescript/package.json

@@ -27,6 +27,7 @@
     "lint": "eslint src"
   },
   "eslintConfig": {
+    "root": true,
     "extends": [
       "react-app",
       "react-app/jest"

prettier.config.js

@@ -0,0 +1,9 @@
+/** @type {import('prettier').Config} */
+module.exports = {
+  trailingComma: 'es5',
+  bracketSpacing: true,
+  tabWidth: 2,
+  semi: false,
+  singleQuote: true,
+  arrowParens: 'always',
+};