style: fix some lint

Author: cwillisf

src/Asset.ts

@@ -25,7 +25,7 @@ export default class Asset {
      * @param {string} assetId - The ID of this asset.
      * @param {DataFormat} [dataFormat] - The format of the data (WAV, PNG, etc.); required iff `data` is present.
      * @param {Buffer} [data] - The in-memory data for this asset; optional.
-     * @param {bool} [generateId] - Whether to create id from an md5 hash of data
+     * @param {boolean} [generateId] - Whether to create id from an md5 hash of data
      */
     constructor (
         assetType: AssetType,
@@ -79,7 +79,7 @@ export default class Asset {
      * Same as `setData` but encodes text first.
      * @param {string} data - the text data to encode and store.
      * @param {DataFormat} dataFormat - the format of the data (DataFormat.SVG for example).
-     * @param {bool} generateId - after setting data, set the id to an md5 of the data?
+     * @param {boolean} generateId - after setting data, set the id to an md5 of the data?
      */
     encodeTextData (data: string, dataFormat: DataFormat, generateId: boolean): void {
         const encoder = new _TextEncoder();

src/AssetType.ts

@@ -9,8 +9,8 @@ export interface AssetType {
 
 /**
  * Enumeration of the supported asset types.
- * @type {Object.<String,AssetType>}
- * @typedef {Object} AssetType - Information about a supported asset type.
+ * @type {{[assetTypeName: string]: AssetType}}
+ * @typedef {object} AssetType - Information about a supported asset type.
  * @property {string} contentType - the MIME type associated with this kind of data. Useful for data URIs, etc.
  * @property {string} name - The human-readable name of this asset type.
  * @property {DataFormat} runtimeFormat - The default format used for runtime, in-memory storage of this asset. For

src/BuiltinHelper.ts

@@ -67,8 +67,8 @@ export default class BuiltinHelper extends Helper {
 
         /**
          * In-memory storage for all built-in assets.
-         * @type {Object.<AssetType, AssetIdMap>} Maps asset type to a map of asset ID to actual assets.
-         * @typedef {Object.<string, BuiltinAssetRecord>} AssetIdMap - Maps asset ID to asset.
+         * @type {{[assetType: string]: AssetIdMap}} Maps asset type to a map of asset ID to actual assets.
+         * @typedef {{[id: string]: BuiltinAssetRecord}} AssetIdMap - Maps asset ID to asset.
          */
         this.assets = {};
 
@@ -97,7 +97,7 @@ export default class BuiltinHelper extends Helper {
     get (assetId: AssetId): Asset | null {
         let asset: Asset | null = null;
         if (Object.prototype.hasOwnProperty.call(this.assets, assetId)) {
-            /** @type{BuiltinAssetRecord} */
+            /** @type {BuiltinAssetRecord} */
             const assetRecord = this.assets[assetId];
             asset = new Asset(assetRecord.type, assetRecord.id!, assetRecord.format, assetRecord.data);
         }
@@ -163,7 +163,7 @@ export default class BuiltinHelper extends Helper {
      * Fetch an asset but don't process dependencies.
      * @param {AssetType} assetType - The type of asset to fetch.
      * @param {string} assetId - The ID of the asset to fetch: a project ID, MD5, etc.
-     * @return {?Promise.<Asset>} A promise for the contents of the asset.
+     * @returns {?Promise.<Asset>} A promise for the contents of the asset.
      */
     load (assetType: AssetType, assetId: AssetId): Promise<Asset | null> | null {
         if (!this.get(assetId)) {

src/FetchWorkerTool.ts

@@ -48,7 +48,6 @@ class PrivateFetchWorkerTool implements Tool {
                 // Yes, this is a browser API and we've specified `browser: false` in the eslint env,
                 // but `isGetSupported` checks for the presence of Worker and uses it only if present.
                 // Also see https://webpack.js.org/guides/web-workers/
-                // eslint-disable-next-line no-undef
                 const worker = new Worker(
                     /* webpackChunkName: "fetch-worker" */ new URL('./FetchWorkerTool.worker', import.meta.url)
                 );

src/FetchWorkerTool.worker.js

@@ -41,7 +41,8 @@ const registerStep = function () {
 
 /**
  * Receive a job from the parent and fetch the requested data.
- * @param {object} options.job A job id, url, and options descriptor to perform.
+ * @param {object} message The message from the parent.
+ * @param {object} message.data A job id, url, and options descriptor to perform.
  */
 const onMessage = ({data: job}) => {
     if (jobsActive === 0 && !intervalId) {

src/Helper.ts

@@ -19,7 +19,7 @@ export default class Helper {
      * @param {AssetType} assetType - The type of asset to fetch.
      * @param {string} assetId - The ID of the asset to fetch: a project ID, MD5, etc.
      * @param {DataFormat} dataFormat - The file format / file extension of the asset to fetch: PNG, JPG, etc.
-     * @return {Promise.<Asset>} A promise for the contents of the asset.
+     * @returns {Promise.<Asset>} A promise for the contents of the asset.
      */
     load (assetType: AssetType, assetId: AssetId, dataFormat: DataFormat): Promise<Asset | null> | null {
         return Promise.reject(new Error(`No asset of type ${assetType} for ID ${assetId} with format ${dataFormat}`));

src/ScratchStorage.ts

@@ -41,50 +41,50 @@ export class ScratchStorage {
     }
 
     /**
-     * @return {Asset} - the `Asset` class constructor.
-     * @constructor
+     * @returns {Asset} - the `Asset` class constructor.
+     * @class
      */
     get Asset () {
         return _Asset;
     }
 
     /**
-     * @return {AssetType} - the list of supported asset types.
-     * @constructor
+     * @returns {AssetType} - the list of supported asset types.
+     * @class
      */
     get AssetType () {
         return _AssetType;
     }
 
     /**
-     * @return {DataFormat} - the list of supported data formats.
-     * @constructor
+     * @returns {DataFormat} - the list of supported data formats.
+     * @class
      */
     get DataFormat () {
         return _DataFormat;
     }
 
     /**
      * Access the `scratchFetch` module within this library.
-     * @return {module} the scratchFetch module, with properties for `scratchFetch`, `setMetadata`, etc.
+     * @returns {module} the scratchFetch module, with properties for `scratchFetch`, `setMetadata`, etc.
      */
     get scratchFetch () {
         return _scratchFetch;
     }
 
     /**
      * @deprecated Please use the `Asset` member of a storage instance instead.
-     * @return {Asset} - the `Asset` class constructor.
-     * @constructor
+     * @returns {Asset} - the `Asset` class constructor.
+     * @class
      */
     static get Asset () {
         return _Asset;
     }
 
     /**
      * @deprecated Please use the `AssetType` member of a storage instance instead.
-     * @return {AssetType} - the list of supported asset types.
-     * @constructor
+     * @returns {AssetType} - the list of supported asset types.
+     * @class
      */
     static get AssetType () {
         return _AssetType;
@@ -174,7 +174,7 @@ export class ScratchStorage {
     /**
      * TODO: Should this be removed in favor of requesting an asset with `null` as the ID?
      * @param {AssetType} type - Get the default ID for assets of this type.
-     * @return {?string} The ID of the default asset of the given type, if any.
+     * @returns {?string} The ID of the default asset of the given type, if any.
      */
     getDefaultAssetId (type: AssetType): AssetId | undefined {
         if (Object.prototype.hasOwnProperty.call(this.defaultAssetId, type.name)) {
@@ -199,7 +199,7 @@ export class ScratchStorage {
      * @param {AssetType} assetType - The type of asset to fetch. This also determines which asset store to use.
      * @param {string} assetId - The ID of the asset to fetch: a project ID, MD5, etc.
      * @param {DataFormat} [dataFormat] - Optional: load this format instead of the AssetType's default.
-     * @return {Promise.<Asset>} A promise for the requested Asset.
+     * @returns {Promise.<Asset>} A promise for the requested Asset.
      *   If the promise is resolved with non-null, the value is the requested asset.
      *   If the promise is resolved with null, the desired asset could not be found with the current asset sources.
      *   If the promise is rejected, there was an error on at least one asset source. HTTP 404 does not count as an
@@ -247,7 +247,7 @@ export class ScratchStorage {
      * @param {?DataFormat} [dataFormat] - Optional: load this format instead of the AssetType's default.
      * @param {Buffer} data - Data to store for the asset
      * @param {?string} [assetId] - The ID of the asset to fetch: a project ID, MD5, etc.
-     * @return {Promise.<object>} A promise for asset metadata
+     * @returns {Promise.<object>} A promise for asset metadata
      */
     store (assetType: AssetType, dataFormat: DataFormat | null | undefined, data: AssetData, assetId?: AssetId) {
         dataFormat = dataFormat || assetType.runtimeFormat;

src/WebHelper.ts

@@ -103,7 +103,7 @@ export default class WebHelper extends Helper {
      * @param {AssetType} assetType - The type of asset to fetch.
      * @param {string} assetId - The ID of the asset to fetch: a project ID, MD5, etc.
      * @param {DataFormat} dataFormat - The file format / file extension of the asset to fetch: PNG, JPG, etc.
-     * @return {Promise.<Asset>} A promise for the contents of the asset.
+     * @returns {Promise.<Asset>} A promise for the contents of the asset.
      */
     load (assetType: AssetType, assetId: AssetId, dataFormat: DataFormat): Promise<Asset | null> {
 
@@ -162,7 +162,7 @@ export default class WebHelper extends Helper {
      * @param {?DataFormat} dataFormat - DataFormat of the data for the stored asset.
      * @param {Buffer} data - The data for the cached asset.
      * @param {?string} assetId - The ID of the asset to fetch: a project ID, MD5, etc.
-     * @return {Promise.<object>} A promise for the response from the create or update request
+     * @returns {Promise.<object>} A promise for the response from the create or update request
      */
     store (
         assetType: AssetType,

src/memoizedToString.ts

@@ -15,7 +15,6 @@ let _TextDecoder: typeof TextDecoder;
 let _TextEncoder: typeof TextEncoder;
 if (typeof TextDecoder === 'undefined' || typeof TextEncoder === 'undefined') {
     // Wait to require the text encoding polyfill until we know it's needed.
-    // eslint-disable-next-line global-require
     const encoding = require('fastestsmallesttextencoderdecoder');
     _TextDecoder = encoding.TextDecoder;
     _TextEncoder = encoding.TextEncoder;
@@ -31,13 +30,13 @@ const memoizedToString = (function () {
      * 32766 is a multiple of 3 so btoa does not need to use padding characters
      * except for the final chunk where that is fine. 32766 is also close to
      * 32768 so it is close to a size an memory allocator would prefer.
-     * @const {number}
+     * @constant {number}
      */
     const BTOA_CHUNK_MAX_LENGTH = 32766;
 
     /**
      * An array cache of bytes to characters.
-     * @const {?Array.<string>}
+     * @constant {?Array.<string>}
      */
     let fromCharCode: string[] | null = null;
 
@@ -46,7 +45,6 @@ const memoizedToString = (function () {
         if (!Object.prototype.hasOwnProperty.call(strings, assetId)) {
             if (typeof btoa === 'undefined') {
                 // Use a library that does not need btoa to run.
-                /* eslint-disable-next-line global-require */
                 const base64js = require('base64-js');
                 strings[assetId] = base64js.fromByteArray(data);
             } else {

test/__mocks__/cross-fetch.js

@@ -20,7 +20,7 @@ const successText = 'successful response';
 /**
  * @typedef MockFetchTestData
  * @property {Headers} [headers] A Headers object initialized with the header info received by mockFetch.
- * @property {Number} [headersCount] The number of headers in the 'headers' property.
+ * @property {number} [headersCount] The number of headers in the 'headers' property.
  */
 
 /**