[feat]: Stable release 1.0.0 (#65)

.changeset/brave-crabs-cheat.md

@@ -0,0 +1,10 @@
+---
+"cypress-ct-lit": major
+---
+
+Release 1.0.0 [cypress-ct-lit] Full support for lit and cypress component testing
+
+- Remove internal types to allow custom mount command
+- Update module export to disable typescript warning
+- Update docs for mount type example
+- Update docs to prevent set incorrect bundler

README.md

@@ -29,6 +29,7 @@ export default defineConfig({
   component: {
     devServer: {
       framework: 'cypress-ct-lit',
+      bundler: 'vite', // or 'webpack'
       // more config here
     }
   }
@@ -41,25 +42,25 @@ framework: 'cypress-ct-lit' as any,
 ```
 ## Adding mount Command
 
-Next, add the following lines to your `component.{js.ts}`
+Next, add the following lines to your `component.ts`
 
 ```ts
 import { mount } from 'cypress-ct-lit'
 
-Cypress.Commands.add('mount', mount)
-```
-Optionally, this package brings its custom types definitions. Add the following to `tsconfig.json` or `jsconfig.json` in your project.
-
-```json
-{
-  "compilerOptions": {
-    // more compiler options...
-    "types": [
-      "cypress",
-      "cypress-ct-lit"
-    ]
+declare global {
+  namespace Cypress {
+    interface Chainable {
+      /**
+       * Mount your template/component into Cypress sandbox
+       * @param template
+       * @param options render options for custom rendering
+       */
+      mount: typeof mount;
+    }
   }
 }
+
+Cypress.Commands.add('mount', mount)
 ```
 ## Usage notes
 
@@ -74,6 +75,13 @@ it('should display content', () => {
 
   cy.get('#content').should('contain.text', text);
 })
+
+it('should display html', () => {
+  const text = 'strings templates are also allowed'
+  cy.mount(`<div id='content'>${text}</div>`);
+
+  cy.get('#content').should('contain.text', text);
+})
 ```
 
 Or find content inside your web component
@@ -100,6 +108,7 @@ For more examples and basic usages see ´cypress/component´ examples
 >  component: {
 >    devServer: {
 >      framework: 'cypress-ct-lit',
+>      bundler: 'vite', // or 'webpack'
 >      // more config here
 >    }
 >  }