feat(contract): linting and typedefs #26
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -22,3 +22,5 @@ dist-ssr | |
| *.njsproj | ||
| *.sln | ||
| *.sw? | ||
|
|
||
| _agstate/yarn-links | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -11,23 +11,32 @@ | |
| "docker:make": "docker compose exec agd make -C /workspace/contract", | ||
| "make:help": "make list", | ||
| "start": "yarn docker:make clean start-contract print-key", | ||
| "build": "node_modules/.bin/agoric run scripts/build-game1-start.js", | ||
| "test": "ava --verbose", | ||
| "lint": "yarn lint:eslint # && yarn lint:types", | ||
| "lint:eslint": "eslint '**/*.{js,ts}'", | ||
| "lint:fix": "eslint --fix '**/*.{js,ts}'", | ||
| "lint:types": "tsc" | ||
| }, | ||
| "dependencies": { | ||
| "@agoric/ertp": "0.16.3-u13.0", | ||
| "@agoric/zoe": "0.26.3-u13.0", | ||
|
Comment on lines
+22
to
+23
There was a problem hiding this comment. Have you checked that the resulting bundle is a reasonable size? that we have just 1 version of each endo package? |
||
| "@endo/far": "0.2.18", | ||
| "@endo/marshal": "0.8.5", | ||
| "@endo/patterns": "0.2.2" | ||
| }, | ||
| "devDependencies": { | ||
| "@agoric/deploy-script-support": "^0.10.4-u13.0", | ||
| "@agoric/eslint-config": "dev", | ||
| "@endo/bundle-source": "2.5.2-upstream-rollup", | ||
| "@endo/eslint-plugin": "^0.5.2", | ||
| "@endo/init": "^0.5.60", | ||
| "@endo/promise-kit": "0.2.56", | ||
| "@endo/ses-ava": "^0.2.44", | ||
| "@jessie.js/eslint-plugin": "^0.4.0", | ||
| "@typescript-eslint/eslint-plugin": "^6.7.0", | ||
| "@typescript-eslint/parser": "^6.7.0", | ||
| "agoric": "^0.22.0-u13.0", | ||
| "ava": "^5.3.0", | ||
| "eslint": "^8.47.0", | ||
| "eslint-config-airbnb-base": "^15.0.0", | ||
|
|
@@ -41,20 +50,8 @@ | |
| "import-meta-resolve": "^2.2.1", | ||
| "prettier": "^3.0.3", | ||
| "prettier-plugin-jsdoc": "^1.0.0", | ||
| "typescript": "~5.2.2" | ||
| }, | ||
| "ava": { | ||
| "files": [ | ||
| "test/**/test-*.js" | ||
|
|
@@ -73,8 +70,45 @@ | |
| }, | ||
| "homepage": "https://github.com/agoric-labs/dapp-join-game#readme", | ||
| "eslintConfig": { | ||
| "env": { | ||
|
There was a problem hiding this comment. Whatever knowledge you have learned about lint config, would you please contribute it to... There was a problem hiding this comment. Sure, let me gather some feedback here first to make sure the approach is correct. The main changes are -
Here would be the updated directions from the current answer:
yarn add -D \
eslint \
@agoric/eslint-config@dev \
@endo/eslint-plugin \
@jessie.js/eslint-plugin \
eslint-config-airbnb-base \
eslint-plugin-jsdoc \
eslint-config-prettier \
eslint-plugin-import \
- eslint-plugin-github
+ eslint-plugin-github \
+ @typescript-eslint/eslint-plugin
+ @typescript-eslint/parser
+ typescript
"eslintConfig" : {
+ "env": {
+ "node": true
+ },
+ "parser": "@typescript-eslint/parser",
"parserOptions": {
- "sourceType": "module",
- "ecmaVersion": 6
+ "project": "./tsconfig.json",
+ "sourceType": "module",
+ "ecmaVersion": 2020
},
"extends": [
+ "plugin:@typescript-eslint/recommended",
"@agoric"
],
+ "plugins": [
+ "@typescript-eslint",
+ "prettier"
+ ],
+ "rules": {
+ "@typescript-eslint/no-floating-promises": "warn",
+ "no-void": [
+ "error",
+ {
+ "allowAsStatement": true
+ }
+ ],
+ "prettier/prettier": "warn",
+ "@typescript-eslint/no-unused-vars": [
+ "error",
+ {
+ "vars": "all",
+ "args": "all",
+ "argsIgnorePattern": "^_",
+ "varsIgnorePattern": "^_"
+ }
+ ]
+ },
}
+{
+ "compilerOptions": {
+ "noEmit": true,
+ "target": "esnext",
+ "module": "esnext",
+ "moduleResolution": "node",
+ "skipLibCheck": true,
+ "checkJs": false,
+ "allowJs": true,
+ "allowSyntheticDefaultImports": true,
+ "maxNodeModuleJsDepth": 2,
+ "strict": true
+ },
+ "include": ["**/*.js", "**/*.ts"],
+ "exclude": ["bundles"]
+}
|
||
| "node": true | ||
| }, | ||
| "parser": "@typescript-eslint/parser", | ||
| "parserOptions": { | ||
| "project": "./tsconfig.json", | ||
| "sourceType": "module", | ||
| "ecmaVersion": 2020 | ||
| }, | ||
| "extends": [ | ||
| "plugin:@typescript-eslint/recommended", | ||
| "@agoric" | ||
| ], | ||
| "plugins": [ | ||
| "@typescript-eslint", | ||
| "prettier" | ||
| ], | ||
| "rules": { | ||
| "@typescript-eslint/prefer-ts-expect-error": "warn", | ||
| "@typescript-eslint/no-floating-promises": "warn", | ||
| "no-void": [ | ||
| "error", | ||
| { | ||
| "allowAsStatement": true | ||
| } | ||
| ], | ||
| "prettier/prettier": "warn", | ||
| "@typescript-eslint/no-unused-vars": [ | ||
| "error", | ||
| { | ||
| "vars": "all", | ||
| "args": "all", | ||
| "argsIgnorePattern": "^_", | ||
| "varsIgnorePattern": "^_" | ||
| } | ||
| ] | ||
| }, | ||
| "ignorePatterns": [ | ||
| "bundles" | ||
| ] | ||
| }, | ||
| "prettier": { | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,6 +2,7 @@ | |
| import { E } from '@endo/far'; | ||
| import { makeMarshal } from '@endo/marshal'; | ||
| import { AmountMath } from '@agoric/ertp/src/amountMath.js'; | ||
| import '@agoric/zoe/exported.js'; | ||
|
There was a problem hiding this comment. These bloat bundles. Ugh. Please add an important |
||
|
|
||
| console.warn('start-game1-proposal.js module evaluating'); | ||
|
|
||
|
|
@@ -26,6 +27,11 @@ const makeBoardAuxNode = async (chainStorage, boardId) => { | |
| return E(boardAux).makeChildNode(boardId); | ||
| }; | ||
|
|
||
| /** | ||
| * @param {ERef<StorageNode>} chainStorage | ||
| * @param {ERef<import('@agoric/vats/src/types').Board>} board | ||
| * @param {ERef<Brand>} brand | ||
| */ | ||
| const publishBrandInfo = async (chainStorage, board, brand) => { | ||
| const [id, displayInfo] = await Promise.all([ | ||
| E(board).getId(brand), | ||
|
|
@@ -38,28 +44,25 @@ const publishBrandInfo = async (chainStorage, board, brand) => { | |
|
|
||
| /** | ||
| * Core eval script to start contract | ||
| * XXX FIXME File '~/agoric-sdk/packages/vats/src/core/types.js' is not a module | ||
|
There was a problem hiding this comment. importing the ambient for side-effects should work. |
||
| * @param {import('@agoric/vats/src/core/types').BootstrapPowers} permittedPowers | ||
| */ | ||
| export const startGameContract = async permittedPowers => { | ||
| console.error('startGameContract()...'); | ||
| const { | ||
| consume: { board, chainStorage, startUpgradable, zoe }, | ||
| brand: { | ||
| consume: { IST: istBrandP }, | ||
| produce: { Place: producePlaceBrand }, | ||
| }, | ||
| issuer: { | ||
| consume: { IST: istIssuerP }, | ||
| produce: { Place: producePlaceIssuer }, | ||
| }, | ||
| installation: { | ||
| consume: { game1: game1InstallationP }, | ||
| }, | ||
| instance: { | ||
| produce: { game1: produceInstance }, | ||
| }, | ||
| } = permittedPowers; | ||
|
|
@@ -117,6 +120,10 @@ const gameManifest = { | |
| }; | ||
| harden(gameManifest); | ||
|
|
||
| /** | ||
| * @param {{restoreRef: (ref: unknown) => Promise<unknown> }} r | ||
| * @param {{ game1Ref: unknown }} g | ||
| */ | ||
| export const getManifestForGame1 = ({ restoreRef }, { game1Ref }) => { | ||
| return harden({ | ||
| manifest: gameManifest, | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| { | ||
| "compilerOptions": { | ||
| "noEmit": true, | ||
| "target": "esnext", | ||
| "module": "esnext", | ||
| "moduleResolution": "node", | ||
| "skipLibCheck": true, | ||
| // Don't check by default because that includes node_modules in JS | ||
| "checkJs": false, | ||
| // Features implied with jsconfig.json that have to be explicit in tsconfig.json | ||
| "allowJs": true, | ||
| "allowSyntheticDefaultImports": true, | ||
| "maxNodeModuleJsDepth": 2, | ||
| "strict": true | ||
| }, | ||
| "include": ["**/*.js", "**/*.ts"], | ||
| "exclude": ["bundles"] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
moving the
"dependencies"section makes this diff hard to read.