prepare publish

Author: Oleksandr_Halichenko

.github/pull_request_template.md

@@ -0,0 +1,14 @@
+Before submitting this PR, please ensure that you have completed the following:
+
+- [ ] Updated the CHANGELOG.md.
+- [ ] Checked that there aren't other open pull requests for the same issue/update.
+- [ ] Checked that your contribution follows the project's contribution guidelines.
+- [ ] Added corresponding unit/E2E tests
+
+## Description
+
+Please describe your changes and any new features you're introducing, or issues you're fixing.
+
+### Related Issues
+
+Please link any related issues or bug reports that this PR will address.

.github/workflows/npm-publish.yml

@@ -0,0 +1,23 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
+
+name: Node.js Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  publish-npm:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: npm run build
+      - run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

.github/workflows/pull-request.yml

@@ -0,0 +1,27 @@
+name: Test
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        version: [ 18, 20 ]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.version }}
+      - run: npm ci
+      - run: npm run build
+      - run: npm run test:e2e
+      - name: junit report
+        uses: mikepenz/action-junit-report@v4
+        if: always()
+        with:
+          report_paths: './test/results.xml'
+          fail_on_failure: true

.gitignore

@@ -1,2 +1,4 @@
 node_modules/
 adapter/
+playwright-report/
+test-results/

.npmignore

@@ -1 +1,2 @@
 test/
+.github/

CHANGELOG.md

@@ -11,6 +11,4 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
 :microscope: - experimental
 
 ## [0.1.0]
-- :pencil: cleaned up dependencies
-- :rocket: added value wait and validation
-- 
+- :rocket: initial implementation

README.md

@@ -33,5 +33,38 @@ PROFILE=default
 
 ## Advanced Configuration
 ### Customizing test instance
+Custom test instance can be passed to world constructor as _test_ property. 
+And then fixtures can be connected with world instance via _init_ property.
+```typescript
+import { test as base } from '@playwright/test';
+import { SettingsPage } from './settings-page';
+import { setWorldConstructor } from '@cucumber/cucumber';
+import { PlaywrightWorld } from '@qavajs/playwright-runner-adapter/PlaywrightWorld';
+
+type MyFixtures = {
+    settingsPage: SettingsPage;
+};
+
+const customTest = base.extend<MyFixtures>({
+    settingsPage: async ({ page }, use) => {
+        await use(new SettingsPage(page));
+    },
+});
+
+class ExtendedPlaywrightWorld extends PlaywrightWorld {
+    settingsPage: SettingsPage;
+    constructor(options: any) {
+        super(options);
+    }
+    
+    test = customTest;
+    
+    // init arrow function connects fixtures with Cucumber world instance
+    init = ({ settingsPage }) => {
+        this.settingsPage = settingsPage;
+    }
+
+}
+```
 
 

index.d.ts

@@ -0,0 +1 @@
+export { PlaywrightWorld } from './src/PlaywrightWorld';

index.js

@@ -0,0 +1,4 @@
+const { PlaywrightWorld } = require('./adapter/PlaywrightWorld');
+module.exports = {
+    PlaywrightWorld
+}

package.json

@@ -2,14 +2,13 @@
   "name": "@qavajs/playwright-runner-adapter",
   "version": "0.1.0",
   "description": "adapter for playwright test runner",
-  "main": "index.js",
   "scripts": {
     "build": "tsc",
     "test:ui": "playwright test --config test/playwright.config.ts --ui",
     "test:e2e": "playwright test --config test/playwright-e2e.config.ts"
   },
   "author": "Alexandr Galichenko",
-  "license": "ISC",
+  "license": "MIT",
   "dependencies": {
     "@cucumber/gherkin": "^28.0.0",
     "@cucumber/messages": "^24.1.0",