Merge pull request #81 from lidofinance/fix/github-workflows

Feat: GitHub workflows

.github/workflows/CODEOWNERS

@@ -0,0 +1,2 @@
+* @lidofinance/lido-eth-protocol
+.github @lidofinance/review-gh-workflows

.github/workflows/lint.yml

@@ -0,0 +1,35 @@
+name: Linters
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    name: ESLint
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out the repository
+        uses: actions/checkout@v4
+
+      - name: Enable corepack
+        shell: bash
+        run: corepack enable
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version-file: .nvmrc
+          cache: npm
+
+      - name: Install dependencies
+        shell: bash
+        run: npm ci
+
+      - name: Install node packages
+        run: |
+          npm ci
+
+      - name: Lint README.md
+        run: npm run lint:check
+
+      - name: Run Prettier check
+        run: npm run prettier:check

.gitignore

@@ -0,0 +1,6 @@
+.idea/
+
+node_modules/
+
+# MacOS
+.DS_Store

.husky/commit-msg

@@ -0,0 +1 @@
+npx commitlint --edit ${1}

.husky/pre-commit

@@ -0,0 +1 @@
+npx lint-staged

.nvmrc

@@ -0,0 +1 @@
+20.12

.prettierignore

@@ -0,0 +1,8 @@
+.gitignore
+.prettierignore
+
+eslint.config.mjs
+commitlint.config.ts
+
+package-lock.json
+*.pdf

README.md

@@ -403,13 +403,13 @@ See [full report](Oxorio%20Lido%20V2%20Off-chain%20Audit%20Report%2006-23.pdf) f
 
 ## 10-2023 Statemind Lido roles analysis
 
-Impact severity \ Attack feasibility | Low | Medium | High
--------------------------------------|-----|--------|-----
-Critical                             | 56  | 5      | 0
-High                                 | 71  | 1      | 1
-Medium                               | 33  | 12     | 0
-Low                                  | 0   | 6      | 0
-No impact                            | 2   | 0      | 0
+| Impact severity \ Attack feasibility | Low | Medium | High |
+| ------------------------------------ | --- | ------ | ---- |
+| Critical                             | 56  | 5      | 0    |
+| High                                 | 71  | 1      | 1    |
+| Medium                               | 33  | 12     | 0    |
+| Low                                  | 0   | 6      | 0    |
+| No impact                            | 2   | 0      | 0    |
 
 See [full report](Statemind%20Lido%20roles%20analysis%2010-2023.pdf) for more details.
 
@@ -426,6 +426,7 @@ See [full report](Oxorio%20Lido%20Easy%20Track%20Smart%20Contracts%20Security%20
 ## 12-2023 Pessimistic Lido Stonks Audit
 
 This audit report covers the code up to commit [`ad6a9e83c095f5052e404bc13585ad2c752f242f`](https://github.com/lidofinance/stonks/tree/ad6a9e83c095f5052e404bc13585ad2c752f242f). For release version audit please go to [03-2024 Ackee Blockchain Lido Stonks Audit](#03-2024-ackee-blockchain-lido-stonks-audit).
+
 - Total Issues: 8 (4 Fixed, 4 Acknowledged)
 - Critical: 0
 - Medium: 2 (1 Fixed, 1 Acknowledged)

commitlint.config.ts

@@ -0,0 +1 @@
+module.exports = { extends: ["@commitlint/config-conventional"] };

eslint.config.mjs

@@ -0,0 +1,23 @@
+import * as mdx from "eslint-plugin-mdx";
+
+export default [
+  {
+    ...mdx.flat,
+    // optional, if you want to lint code blocks at the same
+    processor: mdx.createRemarkProcessor({
+      lintCodeBlocks: true,
+      // optional, if you want to disable language mapper, set it to `false`
+      // if you want to override the default language mapper inside, you can provide your own
+      languageMapper: {},
+    }),
+  },
+  {
+    ...mdx.flatCodeBlocks,
+    rules: {
+      ...mdx.flatCodeBlocks.rules,
+      // if you want to override some rules for code blocks
+      "no-var": "error",
+      "prefer-const": "error",
+    },
+  },
+];