Project Init (#1)

### ESLint Plugin for AssemblyScript:
* Created two sets of rules: `asPlugin` for AssemblyScript language rules and `perfPlugin` for performance optimization rules. Current implemented rules are `dont-omit-else`, `no-spread`, `no-unsupported-keyword`, and `array-init-style`. (`plugins/asPlugin.ts`, `plugins/perfPlugin.ts`, `plugins/rules/*`) [[1]](diffhunk://#diff-c0b46ba160117ac54a3f360ff53dc85bb6a5f2ba342e99d0735670a27980a12dR1-R18) [[2]](diffhunk://#diff-60d5a6b7617e8cc6b93b305f375a86b8ad208eb1890e1a411dfd84588d4b07ccR1-R13) [[3]](diffhunk://#diff-547b5cd9d1f05669a90c496b3c1705d80bc46aaa6387dbe35020c95f2a900145R1-R65) [[4]](diffhunk://#diff-56c2dcf56fa3969834eeba79d6c087553996f45b5f6e871759db1b1a3f33e4d2R1-R86) [[5]](diffhunk://#diff-afa12ab290d6de40b8cd41f63ddf94eaf500780e632ee97b0c9a1678c7e006ecR1-R40) [[6]](diffhunk://#diff-ef3ad7df6c2ccbca80280f8b5c3063082e64a807040d4f07de8192b7f0701a7eR1-R48)
* Added documentation for each rule, explaining their purpose, usage, and examples. (`docs/rules/array-init-style.md`, `docs/rules/dont-omit-else.md`, `docs/rules/no-spread.md`, `docs/rules/no-unsupported-keyword.md`) [[1]](diffhunk://#diff-d2ee6f771e0116b9e11609d2b1683c1bb2a8a77efc141cef4e645cd5be1c55e7R1-R25) [[2]](diffhunk://#diff-cb2b4875d22ce10c641c14d950391902a59a0d78104c92bc80343ebd7f817521R1-R47) [[3]](diffhunk://#diff-40b55447478cb0d11c5464aa80c68744c0c0c8c0ce486e1e4204f29f46321d21R1-R47) [[4]](diffhunk://#diff-a599e2ebc70e93a1575ccb96d5c4b3557591a6f6cb12cddb9d98dd205f415a05R1-R59)

#### 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

### Development Environment Setup:
* Configured CI workflows to automate testing, linting, spell-checking, and code formatting. (`.github/workflows/ci.yml`)
* Added Prettier configuration and ignore files for consistent code formatting. (`.prettierrc.yaml`, `.prettierignore`) [[1]](diffhunk://#diff-3658ca8ad2a159675c1e1ba5c0b743a851c9d356ca5776dd047f639bfd73de25R1-R18) [[2]](diffhunk://#diff-b640b344ee7f3f03d2a443795a5d0708ef50e2e6e34214109ab2aad13ad6ba98R1-R8)
* Introduced a spell-check configuration (`cspell.json`) and a project-specific dictionary (`cspell/project-words.txt`) to ensure proper spelling in code and documentation. [[1]](diffhunk://#diff-77519f787fe7e051a14c588f101d61e4d8f0d3b01bf8e16cb65d3838243d4e68R1-R27) [[2]](diffhunk://#diff-422a965a191f047c5bf668bcd269fb4e6968972bf2996a3bcc406e37bef609a5R1-R48)

Author: xpirad

.c8rc.json

@@ -0,0 +1,11 @@
+{
+  "all": true,
+  "include": ["dist/plugins/rules/**/*.js"],
+  "reporter": ["text", "html", "lcov"],
+  "report-dir": "./coverage",
+  "check-coverage": true,
+  "branches": 95,
+  "lines": 95,
+  "functions": 95,
+  "statements": 95
+}

.github/workflows/ci.yml

@@ -0,0 +1,36 @@
+name: CI
+
+on:
+  pull_request:
+    branches:
+      - "main"
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "22.3.x"
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run build
+        run: npm run build
+
+      - name: Run spell check
+        run: npm run spell-check
+
+      - name: Run prettier
+        run: npm run prettier-check
+
+      - name: Run lint
+        run: npm run lint
+
+      - name: Run test & coverage
+        run: npm run test:coverage

.gitignore

@@ -0,0 +1,7 @@
+node_modules
+dist/
+sample_cases/
+wasm-toolchain
+coverage
+.vscode
+reference

.prettierignore

@@ -0,0 +1,8 @@
+/node_modules/**
+dist/**
+reference/**
+sample_cases/**
+sample_config/**
+build/**
+wasm-toolchain/**
+coverage/**

.prettierrc.yaml

@@ -0,0 +1,18 @@
+arrowParens: always
+bracketSpacing: true
+endOfLine: lf
+htmlWhitespaceSensitivity: css
+insertPragma: false
+singleAttributePerLine: false
+bracketSameLine: false
+jsxSingleQuote: false
+printWidth: 80
+proseWrap: preserve
+quoteProps: as-needed
+requirePragma: false
+semi: true
+singleQuote: false
+tabWidth: 2
+trailingComma: es5
+useTabs: false
+embeddedLanguageFormatting: auto

Readme.md

@@ -1 +1,34 @@
-This repo contains eslint rules for assemblyscript
+# 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
+
+## Configuration
+
+See `sample_config/sample_eslint.config.mjs` for a detailed example of how to configure and use this plugin.
+
+## Documentation
+
+For detailed rule documentation, see the [docs/rules](./docs/rules) directory.

cspell.json

@@ -0,0 +1,27 @@
+{
+  "version": "0.2",
+  "language": "en",
+  "words": [],
+  "dictionaries": ["typescript", "node", "npm", "project-words"],
+  "dictionaryDefinitions": [
+    {
+      "name": "project-words",
+      "path": "cspell/project-words.txt",
+      "description": "Project specific words"
+    }
+  ],
+  "ignorePaths": [
+    "/node_modules/**",
+    "dist/**",
+    "reference/**",
+    "sample_cases/**",
+    "sample_config/**",
+    "build/**",
+    "tests/**",
+    "wasm-toolchain/**",
+    "coverage/**",
+    ".github/**",
+    "**/*.json",
+    "**/*.md"
+  ]
+}

cspell/project-words.txt

@@ -0,0 +1,48 @@
+assemblyscript
+wasm
+webassembly
+eslint
+linter
+linting
+ruleset
+rulename
+messageId
+autofix
+autofixer
+codefix
+ast
+sourcecode
+parserservices
+typechecker
+tsconfig
+tseslint
+tses
+
+// AssemblyScript types and keywords
+i8
+i16
+i32
+i64
+
+// Performance optimization terms
+perf
+benchmarking
+memcpy
+
+// Common variable/function name abbreviations
+ctx
+params
+args
+
+// Tools and frameworks
+mocha
+tsx
+tester
+
+// Project directories and files
+dist
+plugins
+cspell
+
+// rule keywords
+dont

docs/rules/array-init-style.md

@@ -0,0 +1,25 @@
+# array-init-style
+
+> Enforce using Array constructor for empty array initialization
+
+## Rule Details
+
+In AssemblyScript, using the literal `[]` to create empty arrays creates a temporary object in the data section, which may lead to performance issues. This rule enforces using the `new Array<T>()` constructor to initialize empty arrays.
+
+## Rule Options
+
+This rule has no configuration options.
+
+## Examples
+
+### Incorrect
+
+```ts
+let arr: i32[] = []; // not recommended
+```
+
+### Correct
+
+```ts
+let arr: i32[] = new Array<i32>(); // recommended
+```

docs/rules/dont-omit-else.md

@@ -0,0 +1,47 @@
+# dont-omit-else
+
+> Enforce using else block when if branch doesn't contain control flow statement
+
+## Rule Details
+
+In AssemblyScript, it's recommended to explicitly handle all possible execution paths for better code clarity and safety. This rule enforces using an `else` block when the `if` branch doesn't contain a statement that alters the control flow, such as `return`, `throw`, `break`, or `continue`.
+
+## Rule Options
+
+This rule has no configuration options.
+
+## Examples
+
+### Incorrect
+
+```ts
+if (condition) {
+  doSomething();
+} // missing else
+```
+
+### Correct
+
+```ts
+// With else block
+if (condition) {
+  doSomething();
+} else {
+  doSomethingElse();
+}
+
+// Or with early exit in if branch
+if (condition) {
+  doSomething();
+  return; // Control flow statement makes else unnecessary
+}
+// Execution continues here only if condition is false
+```
+
+## When Not To Use
+
+You can disable this rule if you prefer a coding style that doesn't require explicit else blocks for all conditional statements.
+
+## Related Rules
+
+None