{"_id":"@djgould/cypress-ai","_rev":"1-54d5dee855a971d6311e1820a750bc9f","name":"@djgould/cypress-ai","dist-tags":{"latest":"0.2.0"},"versions":{"0.1.0":{"name":"@djgould/cypress-ai","version":"0.1.0","description":"Asks AI to help guide you on cypress test failures","type":"module","main":"dist/index.js","types":"dist/index.d.ts","scripts":{"build":"npx rimraf dist/ && tsc","prettier":"prettier --write \"**/*\"","lint":"tsc --noEmit && tsc -p ./test/tsconfig.json && tsc -p ./cypress/tsconfig.json","test":"npm run test:ut && npm run test:e2e && npm run test:cmp","test:ut":"vitest run unit.test.ts","test:e2e":"vitest run e2e.test.ts --test-timeout 120000","test:cmp":"vitest run component.test.ts --test-timeout 120000","verify":"npm run build && npm run lint && npm run ci:prettier && npm run test","ci:prettier":"prettier --check \"**/*\""},"repository":{"type":"git","url":"git+https://github.com/djgould/cypress-ai.git"},"keywords":["cypress","testing","console","e2e","component"],"author":{"name":"nils-hoyer"},"license":"MIT","bugs":{"url":"https://github.com/djgould/cypress-ai/issues"},"homepage":"https://github.com/djgould/cypress-ai#readme","dependencies":{"chai":"^4.3.10","openai":"^4.29.2","sinon":"^17.0.0","sinon-chai":"^3.7.0","type-detect":"^4.0.8"},"devDependencies":{"@cypress/mount-utils":"^4.0.0","@types/chai":"4.3.14","@types/expect":"24.3.0","@types/mocha":"10.0.6","@types/node":"^20.11.30","@types/sinon":"17.0.3","@types/sinon-chai":"3.2.12","@types/type-detect":"4.0.3","cypress":"13.7.1","mocha":"10.3.0","prettier":"3.0.3","prettier-plugin-organize-imports":"3.2.4","rimraf":"5.0.5","typescript":"5.4.3","vite":"^5.0.0","vitest":"^1.0.0"},"directories":{"doc":"docs","test":"test"},"_id":"@djgould/cypress-ai@0.1.0","gitHead":"830dcf164a504539cac1e69245e4029f4b8f747d","_nodeVersion":"18.18.1","_npmVersion":"10.2.0","dist":{"integrity":"sha512-5ITHSdJ+KOzllCFLGb8l06tXVdOkN3FonX2Pqhi2GKJWAIfQ/bY1f2ykPP9zMUtR0UGYOPs2QE/UIYzVFsvzZQ==","shasum":"f49d1cfa228f37657c2247796109df873a0b969a","tarball":"https://registry.npmjs.org/@djgould/cypress-ai/-/cypress-ai-0.1.0.tgz","fileCount":5,"unpackedSize":13883,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBGwVgXxvPK6hriF98J1WXg0jEJhs2Gsgv2F/oa16mK0AiBtdIsuZiitFptKcPR4jbrgnHKRd0SQjbIky7roW0hxGw=="}]},"_npmUser":{"name":"djgould","email":"djgould0628@gmail.com"},"maintainers":[{"name":"djgould","email":"djgould0628@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cypress-ai_0.1.0_1711560750668_0.22376692696531708"},"_hasShrinkwrap":false},"0.2.0":{"name":"@djgould/cypress-ai","version":"0.2.0","description":"Asks AI to help guide you on cypress test failures","type":"module","main":"dist/index.js","types":"dist/index.d.ts","scripts":{"dev":"tsc --watch --preserveWatchOutput","build":"npx rimraf dist/ && tsc","prettier":"prettier --write \"**/*\"","lint":"tsc --noEmit && tsc -p ./test/tsconfig.json && tsc -p ./cypress/tsconfig.json","test":"npm run test:ut && npm run test:e2e && npm run test:cmp","test:ut":"vitest run unit.test.ts","test:e2e":"vitest run e2e.test.ts --test-timeout 120000","test:cmp":"vitest run component.test.ts --test-timeout 120000","verify":"npm run build && npm run lint && npm run ci:prettier && npm run test","ci:prettier":"prettier --check \"**/*\""},"repository":{"type":"git","url":"git+https://github.com/djgould/cypress-ai.git"},"keywords":["cypress","testing","console","e2e","component"],"author":{"name":"nils-hoyer"},"license":"MIT","bugs":{"url":"https://github.com/djgould/cypress-ai/issues"},"homepage":"https://github.com/djgould/cypress-ai#readme","dependencies":{"chai":"^4.3.10","cyclope":"^2.7.1","openai":"^4.29.2","sinon":"^17.0.0","sinon-chai":"^3.7.0","type-detect":"^4.0.8"},"devDependencies":{"@cypress/mount-utils":"^4.0.0","@types/chai":"4.3.14","@types/expect":"24.3.0","@types/mocha":"10.0.6","@types/node":"^20.11.30","@types/sinon":"17.0.3","@types/sinon-chai":"3.2.12","@types/type-detect":"4.0.3","cypress":"13.7.1","mocha":"10.3.0","prettier":"3.0.3","prettier-plugin-organize-imports":"3.2.4","rimraf":"5.0.5","typescript":"^5.4.3","vite":"^5.0.0","vitest":"^1.0.0"},"directories":{"doc":"docs","test":"test"},"_id":"@djgould/cypress-ai@0.2.0","gitHead":"a680817897195896ed96ecf597ad92ef26d8e2c1","_nodeVersion":"18.18.1","_npmVersion":"10.2.0","dist":{"integrity":"sha512-k5ffFN0rpRBkF3GS9Np2BoDEU2r6qsmmtigKQrHhzjRntCoROds2Dojiq++9NssLN8CnZNFW6CnrVXcWW0wXag==","shasum":"4e6129b3448556fccb8a2ef3c83011605904c105","tarball":"https://registry.npmjs.org/@djgould/cypress-ai/-/cypress-ai-0.2.0.tgz","fileCount":5,"unpackedSize":10764,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCdrjd96Qd0vhKcSPXzjqYPlii3S/rBYxgra5rjRBjteQIgcwX7WMl5Fu/VDw4rtQl8g6yS4AFlWdexTD3f0zlkh8E="}]},"_npmUser":{"name":"djgould","email":"djgould0628@gmail.com"},"maintainers":[{"name":"djgould","email":"djgould0628@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cypress-ai_0.2.0_1712078394904_0.12348884654168102"},"_hasShrinkwrap":false}},"time":{"created":"2024-03-27T17:32:30.540Z","0.1.0":"2024-03-27T17:32:30.819Z","modified":"2024-04-02T17:19:55.242Z","0.2.0":"2024-04-02T17:19:55.075Z"},"maintainers":[{"name":"djgould","email":"djgould0628@gmail.com"}],"description":"Asks AI to help guide you on cypress test failures","homepage":"https://github.com/djgould/cypress-ai#readme","keywords":["cypress","testing","console","e2e","component"],"repository":{"type":"git","url":"git+https://github.com/djgould/cypress-ai.git"},"author":{"name":"nils-hoyer"},"bugs":{"url":"https://github.com/djgould/cypress-ai/issues"},"license":"MIT","readme":"# THIS IS CURRENTLY AN EXPERIMENTAL PROJECT. YOU WILL PROBABLY GET ERRORS\n\n# cypress-ai\n\nThis Plugin leverages OpenAI to help give tips to debugging cypress tests when they fail.\n\n### Installation\n\n```\nnpm install @djgould/cypress-ai --save-dev\n```\n\n### Usage\n\n`cypress.config.ts`\n\n```js\nimport { defineConfig } from 'cypress'\nimport { cypressAI } from '@djgould/cypress-ai'\n\nexport default defineConfig({\n  e2e: {\n    setupNodeEvents(on, config) {\n      cypressAI(on, config, { apiKey: 'open ai api key' })\n    }\n  }\n})\n```\n\n*Include failed html in request to open ai*\n1. Configure Cyclope to save page after failure [here](https://github.com/bahmutov/cyclope/tree/main?tab=readme-ov-file#save-the-failed-page)\n2. Add `includeFailedHtml: true` to options:\n```\n  cypressAI(on, config, { apiKey: 'open ai api key', includeFailedHtml: true })\n```\n\n### Output\n\n![image](https://github.com/djgould/cypress-ai/assets/6018174/c273a926-12ed-488c-ad31-d6e6df49350a)\n\n\n\n\n### Contributing\n1. Create an project issue with proper description and expected behaviour\n2. NPM command `npm run verify` have to pass locally\n3. Provide a PR with implementation and tests \n","readmeFilename":"README.md"}