@varavel/vdl-plugin-sdk 0.1.3 → 0.1.5

package/README.md

@@ -139,8 +139,8 @@ npx vdl-plugin check
 npx vdl-plugin build
 ```
 
-- `check` runs TypeScript without emitting files.
-- `build` bundles the required `src/index.ts` entry into `dist/index.js`.
+- `check` runs TypeScript without emitting files. If a `tsconfig.vitest.json` is present, it also type-checks test code.
+- `build` bundles the required `src/index.ts` entry into `dist/index.js`. Minification is enabled by default; pass `--no-minify` to disable it.
 
 Example `package.json` scripts:
 
@@ -155,14 +155,37 @@ Example `package.json` scripts:
 
 ## TypeScript Setup
 
-You can extend the shared base config exported by the SDK:
+You can extend the shared base config exported by the SDK in your `tsconfig.json` file:
 
 ```json
 {
-  "extends": "@varavel/vdl-plugin-sdk/tsconfig.base.json"
+  "extends": "@varavel/vdl-plugin-sdk/tsconfig.base.json",
+  "include": ["src/**/*.ts"],
+  "exclude": ["src/**/*.test.ts"]
 }
 ```
 
+## Testing
+
+To add tests to your plugin, install [vitest](https://vitest.dev):
+
+```bash
+npm install --save-dev vitest
+```
+
+Then create a `tsconfig.vitest.json` in the root of your project:
+
+```json
+{
+  "extends": "@varavel/vdl-plugin-sdk/tsconfig.vitest.base.json",
+  "include": ["src/**/*.test.ts", "tests/**/*.ts", "vitest.config.ts"]
+}
+```
+
+This config extends the base provided by the SDK and includes Node.js types exclusively for test files, keeping them out of your main plugin compilation.
+
+Once the file is in place, `vdl-plugin check` will automatically type-check your test code as well.
+
 ## License
 
 This project is released under the MIT License. See [LICENSE](LICENSE).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@varavel/vdl-plugin-sdk",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "SDK to build plugins for VDL using TypeScript",
   "keywords": [
     "varavel",

package/tsconfig.vitest.base.json

@@ -2,6 +2,5 @@
   "extends": "./tsconfig.base.json",
   "compilerOptions": {
     "types": ["@varavel/vdl-plugin-sdk", "node", "vitest/importMeta"]
-  },
-  "include": ["src/**/*.test.ts", "tests/**/*.ts", "vitest.config.ts"]
+  }
 }