{chore} setup linting and CI

Author: bgotink

.eslintignore

@@ -0,0 +1,7 @@
+.yarn
+.pnp.js
+
+/packages/*/dist
+
+/integration/e2e/harnesses
+/integration/src

.eslintrc.yml

@@ -0,0 +1,53 @@
+env:
+  node: true
+  es2021: true
+extends:
+  - 'eslint:recommended'
+plugins:
+  - 'import'
+reportUnusedDisableDirectives: true
+parserOptions:
+  ecmaVersion: 12
+
+rules:
+  # Require packages to be listed in package.json
+  'import/no-extraneous-dependencies': error
+
+  # Disallow mutable exports
+  'import/no-mutable-exports': error
+
+  # Disallow other module systems
+  'import/no-amd': error
+  # 'import/no-commonjs': error # already covered via @typescript-eslint/no-var-requires
+
+  # Code style
+  'import/first': error
+  'import/newline-after-import': error
+  'import/no-duplicates': error
+  'import/order':
+    - error
+    - groups:
+        - [builtin, internal, external]
+        - parent
+        - [index, sibling]
+      'newlines-between': always
+      alphabetize:
+        order: asc
+
+overrides:
+  - files: ['**/*.ts']
+    plugins:
+      - '@typescript-eslint'
+    parser: '@typescript-eslint/parser'
+    parserOptions:
+      ecmaVersion: 12
+      sourceType: module
+    extends:
+      - 'plugin:@typescript-eslint/recommended'
+      - 'plugin:import/typescript'
+    rules:
+      '@typescript-eslint/no-non-null-assertion': 'off'
+      '@typescript-eslint/ban-types':
+        - error
+        - types:
+            object: false

.github/workflows/ci-workflow.yml

@@ -0,0 +1,80 @@
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+name: 'CI'
+jobs:
+  code-style:
+    name: 'Code Style'
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 14.x
+
+      - name: Install
+        shell: bash
+        env:
+          YARN_ENABLE_NETWORK: 0
+        run: |
+          yarn install --immutable --immutable-cache
+
+      - name: 'Check for formatting errors (fix w/ "yarn prettier --write path/to/file")'
+        run: |
+          yarn prettier --check .
+        shell: bash
+
+      - name: 'Check for linting errors (fix w/ "yarn lint -c fix")'
+        run: |
+          yarn sn lint
+        shell: bash
+
+  build-unit:
+    name: Build
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 14.x
+
+      - name: Build
+        shell: bash
+        run: |
+          yarn sn build
+
+  integration:
+    name: 'Run ${{matrix.runner}} on node.js ${{matrix.node}}.x on ${{matrix.os}}'
+    runs-on: ${{matrix.os}}
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ubuntu-latest
+          - macos-latest
+          - windows-latest
+        node:
+          - 12
+          - 14
+          - 15
+        runner:
+          - test
+          - jest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: 'Use Node.js ${{matrix.node}}.x'
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{matrix.node}}.x
+
+      - name: 'Run tests'
+        shell: bash
+        run: |
+          yarn sn ${{matrix.runner}} integration

.prettierignore

@@ -1,4 +1,4 @@
 .yarn
 .pnp.js
 
-/packages/*/lib
+/packages/*/dist

.vscode/cspell.json

@@ -7,7 +7,9 @@
     "destructure",
     "destructured",
     "devkit",
+    "eslintignore",
     "gotink",
+    "nrwl",
     "parens",
     "prefs",
     "pwdebug",

.yarn/cache/@babel-code-frame-npm-7.12.11-1a9a1b277f-033d3fb3bf.zip

@@ -0,0 +1,4 @@
+declined:
+  - "@ngx-playwright/harness"
+  - "@ngx-playwright/jest"
+  - "@ngx-playwright/test"

.yarn/cache/@eslint-eslintrc-npm-0.4.3-ee1bbcab87-fa916db689.zip

@@ -9,6 +9,7 @@
  */
 
 import {ComponentHarness, TestElement, TestKey} from '@angular/cdk/testing';
