vitest-preview - npm Package Compare versions

Comparing version 0.0.1-alpha.4 to 0.0.1

package.json

 {
   "name": "vitest-preview",
-  "version": "0.0.1-alpha.4",
-  "description": "",
+  "version": "0.0.1",
+  "description": "Visual Debugging Experience for Vitest 🧪🖼⚡️",
   "type": "module",
@@ -15,3 +15,19 @@ "main": "dist/index.js",
   },
-  "keywords": [],
+  "keywords": [
+    "testing",
+    "vitest",
+    "frontend",
+    "productivity",
+    "debug",
+    "preview vitest",
+    "vitest browser"
+  ],
+  "homepage": "https://www.vitest-preview.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nvh95/vitest-preview.git"
+  },
+  "bug": {
+    "url": "https://github.com/nvh95/viest-preview/issues"
+  },
   "author": {
@@ -18,0 +34,0 @@ "name": "Hung Viet Nguyen",

README.md

@@ -1,2 +0,5 @@
-<!-- TODO: Write a GitHub Actions to sync with root readme -->
+<p align="center">
+ <img align="center" alt="Vitest Preview Logo" src="https://user-images.githubusercontent.com/8603085/197406675-dbe5b555-3a71-4c6d-9547-776c18052881.svg" width="120"/>
+</p>
+
 <h1 align="center">
@@ -7,6 +10,8 @@ Vitest Preview
 <p align="center">
-Debug your Vitest tests. Effortlessly. 🛠🖼
+Debug your Vitest tests. Effortlessly. 🧪🖼⚡️
 </p>
 
-<!-- TODO: Add GIF -->
+<p align="center">
+  <img align="center" src="https://user-images.githubusercontent.com/8603085/197373376-f6a3fe33-487b-4c35-8085-8e7e6357ce40.gif" alt="Vitest Preview Demo" />
+</p>
 
@@ -48,2 +53,4 @@ <p align="center">
 
+### Process CSS
+
 You need to configure `vitest` to process CSS by:
@@ -81,2 +88,4 @@
 
+### Add script vitest-preview
+
 `vitest-preview` has a CLI that opens **Vitest Preview Dashboard** where you can preview your tests' UI. You can update your `package.json` to add a script for more convenience:
@@ -90,2 +99,11 @@
 
+### Update .gitignore
+
+Update your `.gitignore`
+
+```diff
+// .gitignore
++.vitest-preview
+```
+
 ## Usage
@@ -117,2 +135,7 @@
 
+## Examples
+
+- [react-testing-library](https://github.com/nvh95/vitest-preview/tree/main/examples/react-testing-library)
+- [@vue/test-utils](https://github.com/nvh95/vitest-preview/tree/main/examples/vue-test-utils)
+
 ## Contributing
@@ -126,4 +149,12 @@
 
+## License
+
+![This is open source software](https://user-images.githubusercontent.com/8603085/161439058-98faea42-c6e6-46f4-9ce6-218fad5f3b9a.gif)
+
+MIT
+
 ## Support
 
 If you like the project, please consider supporting it by giving a ⭐️ to encourage the author.
+
+<!-- TODO: Write a GitHub Actions to sync with root readme -->

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

9208

increased by15.91%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

155

increased by25%

Number of low supply chain risk alerts

3

decreased by-25%

No dependency changes