Merge pull request #159 from ethdebug/statics

Add linting and formatting tooling

Author: gnidan

.eslintignore

@@ -0,0 +1,13 @@
+node_modules/
+dist/
+coverage/
+*.d.ts
+*.config.js
+*.config.ts
+
+# Auto-generated files
+packages/format/src/schemas/yamls.ts
+
+# Docusaurus
+packages/web/.docusaurus/
+packages/web/build/

.eslintrc.json

@@ -0,0 +1,20 @@
+{
+  "parser": "@typescript-eslint/parser",
+  "plugins": ["@typescript-eslint"],
+  "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
+  "rules": {
+    "@typescript-eslint/no-explicit-any": "warn",
+    "@typescript-eslint/no-unused-vars": [
+      "error",
+      { "varsIgnorePattern": "^_", "argsIgnorePattern": "^_" }
+    ],
+    "@typescript-eslint/no-namespace": "off",
+    "@typescript-eslint/no-empty-object-type": "off",
+    "no-console": "warn",
+    "require-yield": "off"
+  },
+  "env": {
+    "node": true,
+    "es2022": true
+  }
+}

.git-blame-ignore-revs

@@ -0,0 +1,11 @@
+# Prettier formatting
+# Apply Prettier formatting
+d42ac838468820243ce5bfaed89bfd686f296bee
+
+# ESLint fixes
+# Apply ESLint fixes and adjust configuration
+1080960d9e200e302315e8a6006312cd44fdeaa4
+
+# Additional Prettier formatting
+# Apply remaining Prettier formatting fixes
+b3b53a99b599e56c0277999d9e1c0e246f669e00

.github/workflows/ci.yml

@@ -1,8 +1,28 @@
 name: Continuous integration checks
 on:
-- pull_request
+  - pull_request
 
 jobs:
+  lint-and-format:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 20
+          cache: yarn
+          cache-dependency-path: yarn.lock
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+
+      - name: Check formatting
+        run: yarn format:check
+
+      - name: Lint
+        run: yarn lint
+
   run-tests:
     runs-on: ubuntu-latest
     steps:

.github/workflows/gh-pages.yml

@@ -29,10 +29,8 @@ jobs:
           folder: ./packages/web/build
           branch: gh-pages
           # default deployer
-          git-config-name: 'github-actions[bot]'
-          git-config-email: 'github-actions[bot]@users.noreply.github.com'
+          git-config-name: "github-actions[bot]"
+          git-config-email: "github-actions[bot]@users.noreply.github.com"
           # don't break preview deployments
           clean-exclude: pr-preview
           force: false
-
-

.husky/pre-commit

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

.prettierignore

@@ -0,0 +1,17 @@
+node_modules/
+dist/
+coverage/
+*.log
+.DS_Store
+yarn.lock
+package-lock.json
+
+# Auto-generated files
+packages/format/src/schemas/yamls.ts
+
+# Docusaurus build output
+packages/web/.docusaurus/
+packages/web/build/
+
+# Contains embedded source code with specific formatting for findSourceRange
+packages/web/spec/program/example.mdx

.prettierrc.json

@@ -0,0 +1,4 @@
+{
+  "printWidth": 80,
+  "singleQuote": false
+}

README.md

@@ -46,6 +46,7 @@ This repository contains a
 with the formal JSON Schemas defined by this project (in YAML format).
 
 This repository also contains the source materials for the following NPM packages:
+
 - **@ethdebug/format** in
   [`packages/format/`](https://github.com/ethdebug/format/tree/main/packages/format)
   distributes the formal schemas for use in TypeScript
@@ -75,6 +76,7 @@ To build and run the site locally, please ensure you have Node.js
 (LTS or better) and `yarn` installed globally.
 
 First, clone this repo and install the Node.js dependencies:
+
 ```console
 git clone https://github.com/ethdebug/format.git
 cd format
@@ -96,10 +98,12 @@ This project uses a dual-license approach:
 
 - All other code and documentation in this repository is licensed under the [MIT License](LICENSE).
 
-[^1]: See [Debugging data format -
-  Wikipedia](https://en.wikipedia.org/wiki/Debugging_data_format)
+[^1]:
+    See [Debugging data format -
+    Wikipedia](https://en.wikipedia.org/wiki/Debugging_data_format)
 
 [^2]: See [DWARF - Wikipedia](https://en.wikipedia.org/wiki/DWARF)
 
-[^3]: See [Using type predicates](https://www.typescriptlang.org/docs/handbook/2/narrowing.html#using-type-predicates)
-  section from TypeScript's Narrowing documentation.
+[^3]:
+    See [Using type predicates](https://www.typescriptlang.org/docs/handbook/2/narrowing.html#using-type-predicates)
+    section from TypeScript's Narrowing documentation.

bin/bundle-schema.ts

@@ -1,14 +1,13 @@
 import { addSchema } from "@hyperjump/json-schema/draft-2020-12";
 import { bundle as bundleSchema } from "@hyperjump/json-schema/bundle";
 import { schemas, describeSchema } from "@ethdebug/format";
-import type { JSONSchema } from "json-schema-typed/draft-2020-12"
 
 async function main() {
   const schema = { id: process.argv[2] }; // a bit brittle
 
   if (!schema.id) {
     console.error(
-      "Please provide a schema ID, e.g. `schema:ethdebug/format/pointer`"
+      "Please provide a schema ID, e.g. `schema:ethdebug/format/pointer`",
     );
     process.exit(1);
   }