feat: Add Lariat snippets

Author: Mark Skelton

README.md

@@ -11,64 +11,95 @@
 
 The following snippets are provided by this package. If you have ideas of other snippets that would be helpful, please [open an issue](https://github.com/mskelton/vscode-playwright-test-snippets/issues/new).
 
-### `pw-describe→`
+### Test blocks
+
+#### `pw-describe`
 
 ```ts
 test.describe('$1', () => {
   $0
 })
 ```
 
-### `pw-test→`
+#### `pw-test`
 
 ```ts
 test('$1', async ({ page }) => {
   $0
 })
 ```
 
-### `pw-beforeEach→`
+#### `pw-beforeEach`
 
 ```ts
 test.beforeEach(async ({ page }) => {
   $0
 })
 ```
 
-### `pw-afterEach→`
+#### `pw-afterEach`
 
 ```ts
 test.afterEach(async ({ page }) => {
   $0
 })
 ```
 
-### `pw-beforeAll→`
+#### `pw-beforeAll`
 
 ```ts
 test.beforeAll(async ({ browser }) => {
   $0
 })
 ```
 
-### `pw-afterAll→`
+#### `pw-afterAll`
 
 ```ts
 test.afterAll(async ({ browser }) => {
   $0
 })
 ```
 
-### `pw-step→`
+#### `pw-step`
 
 ```ts
 await test.step('$1', async () => {
   $0
 })
 ```
 
-### `pw-use→`
+#### `pw-use`
 
 ```ts
 test.use({ $0 })
 ```
+
+### Lariat
+
+[Lariat](https://github.com/Widen/lariat) is a Playwright page object framework that simplifies page object construction. We've included some useful Lariat snippets as part of this extension.
+
+#### `pw-collection`
+
+```ts
+import Collection from 'lariat'
+
+export class MyPage extends Collection {
+  $0
+}
+```
+
+#### `pw-page-object`
+
+```ts
+import { Page } from '@playwright/test'
+import Collection from 'lariat'
+
+export class MyPage extends Collection {
+  constructor(page: Page) {
+    super(page.locator('$1'))
+  }
+
+  $0
+}
+```

package.json

@@ -30,11 +30,19 @@
     "snippets": [
       {
         "language": "typescript",
-        "path": "./snippets.json"
+        "path": "./snippets/base.json"
       },
       {
         "language": "javascript",
-        "path": "./snippets.json"
+        "path": "./snippets/base.json"
+      },
+      {
+        "language": "typescript",
+        "path": "./snippets/ts.json"
+      },
+      {
+        "language": "javascript",
+        "path": "./snippets/js.json"
       }
     ]
   },

snippets.json renamed to snippets/base.json

@@ -1,34 +1,44 @@
 {
-  "Playwright describe": {
+  "Playwright describe block": {
     "prefix": "pw-describe",
     "body": ["test.describe('$1', () => {", "\t$0", "})", ""]
   },
-  "Playwright test": {
+  "Playwright test block": {
     "prefix": "pw-test",
     "body": ["test('$1', async ({ ${2:page} }) => {", "\t$0", "})", ""]
   },
-  "Playwright test.use": {
+  "Playwright test.use block": {
     "prefix": "pw-use",
     "body": ["test.use({ $0 })", ""]
   },
-  "Playwright test.step": {
+  "Playwright test.step block": {
     "prefix": "pw-step",
     "body": ["await test.step('$1', async () => {", "\t$0", "})", ""]
   },
-  "Playwright beforeEach": {
+  "Playwright beforeEach block": {
     "prefix": "pw-beforeEach",
     "body": ["test.beforeEach(async ({ ${1:page} }) => {", "\t$0", "})", ""]
   },
-  "Playwright afterEach": {
+  "Playwright afterEach block": {
     "prefix": "pw-afterEach",
     "body": ["test.afterEach(async ({ ${1:page} }) => {", "\t$0", "})", ""]
   },
-  "Playwright beforeAll": {
+  "Playwright beforeAll block": {
     "prefix": "pw-beforeAll",
     "body": ["test.beforeAll(async ({ ${1:browser} }) => {", "\t$0", "})", ""]
   },
-  "Playwright afterAll": {
+  "Playwright afterAll block": {
     "prefix": "pw-afterAll",
     "body": ["test.afterAll(async ({ ${1:browser} }) => {", "\t$0", "})", ""]
+  },
+  "Lariat collection": {
+    "prefix": "pw-collection",
+    "body": [
+      "import Collection from \"lariat\"",
+      "",
+      "export class ${TM_FILENAME_BASE/(^|-)([A-z0-9])/${2:/upcase}/g} extends Collection {",
+      "  $0",
+      "}"
+    ]
   }
 }

snippets/js.json

@@ -0,0 +1,17 @@
+{
+  "Lariat page object": {
+    "prefix": "pw-page-object",
+    "description": "A top-level Lariat collection intended to be used in tests or fixtures.",
+    "body": [
+      "import Collection from \"lariat\"",
+      "",
+      "export class ${TM_FILENAME_BASE/(^|-)([A-z0-9])/${2:/upcase}/g} extends Collection {",
+      "  constructor(page) {",
+      "    super(page.locator(\"$1\"))",
+      "  }",
+      "",
+      "  $0",
+      "}"
+    ]
+  }
+}

snippets/ts.json

@@ -0,0 +1,18 @@
+{
+  "Lariat page object": {
+    "prefix": "pw-page-object",
+    "description": "A top-level Lariat collection intended to be used in tests or fixtures.",
+    "body": [
+      "import { Page } from \"@playwright/test\"",
+      "import Collection from \"lariat\"",
+      "",
+      "export class ${TM_FILENAME_BASE/(^|-)([A-z0-9])/${2:/upcase}/g} extends Collection {",
+      "  constructor(page: Page) {",
+      "    super(page.locator(\"$1\"))",
+      "  }",
+      "",
+      "  $0",
+      "}"
+    ]
+  }
+}