Add linter (and formatter through eslint), config and ci action step (#452)

Co-authored-by: Eric Lau <[email protected]>

Author: CoveMB

.github/workflows/test.yml

@@ -6,6 +6,19 @@ on:
   pull_request: {}
 
 jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18.x
+          cache: 'yarn'
+      - name: Install dependencies
+        run: yarn install --network-concurrency 1
+      - name: Run linter
+        run: yarn lint
+
   build:
     strategy:
       matrix:

.gitignore

@@ -5,3 +5,4 @@ node_modules
 
 .env
 .env.local
+.vscode/

.prettierrc

@@ -0,0 +1,7 @@
+{
+  "singleQuote": true,
+  "arrowParens": "avoid",
+  "trailingComma": "all",
+  "printWidth": 120,
+  "bracketSpacing": true
+}

README.md

@@ -15,6 +15,7 @@ Install dependencies with `yarn install`.
 `packages/core` contains the code generation logic for each language under separately named subfolders. From each language's subfolder:
 - Run `yarn test` to run the tests.
 - Run `yarn test:update-snapshots` to update AVA snapshots and run the tests.
+- Run `yarn lint` to run the linter across the codebase (optionally `yarn lint --fix` will automatically fix fixable issues, like formatting issues).
 
 `packages/ui` is the interface built in Svelte. From the `packages/ui` directory, run `yarn dev` to spin up a local server to develop the UI.
 

eslint.config.mjs

@@ -0,0 +1,49 @@
+// @ts-check
+
+import eslint from '@eslint/js';
+import prettierPluginRecommended from 'eslint-plugin-prettier/recommended';
+import unicornPlugin from 'eslint-plugin-unicorn';
+import typescriptEslint from 'typescript-eslint';
+
+export default typescriptEslint.config(
+  eslint.configs.recommended,
+  typescriptEslint.configs.strict,
+  prettierPluginRecommended,
+  {
+    plugins: {
+      unicorn: unicornPlugin,
+    },
+    rules: {
+      '@typescript-eslint/no-unused-vars': ['warn', { argsIgnorePattern: '^_', varsIgnorePattern: '^_' }],
+      '@typescript-eslint/no-non-null-assertion': 'off',
+      '@typescript-eslint/consistent-type-imports': 'error',
+      'prettier/prettier': [
+        'error',
+        { singleQuote: true, arrowParens: 'avoid', trailingComma: 'all', printWidth: 120, bracketSpacing: true },
+      ],
+    },
+  },
+  {
+    ignores: ['node_modules/', '*.sol', 'packages/*/node_modules/', 'packages/**/dist/', 'packages/**/build/'],
+  },
+  {
+    files: ['**/*.config.js'],
+    languageOptions: {
+      sourceType: 'commonjs',
+    },
+  },
+  {
+    files: ['**/*.mjs', '**/*.js'],
+    languageOptions: {
+      sourceType: 'commonjs',
+      globals: {
+        process: 'readonly',
+        global: 'readonly',
+        console: 'readonly',
+      },
+    },
+    rules: {
+      '@typescript-eslint/no-require-imports': 'off',
+    },
+  },
+);

package.json

@@ -3,6 +3,7 @@
   "private": true,
   "scripts": {
     "prepare": "wsrun -m prepare",
+    "lint": "eslint",
     "dev:ui": "yarn --cwd ./packages/ui dev",
     "run:core": "node ./scripts/run-command.mjs"
   },
@@ -17,6 +18,14 @@
     ]
   },
   "devDependencies": {
+    "@eslint/js": "^9.21.0",
+    "eslint": "^9.21.0",
+    "eslint-config-prettier": "^10.0.1",
+    "eslint-plugin-prettier": "^5.2.3",
+    "eslint-plugin-unicorn": "^57.0.0",
+    "prettier": "^3.5.1",
+    "typescript": "^5.7.3",
+    "typescript-eslint": "^8.24.1",
     "wsrun": "^5.2.4"
   }
 }

packages/core/cairo/ava.config.js

