Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Fix more lint warnings #9690

Merged
merged 4 commits into from
Jul 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions .eslintrc.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,27 @@ module.exports = {
// The default is 'warn', but we want to enforce 'error'.
'@jessie.js/safe-await-separator': 'error',

'jsdoc/check-tag-names': [
'error',
{
// TypeDoc adds tags not otherwise known to JSDoc
// https://typedoc.org/guides/tags/
definedTags: [
'alpha',
'beta',
'category',
'categoryDescription',
'defaultValue',
'document',
'group',
'groupDescription',
'internal',
'privateRemarks',
'remarks',
],
},
],

// CI has a separate format check but keep this warn to maintain that "eslint --fix" prettifies
// UNTIL https://github.com/Agoric/agoric-sdk/issues/4339
'prettier/prettier': 'warn',
Expand Down
4 changes: 2 additions & 2 deletions packages/ERTP/src/legacy-payment-helpers.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ import { mustMatch } from '@agoric/store';
import { AmountMath } from './amountMath.js';

/**
* @import {ERef} from '@endo/far');
* @import {Amount, AssetKind, AmountValue, AssetKindForValue, Payment, Brand, Purse} from './types.js'
* @import {ERef} from '@endo/far';
* @import {Amount, AssetKind, AmountValue, AssetKindForValue, Payment, Brand, Purse} from './types.js';
*/

/**
Expand Down
2 changes: 1 addition & 1 deletion packages/ERTP/src/transientNotifier.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import { makeNotifierKit } from '@agoric/notifier';

/**
* @import {Purse} from './types.js';
* @import {LatestTopic, NotifierRecord} from '@agoric/notifier');
* @import {LatestTopic, NotifierRecord} from '@agoric/notifier';
*/

// Note: Virtual for high cardinality, but *not* durable, and so
Expand Down
6 changes: 3 additions & 3 deletions packages/ERTP/src/types.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ export {};

/// <reference types="ses" />
/**
* @import {Passable, RemotableObject} from '@endo/pass-style')
* @import {CopyBag, CopySet, Key} from '@endo/patterns')
* @import {LatestTopic, NotifierRecord} from '@agoric/notifier');
* @import {Passable, RemotableObject} from '@endo/pass-style';
* @import {CopyBag, CopySet, Key} from '@endo/patterns';
* @import {LatestTopic, NotifierRecord} from '@agoric/notifier';
*/

/** @typedef {{ brand: Brand<'nat'>; value: bigint }} NatAmount */
Expand Down
6 changes: 3 additions & 3 deletions packages/SwingSet/src/types-external.js
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
/** @import { ERef } from '@endo/far' */
/** @import { ERef } from '@endo/far'; */

export {};

/**
* @import {Guarded} from '@endo/exo')
* @import {Passable, RemotableObject} from '@endo/pass-style')
* @import {Guarded} from '@endo/exo';
* @import {Passable, RemotableObject} from '@endo/pass-style';
*/

/* This file defines types that part of the external API of swingset. That
Expand Down
16 changes: 8 additions & 8 deletions packages/SwingSet/src/vats/timer/vat-timer.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,21 +16,21 @@ import { makeScalarWeakMapStore } from '@agoric/store';
import { TimeMath } from '@agoric/time';

/**
* @import {Passable, RemotableObject} from '@endo/pass-style')
* @import {Key} from '@endo/patterns')
* @import {Passable, RemotableObject} from '@endo/pass-style';
* @import {Key} from '@endo/patterns';
*/

// This consumes O(N) RAM only for outstanding promises, via wakeAt(),
// delay(), and Notifiers/Iterators (for each actively-waiting
// client). Everything else should remain in the DB.

/**
* @import {Timestamp} from '@agoric/time'
* @import {TimestampRecord} from '@agoric/time'
* @import {TimestampValue} from '@agoric/time'
* @import {RelativeTime} from '@agoric/time'
* @import {RelativeTimeValue} from '@agoric/time'
* @import {TimerService} from '@agoric/time'
* @import {Timestamp} from '@agoric/time';
* @import {TimestampRecord} from '@agoric/time';
* @import {TimestampValue} from '@agoric/time';
* @import {RelativeTime} from '@agoric/time';
* @import {RelativeTimeValue} from '@agoric/time';
* @import {TimerService} from '@agoric/time';
*
* @typedef {object} Handler
* Handler is a user-provided Far object with .wake(time) used for callbacks
Expand Down
2 changes: 1 addition & 1 deletion packages/inter-protocol/src/proposals/utils.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { E } from '@endo/far';
import { WalletName } from '@agoric/internal';
import { getCopyMapEntries, makeCopyMap } from '@agoric/store';

/** @import {CopyMap} from '@endo/patterns') */
/** @import {CopyMap} from '@endo/patterns'; */

/**
* @param {ERef<import('@agoric/vats').NameAdmin>} nameAdmin
Expand Down
4 changes: 2 additions & 2 deletions packages/store/src/stores/scalarMapStore.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ import { makeWeakMapStoreMethods } from './scalarWeakMapStore.js';
import { makeCurrentKeysKit } from './store-utils.js';

/**
* @import {Passable} from '@endo/pass-style');
* @import {Key, Pattern} from '@endo/patterns');
* @import {Passable} from '@endo/pass-style';
* @import {Key, Pattern} from '@endo/patterns';
* @import {MapStore, MapStoreMethods, StoreOptions} from '../types.js';
*/

Expand Down
2 changes: 1 addition & 1 deletion packages/store/src/stores/scalarSetStore.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import { makeWeakSetStoreMethods } from './scalarWeakSetStore.js';
import { makeCurrentKeysKit } from './store-utils.js';

/**
* @import {Key, Pattern} from '@endo/patterns');
* @import {Key, Pattern} from '@endo/patterns';
* @import {SetStore, SetStoreMethods, StoreOptions} from '../types.js';
*/

Expand Down
5 changes: 1 addition & 4 deletions packages/vats/src/lib-board.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import { crc6 } from './crc.js';

/**
* @import {RemotableObject} from '@endo/pass-style';
* @import {Key} from '@endo/patterns');
* @import {Key} from '@endo/patterns';
*/

export const DEFAULT_CRC_DIGITS = 2;
Expand Down Expand Up @@ -80,9 +80,6 @@ const calcCrc = (data, crcDigits) => {
/**
* @typedef {ReturnType<typeof initDurableBoardState>} BoardState // TODO: use
* Key from @agoric/store when available
* @import {Passable} from '@endo/marshal'
* @see {prepareExoClassKit}
* @see {@link ../../SwingSet/docs/virtual-objects.md|SwingSet Virtual Objects} Hoisting this function makes defining the state type concise.
*/

// TODO consider tightening initSequence to bigint only
Expand Down
6 changes: 3 additions & 3 deletions packages/vats/src/vat-bank.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,9 @@ import {
} from './virtual-purse.js';

/**
* @import {Guarded} from '@endo/exo')
* @import {Passable, RemotableObject} from '@endo/pass-style')
* @import {Guarded} from '@endo/exo';
* @import {Passable, RemotableObject} from '@endo/pass-style';
* @import {VirtualPurseController} from './virtual-purse.js';
*/

const { VirtualPurseControllerI } = makeVirtualPurseKitIKit();
Expand All @@ -37,7 +38,6 @@ const BridgeChannelI = M.interface('BridgeChannel', {

/**
* @typedef {Awaited<ReturnType<ReturnType<typeof prepareVirtualPurse>>>} VirtualPurse
* @import {VirtualPurseController} from './virtual-purse.js'
*/

/**
Expand Down
Loading