ESLint Plugin for AssemblyScript

An ESLint plugin that helps developers write better AssemblyScript code by enforcing language-specific rules and best practices.

Overview

This plugin provides two sets of rules:

• Language Standards: Rules that enforce AssemblyScript language restrictions and prevent errors
• Performance Optimization: Rules that help improve code performance in WebAssembly

Plugins Included

Standard Rules (asPlugin.ts)

Enforces AssemblyScript language compatibility:

• dont-omit-else: Requires explicit else blocks for conditionals that don't have early return statements
• no-spread: Prevents use of spread syntax (...) which is not supported in AssemblyScript
• no-unsupported-keyword: Disallows TypeScript keywords not supported in AssemblyScript (any, never, undefined)

Performance Rules (perfPlugin.ts)

Optimizes code for better WebAssembly performance:

• array-init-style: Recommends using new Array<T>() instead of [] for initializing empty arrays

• no-repeated-member-access: Recommends extracting repeated member access to improve performance

Configuration

See eslint.config.publish.mjs for a detailed example of how to configure and use this plugin.

It includes some other pre-written rules including:

• no-implicit-globals: Warns against creating implicit global variables
• curly: Requires curly braces for all control statements to prevent error-prone one-liner code
• @typescript-eslint/no-restricted-types: Enforces AssemblyScript-specific type usage:
  • Use string instead of String
  • Use bool instead of Boolean
  • Disallows unsupported types like undefined and object
• @typescript-eslint/adjacent-overload-signatures: Requires overload signatures to be adjacent

Documentation

For detailed rule documentation, see the docs/rules directory.