@@ -2,11 +2,7 @@ module.exports = {
   extensions: ['ts'],
   require: ['ts-node/register'],
   watchmode: {
-    ignoreChanges: [
-      'contracts',
-      'artifacts',
-      'cache',
-    ],
+    ignoreChanges: ['contracts', 'artifacts', 'cache'],
   },
   timeout: '10m',
   workerThreads: false,

packages/core/cairo/package.json

@@ -31,4 +31,4 @@
     "typescript": "^5.0.0",
     "semver": "^7.6.0"
   }
-}
+}

packages/core/cairo/src/account.test.ts

@@ -1,6 +1,7 @@
 import test from 'ava';
 
-import { buildAccount, AccountOptions } from './account';
+import type { AccountOptions } from './account';
+import { buildAccount } from './account';
 import { printContract } from './print';
 
 import { account } from '.';
@@ -32,22 +33,27 @@ function testEthAccount(title: string, opts: Partial<AccountOptions>) {
  */
 function testAPIEquivalence(title: string, opts?: AccountOptions) {
   test(title, t => {
-    t.is(account.print(opts), printContract(buildAccount({
-      name: 'MyAccount',
-      type: 'stark',
-      declare: true,
-      deploy: true,
-      pubkey: true,
-      outsideExecution: true,
-      ...opts,
-    })));
+    t.is(
+      account.print(opts),
+      printContract(
+        buildAccount({
+          name: 'MyAccount',
+          type: 'stark',
+          declare: true,
+          deploy: true,
+          pubkey: true,
+          outsideExecution: true,
+          ...opts,
+        }),
+      ),
+    );
   });
 }
 
 testAccount('default full account, mixin + upgradeable', {});
 
 testAccount('default full account, mixin + non-upgradeable', {
-  upgradeable: false
+  upgradeable: false,
 });
 
 testAccount('explicit full account, mixin + upgradeable', {
@@ -57,7 +63,7 @@ testAccount('explicit full account, mixin + upgradeable', {
   deploy: true,
   pubkey: true,
   outsideExecution: true,
-  upgradeable: true
+  upgradeable: true,
 });
 
 testAccount('explicit full account, mixin + non-upgradeable', {
@@ -67,7 +73,7 @@ testAccount('explicit full account, mixin + non-upgradeable', {
   deploy: true,
   pubkey: true,
   outsideExecution: true,
-  upgradeable: false
+  upgradeable: false,
 });
 
 testAccount('basic account, upgradeable', {
@@ -82,7 +88,7 @@ testAccount('basic account, non-upgradeable', {
   deploy: false,
   pubkey: false,
   outsideExecution: false,
-  upgradeable: false
+  upgradeable: false,
 });
 
 testAccount('account outside execution', {
@@ -127,7 +133,7 @@ testAccount('account deployable, public key', {
 testEthAccount('default full ethAccount, mixin + upgradeable', {});
 
 testEthAccount('default full ethAccount, mixin + non-upgradeable', {
-  upgradeable: false
+  upgradeable: false,
 });
 
 testEthAccount('explicit full ethAccount, mixin + upgradeable', {
@@ -137,7 +143,7 @@ testEthAccount('explicit full ethAccount, mixin + upgradeable', {
   deploy: true,
   pubkey: true,
   outsideExecution: true,
-  upgradeable: true
+  upgradeable: true,
 });
 
 testEthAccount('explicit full ethAccount, mixin + non-upgradeable', {
@@ -147,7 +153,7 @@ testEthAccount('explicit full ethAccount, mixin + non-upgradeable', {
   deploy: true,
   pubkey: true,
   outsideExecution: true,
-  upgradeable: false
+  upgradeable: false,
 });
 
 testEthAccount('basic ethAccount, upgradeable', {
@@ -162,7 +168,7 @@ testEthAccount('basic ethAccount, non-upgradeable', {
   deploy: false,
   pubkey: false,
   outsideExecution: false,
-  upgradeable: false
+  upgradeable: false,
 });
 
 testEthAccount('ethAccount outside execution', {

packages/core/cairo/src/account.ts

@@ -1,15 +1,16 @@
-import { Contract, ContractBuilder } from './contract';
-import { CommonOptions, withCommonDefaults } from './common-options';
+import type { Contract } from './contract';
+import { ContractBuilder } from './contract';
+import type { CommonOptions } from './common-options';
+import { withCommonDefaults } from './common-options';
 import { defaults as commonDefaults } from './common-options';
 import { setAccountUpgradeable } from './set-upgradeable';
 import { setInfo } from './set-info';
 import { defineComponents } from './utils/define-components';
 import { printContract } from './print';
 import { addSRC5Component } from './common-components';
 
-
 export const accountTypes = ['stark', 'eth'] as const;
-export type Account = typeof accountTypes[number];
+export type Account = (typeof accountTypes)[number];
 
 export const defaults: Required<AccountOptions> = {
   name: 'MyAccount',
@@ -19,7 +20,7 @@ export const defaults: Required<AccountOptions> = {
   pubkey: true,
   outsideExecution: true,
   upgradeable: commonDefaults.upgradeable,
-  info: commonDefaults.info
+  info: commonDefaults.info,
 } as const;
 
 export function printAccount(opts: AccountOptions = defaults): string {
@@ -42,8 +43,8 @@ function withDefaults(opts: AccountOptions): Required<AccountOptions> {
     declare: opts.declare ?? defaults.declare,
     deploy: opts.deploy ?? defaults.deploy,
     pubkey: opts.pubkey ?? defaults.pubkey,
-    outsideExecution: opts.outsideExecution ?? defaults.outsideExecution
-  }
+    outsideExecution: opts.outsideExecution ?? defaults.outsideExecution,
+  };
 }
 
 export function buildAccount(opts: AccountOptions): Contract {
@@ -157,11 +158,14 @@ function addAccountMixin(c: ContractBuilder, accountType: Account) {
 }
 
 function getBaseCompAndCompType(accountType: Account): [string, typeof componentType] {
-  const [baseComponent, componentType] = accountType === 'stark' ? ['AccountComponent', components.AccountComponent] : ['EthAccountComponent', components.EthAccountComponent];
+  const [baseComponent, componentType] =
+    accountType === 'stark'
+      ? ['AccountComponent', components.AccountComponent]
+      : ['EthAccountComponent', components.EthAccountComponent];
   return [baseComponent, componentType];
 }
 
-const components = defineComponents( {
+const components = defineComponents({
   AccountComponent: {
     path: 'openzeppelin::account',
     substorage: {
@@ -172,11 +176,13 @@ const components = defineComponents( {
       name: 'AccountEvent',
       type: 'AccountComponent::Event',
     },
-    impls: [{
-      name: 'AccountInternalImpl',
-      embed: false,
-      value: 'AccountComponent::InternalImpl<ContractState>',
-    }],
+    impls: [
+      {
+        name: 'AccountInternalImpl',
+        embed: false,
+        value: 'AccountComponent::InternalImpl<ContractState>',
+      },
+    ],
   },
   EthAccountComponent: {
     path: 'openzeppelin::account::eth_account',
@@ -188,11 +194,13 @@ const components = defineComponents( {
       name: 'EthAccountEvent',
       type: 'EthAccountComponent::Event',
     },
-    impls: [{
-      name: 'EthAccountInternalImpl',
-      embed: false,
-      value: 'EthAccountComponent::InternalImpl<ContractState>',
-    }]
+    impls: [
+      {
+        name: 'EthAccountInternalImpl',
+        embed: false,
+        value: 'EthAccountComponent::InternalImpl<ContractState>',
+      },
+    ],
   },
   SRC9Component: {
     path: 'openzeppelin::account::extensions',
@@ -204,13 +212,16 @@ const components = defineComponents( {
       name: 'SRC9Event',
       type: 'SRC9Component::Event',
     },
-    impls: [{
-      name: 'OutsideExecutionV2Impl',
-      value: 'SRC9Component::OutsideExecutionV2Impl<ContractState>',
-    }, {
-      name: 'OutsideExecutionInternalImpl',
-      embed: false,
-      value: 'SRC9Component::InternalImpl<ContractState>',
-    }]
-  }
+    impls: [
+      {
+        name: 'OutsideExecutionV2Impl',
+        value: 'SRC9Component::OutsideExecutionV2Impl<ContractState>',
+      },
+      {
+        name: 'OutsideExecutionInternalImpl',
+        embed: false,
+        value: 'SRC9Component::InternalImpl<ContractState>',
+      },
+    ],
+  },
 });