+
 import {
   SubComponentHarness,
   SubComponentSpecialHarness,

.yarn/cache/@humanwhocodes-config-array-npm-0.5.0-5ded120470-71e3c1fef4.zip

@@ -1,4 +1,5 @@
 /* spell-checker: disable */
+/* eslint-disable */
 
 /**
  * @license

.yarn/cache/@humanwhocodes-object-schema-npm-1.2.0-6bc0ff9fda-ef533ee0d2.zip

@@ -1,8 +1,10 @@
 /* spell-checker: disable */
 import {parallel} from '@angular/cdk/testing';
-import {crossEnvironmentSpecs} from './cross-environment-specs';
+
 import {MainComponentHarness} from '../harnesses/app-component-harness';
 
+import {crossEnvironmentSpecs} from './cross-environment-specs';
+
 describe('PlaywrightHarnessEnvironment', () => {
   async function getUrl(path: string) {
     await page.goto(`${baseUrl}${path}`);

.yarn/cache/@nrwl-devkit-npm-12.8.0-37f679970b-8d25f97b31.zip

@@ -1,4 +1,5 @@
 /* spell-checker: disable */
+
 /**
  * @license
  * Copyright Google LLC All Rights Reserved.

.yarn/cache/@nrwl-linter-npm-12.8.0-8c1ea5d6e0-4160d556d8.zip

@@ -96,7 +96,7 @@ test.describe('PlaywrightHarnessEnvironment', () => {
       expect(await asyncCounter.text()).toBe('8');
     });
 
-    const manualTest = test.extend<{}>({
+    const manualTest = test.extend<unknown>({
       enableAutomaticStabilization: false,
     });
 

.yarn/cache/@nrwl-tao-npm-12.8.0-eb1abe4623-2f69cdad60.zip

@@ -11,6 +11,7 @@
     "test": "sn test"
   },
   "devDependencies": {
+    "@nrwl/linter": "^12.8.0",
     "@snuggery/node": "0.2.1",
     "@snuggery/snuggery": "0.4.0",
     "@snuggery/yarn": "0.2.0",
@@ -36,5 +37,12 @@
   },
   "resolutions": {
     "@angular-devkit/architect": "0.1200.0"
+  },
+  "dependencies": {
+    "@typescript-eslint/eslint-plugin": "^4.29.3",
+    "@typescript-eslint/parser": "^4.29.3",
+    "eslint": "^7.32.0",
+    "eslint-import-resolver-node": "^0.3.6",
+    "eslint-plugin-import": "^2.24.2"
   }
 }

.yarn/cache/@types-json-schema-npm-7.0.7-95fb8178d7-b9d2c509fa.zip

@@ -89,14 +89,14 @@ export function getStyleProperty(
 /**
  * Returns whether the angular app is bootstrapped
  */
-export function isAngularBootstrapped() {
+export function isAngularBootstrapped(): boolean {
   return typeof frameworkStabilizers !== 'undefined';
 }
 
 /**
  * Waits until the angular app is stable
  */
-export async function waitUntilAngularStable() {
+export async function waitUntilAngularStable(): Promise<void> {
   if (typeof frameworkStabilizers !== 'undefined') {
     await Promise.all(frameworkStabilizers.map(fn => new Promise(fn)));
   }

.yarn/cache/@types-json-schema-npm-7.0.9-361918cff3-3252f0faa7.zip

@@ -3,6 +3,7 @@ import {
   stopHandlingAutoChangeDetectionStatus,
 } from '@angular/cdk/testing';
 import type {Page} from 'playwright-core';
+
 import {waitUntilAngularStable} from './browser';
 
 let isRegistered = false;
@@ -14,7 +15,7 @@ let disabledCount = 0;
  * This takes into account whether automatic stabilization is turned on (see
  * {@link isAutoStabilizing}) and whether batch-mode is currently enabled.
  */
-export function shouldStabilizeAutomatically() {
+export function shouldStabilizeAutomatically(): boolean {
   return isRegistered && disabledCount === 0;
 }
 

.yarn/cache/@types-json5-npm-0.0.29-f63a7916bd-66e9ac0143.zip

@@ -185,7 +185,7 @@ export class PlaywrightElement implements TestElement {
     relativeY: number,
     modifierKeys?: ModifierKeys,
   ): Promise<void>;
-  click(...args: ClickParameters) {
+  click(...args: ClickParameters): Promise<void> {
     return this.#perform(async handle =>
       handle.click(await this.#toClickOptions(...args)),
     );
@@ -214,6 +214,8 @@ export class PlaywrightElement implements TestElement {
     // placed on the event directly rather than on the `details` property
 
     return this.#perform(handle =>
+      // Cast to `any` needed because of infinite type instantiation
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
       handle.evaluate(dispatchEvent, [name, data] as [string, any]),
     );
   }
@@ -268,10 +270,11 @@ export class PlaywrightElement implements TestElement {
   ): Promise<void>;
   sendKeys(
     ...keys: (string | TestKey)[] | [ModifierKeys, ...(string | TestKey)[]]
-  ) {
+  ): Promise<void> {
     let modifiers: string | undefined;
     if (hasModifiers(keys)) {
       let modifiersObject: ModifierKeys;
+      // eslint-disable-next-line prefer-const
       [modifiersObject, ...keys] = keys;
 
       modifiers = getModifiers(modifiersObject).join('+');
@@ -335,6 +338,8 @@ export class PlaywrightElement implements TestElement {
     return this.#query(handle => handle.evaluate(getBoundingClientRect));
   }
 
+  // Any required by interface
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   async getProperty(name: string): Promise<any> {
     const property = await this.#query(handle => handle.getProperty(name));
 

.yarn/cache/@typescript-eslint-eslint-plugin-npm-4.29.3-0fc8c5cc76-0cba667c61.zip

@@ -1,8 +1,8 @@
 import {HarnessEnvironment, TestElement} from '@angular/cdk/testing';
 import type {ElementHandle, Page} from 'playwright-core';
+
 import {isAngularBootstrapped, waitUntilAngularStable} from './browser';
 import {shouldStabilizeAutomatically} from './change-detection';
-
 import {PlaywrightElement} from './element';
 import {LazyRootHandle} from './lazy-handle';
 
@@ -87,7 +87,7 @@ export class PlaywrightHarnessEnvironmentImplementation extends PlaywrightHarnes
     return this.#opts.respectShadowBoundaries;
   }
 
-  async waitForAngularReady() {
+  async waitForAngularReady(): Promise<void> {
     try {
       await this.#page.waitForFunction(isAngularBootstrapped);
     } catch {
@@ -99,15 +99,17 @@ export class PlaywrightHarnessEnvironmentImplementation extends PlaywrightHarnes
     await this.forceStabilize();
   }
 
-  async forceStabilize() {
+  async forceStabilize(): Promise<void> {
     await this.#page.evaluate(waitUntilAngularStable);
   }
 
-  async waitForTasksOutsideAngular() {
+  async waitForTasksOutsideAngular(): Promise<void> {
     // TODO: how?, see also: https://github.com/angular/components/issues/17412
   }
 
-  getPlaywrightHandle(element: TestElement) {
+  getPlaywrightHandle(
+    element: TestElement,
+  ): ElementHandle<HTMLElement | SVGElement> {
     const handle = elementHandles.get(element);
 
     if (handle == null) {

.yarn/cache/@typescript-eslint-experimental-utils-npm-4.29.3-d3ad02b19d-b1bc3bf187.zip

@@ -1,3 +1,6 @@
+/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
 import type {ElementHandle, Frame, JSHandle, Page} from 'playwright-core';
 import type {
   PageFunctionOn,

.yarn/cache/@typescript-eslint-parser-npm-4.29.3-9c7f013c4a-6da96adf1a.zip

@@ -43,6 +43,9 @@ function toSortedObject(value: unknown): unknown {
   return Object.fromEntries(
     Object.keys(value)
       .sort()
-      .map(key => [key, toSortedObject((value as any)[key])]),
+      .map(key => [
+        key,
+        toSortedObject((value as {[key in typeof key]: unknown})[key]),
+      ]),
   );
 }

.yarn/cache/@typescript-eslint-scope-manager-npm-4.29.3-b0d60df3e8-04079e4525.zip

@@ -1,3 +1,5 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
+
 import {
   BrowserType,
   chromium,
@@ -7,6 +9,7 @@ import {
   webkit,
   WebKitBrowser,
 } from 'playwright-core';
+
 import type {BrowserSpec, RunnerBrowserSpec} from './types';
 
 const getBrowserTypeByType = {

.yarn/cache/@typescript-eslint-types-npm-4.29.3-ff84fe710d-4359dd6121.zip

@@ -1,4 +1,5 @@
 import type {Browser, BrowserServer, BrowserType} from 'playwright-core';
+
 import {
   BrowserLauncher,
   BrowserSpec,
@@ -42,13 +43,13 @@ export class LaunchLauncher implements BrowserLauncher {
     };
   }
 
-  async setup() {
+  async setup(): Promise<void> {
     if (this.#browser == null) {
       this.#browser = await this.#browserType.launchServer(this.#options);
     }
   }
 
-  async teardown() {
+  async teardown(): Promise<void> {
     await this.#browser?.close();
   }
 }