{"_id":"@brokenice/vite-build-notifier","name":"@brokenice/vite-build-notifier","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@brokenice/vite-build-notifier","version":"1.0.0","repository":{"type":"git","url":"git+https://github.com/brokenicedev/vite-build-notifier.git"},"author":{"name":"Becchetti Luca","email":"luca.becchetti@brokenice.it"},"license":"Apache 2.0","type":"module","exports":{".":{"import":"./dist/index.mjs","require":"./dist/index.cjs"}},"main":"./dist/index.cjs","module":"./dist/index.mjs","types":"./dist/index.d.ts","scripts":{"dev":"unbuild --stub","build":"unbuild && copyfiles -u 1 src/icons/**/* dist","prepublishOnly":"npm run build"},"keywords":["vite","vite-plugin","notifier"],"dependencies":{"serve-static":"^1.14.1"},"peerDependencies":{"node-notifier":"^10.0.1"},"devDependencies":{"@tsconfig/node12":"^1.0.7","@types/node":"^14.14.31","@types/node-notifier":"^8.0.3","@types/serve-static":"^1.13.9","copyfiles":"^2.4.1","node-notifier":"^10.0.1","typescript":"^4.2.2","unbuild":"^1.2.1","vite":"^4.4.6"},"gitHead":"a797c6f0a3a71a169287d88e18d668c4a0405a77","description":"A [Vite](https://vitejs.dev/) plugin that uses the [node-notifier](https://github.com/mikaelbr/node-notifier) package to display OS-level notifications for Webpack build events.","bugs":{"url":"https://github.com/brokenicedev/vite-build-notifier/issues"},"homepage":"https://github.com/brokenicedev/vite-build-notifier#readme","_id":"@brokenice/vite-build-notifier@1.0.0","_nodeVersion":"18.0.0","_npmVersion":"9.6.3","dist":{"integrity":"sha512-s0beaB2jIi1YB5TOumE7+W777PmQ6RFOBEjFfbHaGPfrIIldxoHyGRp1ns77Sv9OUZXRVwgNZXFaHS9AIo6C0g==","shasum":"ae8f95eef9d8dbdd5289b42e1ccee2bf53129d9b","tarball":"https://registry.npmjs.org/@brokenice/vite-build-notifier/-/vite-build-notifier-1.0.0.tgz","fileCount":10,"unpackedSize":94651,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCgrt2aIf+rG+boJmsQa07W3zLheexCnNdcHSmb3t/OOgIgMGi8B2lxfZ+yWtFiHL/RTOVbFIIgwNAR7W898DkXX1A="}]},"_npmUser":{"name":"brokenice","email":"info@brokenice.it"},"directories":{},"maintainers":[{"name":"brokenice","email":"info@brokenice.it"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/vite-build-notifier_1.0.0_1695982039867_0.2007588639004021"},"_hasShrinkwrap":false}},"time":{"created":"2023-09-29T10:07:19.791Z","1.0.0":"2023-09-29T10:07:20.236Z","modified":"2023-09-29T10:07:20.493Z"},"maintainers":[{"name":"brokenice","email":"info@brokenice.it"}],"description":"A [Vite](https://vitejs.dev/) plugin that uses the [node-notifier](https://github.com/mikaelbr/node-notifier) package to display OS-level notifications for Webpack build events.","homepage":"https://github.com/brokenicedev/vite-build-notifier#readme","keywords":["vite","vite-plugin","notifier"],"repository":{"type":"git","url":"git+https://github.com/brokenicedev/vite-build-notifier.git"},"author":{"name":"Becchetti Luca","email":"luca.becchetti@brokenice.it"},"bugs":{"url":"https://github.com/brokenicedev/vite-build-notifier/issues"},"license":"Apache 2.0","readme":"# Vite Build Notifier\n\nA [Vite](https://vitejs.dev/) plugin that uses the [node-notifier](https://github.com/mikaelbr/node-notifier) package to display OS-level notifications for Webpack build events.\n\n**vite-build-notifier** can generate notifications for compilation errors, as well as notify you when the compilation process is triggered and completes successfully.\n\n[![Build Status](https://travis-ci.com/RoccoC/webpack-build-notifier.svg?branch=master)](https://travis-ci.com/RoccoC/webpack-build-notifier)\n\n## Install\n\n```shell\nnpm i --save-dev @brokenice/vite-build-notifier\n```\n\n## Usage\nadd blow codes to `vite.config.js`\n\n```js\nimport ViteBuildNotifierPlugin from \"@brokenice/vite-build-notifier\"\nexport default defineConfig({\n  plugins: [ViteBuildNotifierPlugin()]\n});\n```\n\n##Options\n\n```js\nimport ViteBuildNotifierPlugin from \"@brokenice/vite-build-notifier\"\nexport default defineConfig({\n  plugins: [ViteBuildNotifierPlugin(\n      options, // exe. {title: 'test', message: 'new message'}\n      suppressOnStart,\n      suppressSound,\n      onStart,\n      onEnd\n  )]\n});\n```\n\nConfig Options\n--------------\n\n#### options\nYou can refer to node-notifier options \n\n#### onStart\nA function which is invoked when compilation starts. Optional. The function has no paramters.\n\n#### onEnd\nA function which is invoked when compilation completes. Optional. The function is passed one parameter:\n* {Error} containing compilation error\n\n#### suppressOnStart\nDisable notifications when a new compile process starts.\n\n#### suppressSound\nSuppress sounds\n\n\nTodo\n--------------\n\n- Add support for warnings ","readmeFilename":"README.md"}