From 828c144d907149bcdbfef5469d169ceb67bd317d Mon Sep 17 00:00:00 2001 From: leovct Date: Wed, 1 Nov 2023 09:50:22 +0100 Subject: [PATCH 1/5] ci: implement `lint` job --- .github/workflows/lint.yml | 36 ++++++++++++++++ .gitignore | 3 ++ .prettierignore | 4 ++ .prettierrc | 5 +++ package.json | 21 ++++++++++ pnpm-lock.yaml | 85 ++++++++++++++++++++++++++++++++++++++ 6 files changed, 154 insertions(+) create mode 100644 .github/workflows/lint.yml create mode 100644 .prettierignore create mode 100644 .prettierrc create mode 100644 package.json create mode 100644 pnpm-lock.yaml diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml new file mode 100644 index 0000000..e7d1a9e --- /dev/null +++ b/.github/workflows/lint.yml @@ -0,0 +1,36 @@ +name: lint + +on: push + +env: + PNPM_VERSION: 8 + NODE_VERSION: 20.9 + +jobs: + check: + strategy: + fail-fast: true + + name: Lint + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + with: + submodules: recursive + + - uses: pnpm/action-setup@v2 + with: + version: ${{ env.PNPM_VERSION }} + + - uses: actions/setup-node@v3 + with: + node-version: ${{ env.NODE_VERSION }} + cache: 'pnpm' + + - name: Install dependencies + run: pnpm install + id: install + + - name: Run linter + run: pnpm run check + id: lint diff --git a/.gitignore b/.gitignore index 85198aa..d2ba2a1 100644 --- a/.gitignore +++ b/.gitignore @@ -12,3 +12,6 @@ docs/ # Dotenv file .env + +# Dependencies +node_modules/ diff --git a/.prettierignore b/.prettierignore new file mode 100644 index 0000000..2c65093 --- /dev/null +++ b/.prettierignore @@ -0,0 +1,4 @@ +cache/ +lib/ +node_modules/ +out/ diff --git a/.prettierrc b/.prettierrc new file mode 100644 index 0000000..59fa191 --- /dev/null +++ b/.prettierrc @@ -0,0 +1,5 @@ +# .prettierrc or .prettierrc.yaml +trailingComma: 'es5' +tabWidth: 2 +semi: false +singleQuote: true diff --git a/package.json b/package.json new file mode 100644 index 0000000..660433a --- /dev/null +++ b/package.json @@ -0,0 +1,21 @@ +{ + "name": "tiny-web3", + "version": "1.0.0", + "description": "Tiny web3 protocols and applications.", + "main": "index.js", + "directories": { + "lib": "lib", + "test": "test" + }, + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1", + "check": "pnpm exec prettier --plugin prettier-plugin-solidity --check .", + "lint": "pnpm exec prettier --plugin prettier-plugin-solidity --write ." + }, + "author": "", + "license": "ISC", + "devDependencies": { + "prettier": "^3.0.3", + "prettier-plugin-solidity": "^1.1.3" + } +} diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml new file mode 100644 index 0000000..7483ba9 --- /dev/null +++ b/pnpm-lock.yaml @@ -0,0 +1,85 @@ +lockfileVersion: 5.3 + +specifiers: + prettier: ^3.0.3 + prettier-plugin-solidity: ^1.1.3 + +devDependencies: + prettier: 3.0.3 + prettier-plugin-solidity: 1.1.3_prettier@3.0.3 + +packages: + /@solidity-parser/parser/0.16.1: + resolution: + { + integrity: sha512-PdhRFNhbTtu3x8Axm0uYpqOy/lODYQK+MlYSgqIsq2L8SFYEHJPHNUiOTAJbDGzNjjr1/n9AcIayxafR/fWmYw==, + } + dependencies: + antlr4ts: 0.5.0-alpha.4 + dev: true + + /antlr4ts/0.5.0-alpha.4: + resolution: + { + integrity: sha512-WPQDt1B74OfPv/IMS2ekXAKkTZIHl88uMetg6q3OTqgFxZ/dxDXI0EWLyZid/1Pe6hTftyg5N7gel5wNAGxXyQ==, + } + dev: true + + /lru-cache/6.0.0: + resolution: + { + integrity: sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==, + } + engines: { node: '>=10' } + dependencies: + yallist: 4.0.0 + dev: true + + /prettier-plugin-solidity/1.1.3_prettier@3.0.3: + resolution: + { + integrity: sha512-fQ9yucPi2sBbA2U2Xjh6m4isUTJ7S7QLc/XDDsktqqxYfTwdYKJ0EnnywXHwCGAaYbQNK+HIYPL1OemxuMsgeg==, + } + engines: { node: '>=12' } + peerDependencies: + prettier: '>=2.3.0 || >=3.0.0-alpha.0' + dependencies: + '@solidity-parser/parser': 0.16.1 + prettier: 3.0.3 + semver: 7.5.4 + solidity-comments-extractor: 0.0.7 + dev: true + + /prettier/3.0.3: + resolution: + { + integrity: sha512-L/4pUDMxcNa8R/EthV08Zt42WBO4h1rarVtK0K+QJG0X187OLo7l699jWw0GKuwzkPQ//jMFA/8Xm6Fh3J/DAg==, + } + engines: { node: '>=14' } + hasBin: true + dev: true + + /semver/7.5.4: + resolution: + { + integrity: sha512-1bCSESV6Pv+i21Hvpxp3Dx+pSD8lIPt8uVjRrxAUt/nbswYc+tK6Y2btiULjd4+fnq15PX+nqQDC7Oft7WkwcA==, + } + engines: { node: '>=10' } + hasBin: true + dependencies: + lru-cache: 6.0.0 + dev: true + + /solidity-comments-extractor/0.0.7: + resolution: + { + integrity: sha512-wciNMLg/Irp8OKGrh3S2tfvZiZ0NEyILfcRCXCD4mp7SgK/i9gzLfhY2hY7VMCQJ3kH9UB9BzNdibIVMchzyYw==, + } + dev: true + + /yallist/4.0.0: + resolution: + { + integrity: sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==, + } + dev: true From 8b78179501076b6d9c66ae0e6af116c117037f56 Mon Sep 17 00:00:00 2001 From: leovct Date: Wed, 1 Nov 2023 09:52:45 +0100 Subject: [PATCH 2/5] chore: update lock file --- pnpm-lock.yaml | 81 +++++++++++++++++++------------------------------- 1 file changed, 31 insertions(+), 50 deletions(-) diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 7483ba9..e9232dd 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -1,46 +1,39 @@ -lockfileVersion: 5.3 +lockfileVersion: '6.0' -specifiers: - prettier: ^3.0.3 - prettier-plugin-solidity: ^1.1.3 +settings: + autoInstallPeers: true + excludeLinksFromLockfile: false devDependencies: - prettier: 3.0.3 - prettier-plugin-solidity: 1.1.3_prettier@3.0.3 + prettier: + specifier: ^3.0.3 + version: 3.0.3 + prettier-plugin-solidity: + specifier: ^1.1.3 + version: 1.1.3(prettier@3.0.3) packages: - /@solidity-parser/parser/0.16.1: - resolution: - { - integrity: sha512-PdhRFNhbTtu3x8Axm0uYpqOy/lODYQK+MlYSgqIsq2L8SFYEHJPHNUiOTAJbDGzNjjr1/n9AcIayxafR/fWmYw==, - } + + /@solidity-parser/parser@0.16.1: + resolution: {integrity: sha512-PdhRFNhbTtu3x8Axm0uYpqOy/lODYQK+MlYSgqIsq2L8SFYEHJPHNUiOTAJbDGzNjjr1/n9AcIayxafR/fWmYw==} dependencies: antlr4ts: 0.5.0-alpha.4 dev: true - /antlr4ts/0.5.0-alpha.4: - resolution: - { - integrity: sha512-WPQDt1B74OfPv/IMS2ekXAKkTZIHl88uMetg6q3OTqgFxZ/dxDXI0EWLyZid/1Pe6hTftyg5N7gel5wNAGxXyQ==, - } + /antlr4ts@0.5.0-alpha.4: + resolution: {integrity: sha512-WPQDt1B74OfPv/IMS2ekXAKkTZIHl88uMetg6q3OTqgFxZ/dxDXI0EWLyZid/1Pe6hTftyg5N7gel5wNAGxXyQ==} dev: true - /lru-cache/6.0.0: - resolution: - { - integrity: sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==, - } - engines: { node: '>=10' } + /lru-cache@6.0.0: + resolution: {integrity: sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==} + engines: {node: '>=10'} dependencies: yallist: 4.0.0 dev: true - /prettier-plugin-solidity/1.1.3_prettier@3.0.3: - resolution: - { - integrity: sha512-fQ9yucPi2sBbA2U2Xjh6m4isUTJ7S7QLc/XDDsktqqxYfTwdYKJ0EnnywXHwCGAaYbQNK+HIYPL1OemxuMsgeg==, - } - engines: { node: '>=12' } + /prettier-plugin-solidity@1.1.3(prettier@3.0.3): + resolution: {integrity: sha512-fQ9yucPi2sBbA2U2Xjh6m4isUTJ7S7QLc/XDDsktqqxYfTwdYKJ0EnnywXHwCGAaYbQNK+HIYPL1OemxuMsgeg==} + engines: {node: '>=12'} peerDependencies: prettier: '>=2.3.0 || >=3.0.0-alpha.0' dependencies: @@ -50,36 +43,24 @@ packages: solidity-comments-extractor: 0.0.7 dev: true - /prettier/3.0.3: - resolution: - { - integrity: sha512-L/4pUDMxcNa8R/EthV08Zt42WBO4h1rarVtK0K+QJG0X187OLo7l699jWw0GKuwzkPQ//jMFA/8Xm6Fh3J/DAg==, - } - engines: { node: '>=14' } + /prettier@3.0.3: + resolution: {integrity: sha512-L/4pUDMxcNa8R/EthV08Zt42WBO4h1rarVtK0K+QJG0X187OLo7l699jWw0GKuwzkPQ//jMFA/8Xm6Fh3J/DAg==} + engines: {node: '>=14'} hasBin: true dev: true - /semver/7.5.4: - resolution: - { - integrity: sha512-1bCSESV6Pv+i21Hvpxp3Dx+pSD8lIPt8uVjRrxAUt/nbswYc+tK6Y2btiULjd4+fnq15PX+nqQDC7Oft7WkwcA==, - } - engines: { node: '>=10' } + /semver@7.5.4: + resolution: {integrity: sha512-1bCSESV6Pv+i21Hvpxp3Dx+pSD8lIPt8uVjRrxAUt/nbswYc+tK6Y2btiULjd4+fnq15PX+nqQDC7Oft7WkwcA==} + engines: {node: '>=10'} hasBin: true dependencies: lru-cache: 6.0.0 dev: true - /solidity-comments-extractor/0.0.7: - resolution: - { - integrity: sha512-wciNMLg/Irp8OKGrh3S2tfvZiZ0NEyILfcRCXCD4mp7SgK/i9gzLfhY2hY7VMCQJ3kH9UB9BzNdibIVMchzyYw==, - } + /solidity-comments-extractor@0.0.7: + resolution: {integrity: sha512-wciNMLg/Irp8OKGrh3S2tfvZiZ0NEyILfcRCXCD4mp7SgK/i9gzLfhY2hY7VMCQJ3kH9UB9BzNdibIVMchzyYw==} dev: true - /yallist/4.0.0: - resolution: - { - integrity: sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==, - } + /yallist@4.0.0: + resolution: {integrity: sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==} dev: true From f575201f9138d4671d81dba1d51f0ef6567d6e29 Mon Sep 17 00:00:00 2001 From: leovct Date: Wed, 1 Nov 2023 09:53:02 +0100 Subject: [PATCH 3/5] chore: nit --- .github/workflows/lint.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index e7d1a9e..b647eac 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -3,8 +3,8 @@ name: lint on: push env: - PNPM_VERSION: 8 - NODE_VERSION: 20.9 + PNPM_VERSION: '8' + NODE_VERSION: '20.9' jobs: check: From 1c4df8b8523a1680965925c27a7bc49240b30af1 Mon Sep 17 00:00:00 2001 From: leovct Date: Wed, 1 Nov 2023 09:54:13 +0100 Subject: [PATCH 4/5] chore: lint --- pnpm-lock.yaml | 49 ++++++++++++++++++++++++++++++++++++------------- src/TinyENS.sol | 4 +++- 2 files changed, 39 insertions(+), 14 deletions(-) diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index e9232dd..3f9c204 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -13,27 +13,38 @@ devDependencies: version: 1.1.3(prettier@3.0.3) packages: - /@solidity-parser/parser@0.16.1: - resolution: {integrity: sha512-PdhRFNhbTtu3x8Axm0uYpqOy/lODYQK+MlYSgqIsq2L8SFYEHJPHNUiOTAJbDGzNjjr1/n9AcIayxafR/fWmYw==} + resolution: + { + integrity: sha512-PdhRFNhbTtu3x8Axm0uYpqOy/lODYQK+MlYSgqIsq2L8SFYEHJPHNUiOTAJbDGzNjjr1/n9AcIayxafR/fWmYw==, + } dependencies: antlr4ts: 0.5.0-alpha.4 dev: true /antlr4ts@0.5.0-alpha.4: - resolution: {integrity: sha512-WPQDt1B74OfPv/IMS2ekXAKkTZIHl88uMetg6q3OTqgFxZ/dxDXI0EWLyZid/1Pe6hTftyg5N7gel5wNAGxXyQ==} + resolution: + { + integrity: sha512-WPQDt1B74OfPv/IMS2ekXAKkTZIHl88uMetg6q3OTqgFxZ/dxDXI0EWLyZid/1Pe6hTftyg5N7gel5wNAGxXyQ==, + } dev: true /lru-cache@6.0.0: - resolution: {integrity: sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==} - engines: {node: '>=10'} + resolution: + { + integrity: sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==, + } + engines: { node: '>=10' } dependencies: yallist: 4.0.0 dev: true /prettier-plugin-solidity@1.1.3(prettier@3.0.3): - resolution: {integrity: sha512-fQ9yucPi2sBbA2U2Xjh6m4isUTJ7S7QLc/XDDsktqqxYfTwdYKJ0EnnywXHwCGAaYbQNK+HIYPL1OemxuMsgeg==} - engines: {node: '>=12'} + resolution: + { + integrity: sha512-fQ9yucPi2sBbA2U2Xjh6m4isUTJ7S7QLc/XDDsktqqxYfTwdYKJ0EnnywXHwCGAaYbQNK+HIYPL1OemxuMsgeg==, + } + engines: { node: '>=12' } peerDependencies: prettier: '>=2.3.0 || >=3.0.0-alpha.0' dependencies: @@ -44,23 +55,35 @@ packages: dev: true /prettier@3.0.3: - resolution: {integrity: sha512-L/4pUDMxcNa8R/EthV08Zt42WBO4h1rarVtK0K+QJG0X187OLo7l699jWw0GKuwzkPQ//jMFA/8Xm6Fh3J/DAg==} - engines: {node: '>=14'} + resolution: + { + integrity: sha512-L/4pUDMxcNa8R/EthV08Zt42WBO4h1rarVtK0K+QJG0X187OLo7l699jWw0GKuwzkPQ//jMFA/8Xm6Fh3J/DAg==, + } + engines: { node: '>=14' } hasBin: true dev: true /semver@7.5.4: - resolution: {integrity: sha512-1bCSESV6Pv+i21Hvpxp3Dx+pSD8lIPt8uVjRrxAUt/nbswYc+tK6Y2btiULjd4+fnq15PX+nqQDC7Oft7WkwcA==} - engines: {node: '>=10'} + resolution: + { + integrity: sha512-1bCSESV6Pv+i21Hvpxp3Dx+pSD8lIPt8uVjRrxAUt/nbswYc+tK6Y2btiULjd4+fnq15PX+nqQDC7Oft7WkwcA==, + } + engines: { node: '>=10' } hasBin: true dependencies: lru-cache: 6.0.0 dev: true /solidity-comments-extractor@0.0.7: - resolution: {integrity: sha512-wciNMLg/Irp8OKGrh3S2tfvZiZ0NEyILfcRCXCD4mp7SgK/i9gzLfhY2hY7VMCQJ3kH9UB9BzNdibIVMchzyYw==} + resolution: + { + integrity: sha512-wciNMLg/Irp8OKGrh3S2tfvZiZ0NEyILfcRCXCD4mp7SgK/i9gzLfhY2hY7VMCQJ3kH9UB9BzNdibIVMchzyYw==, + } dev: true /yallist@4.0.0: - resolution: {integrity: sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==} + resolution: + { + integrity: sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==, + } dev: true diff --git a/src/TinyENS.sol b/src/TinyENS.sol index d4cb583..d227512 100644 --- a/src/TinyENS.sol +++ b/src/TinyENS.sol @@ -59,7 +59,9 @@ contract TinyENS is ITinyENS { return registry[name]; } - function reverse(address targetAddress) external view returns (string memory) { + function reverse( + address targetAddress + ) external view returns (string memory) { return reverseRegistry[targetAddress]; } } From 793e079e9890d42401c2901af18400986081be91 Mon Sep 17 00:00:00 2001 From: leovct Date: Wed, 1 Nov 2023 09:58:41 +0100 Subject: [PATCH 5/5] chore: nit --- .prettierrc | 1 - 1 file changed, 1 deletion(-) diff --git a/.prettierrc b/.prettierrc index 59fa191..6b9c164 100644 --- a/.prettierrc +++ b/.prettierrc @@ -1,4 +1,3 @@ -# .prettierrc or .prettierrc.yaml trailingComma: 'es5' tabWidth: 2 semi: false