Shared configs tests (#125)

* add coverage badge

* update release script

* update readme

* use shared biome config in template

* fix cache error.

* Update README.md

Co-authored-by: Copilot <[email protected]>

* Update README.md

Co-authored-by: Copilot <[email protected]>

* remove redundant workflow.

* update readme

* update workflow

* better conditional handling

* add getPackagePath helper

* remove extra log

* add run to all.

* let vitest handle logging

* add tree walk to coverage

* update test confis

* correct JSONPath

* initial test config setup

* fix tree walking for multiple dirs

* disable workspace warning

* lint

* add packages/apps support

* sort cases

* slice args

* slice args

* loop on test all

* add plugins to coverage

* add more default sources

* add subtotals

* add exports for tests

* udate deps

* expand file inclusions

* plugin.loader tests

* revert loader to cjs

---------

Co-authored-by: Copilot <[email protected]>

Author: thedannywahl

.github/copilot-instructions.md

@@ -0,0 +1,9 @@
+# Project Overview
+
+## Technologies Used
+
+This project is a monorepo with shared configs exported from the root package.json. It is built using modern technologies and follows best practices for accessibility, performance, and maintainability. The workspace root package (`@instructure.ai/shared-configs`) provides orchestration for the monorepo and handles creating packages.  Each package in ./packages or ./apps and ./ (root package) should be treated in isolation. The project is set up with [Vite](https://vite.dev/guide/) for fast development and build times, [Biome](https://biomejs.dev/guides/getting-started/) for code quality and formatting, and [Vitest](https://vitest.dev/guide/) for testing. Do not try to install alternative versions of packages such as es-lint, prettier, or jest. Use the tools provided by the shared-configs package.
+
+## Coding Standards
+
+You should use the provided script and utilities from the root package to build your application. Prefer vite-node over node, shell/bash or other libraries. ESM is the preferred module type and cjs is not necessary. Follow the coding standards and best practices outlined in the documentation to ensure consistency and maintainability. Prefer functional components and hooks over class components. Use TypeScript for type safety and improved developer experience. Prefer built-ins over recommending new dependencies. Ensure your code is well-documented and includes comments where necessary. Always write tests.

.template/shared/.gitignore

@@ -1,4 +1,3 @@
-# Logs
 logs
 *.log
 npm-debug.log*
@@ -10,7 +9,9 @@ lerna-debug.log*
 node_modules
 dist-ssr
 dist
-coverage  
+pub
+coverage/*
+!coverage.yml
 *.local
 
 .idea

.template/shared/tests/package.t.ts

@@ -0,0 +1,9 @@
+import { describe, it, expect } from 'vitest';
+import { name as workspaceName } from "../../../package.json" with { type: "json" };
+import { name } from "../package.json" with { type: "json" };
+
+describe('package.json', () => {
+  it('Package name should start with workspace prefix', () => {
+    expect(workspaceName.split('/')[0]).toBe(name.split('/')[0]);
+  });
+});

.template/shared/tests/package.test.ts

@@ -1,6 +1,10 @@
-import baseConfig from "@instructure.ai/shared-configs/vitest";
 import { mergeConfig } from "vitest/config";
+import { fileURLToPath } from "node:url";
+import path from "node:path";
+import baseConfig from "@instructure.ai/shared-configs/vitest";
 
-export default mergeConfig(baseConfig, {
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
+export default mergeConfig(baseConfig, {
+  root: __dirname,
 });

.template/shared/vitest.config.mts

@@ -6,5 +6,6 @@
     "source.action.useSortedKeys.biome": "explicit",
     "source.action.useSortedProperties.biome": "explicit"
   },
-  "typescript.experimental.useTsgo": true
+  "typescript.experimental.useTsgo": true,
+  "vitest.disableWorkspaceWarning": true
 }

.vscode/settings.json

@@ -7,7 +7,7 @@ Configs and dev dependencies are shared from the root package `@instructure.ai/s
 
 ## @instructure.ai/shared-configs
 
-![Version](https://img.shields.io/github/package-json/version/instructure/instructure.ai?labelColor=%230E1721&color=%234279B6) ![NPM Builds](https://img.shields.io/github/actions/workflow/status/instructure/instructure.ai/release-package.yml?logo=npm&logoColor=%23CB3837&label=package%20builds&labelColor=%230E1721) ![Web Builds](https://img.shields.io/github/actions/workflow/status/instructure/instructure.ai/deploy-apps.yml?logo=javascript&logoColor=%23F7DF1E&label=web%20builds&labelColor=%230E1721) ![Code Coverage](https://img.shields.io/badge/dynamic/yaml?url=https%3A%2F%2Fraw.githubusercontent.com%2Finstructure%2Finstructure.ai%2Frefs%2Fheads%2Fmain%2Fcoverage%2Fcoverage.yml&query=coverage.total&logo=vitest&logoColor=%236E9F18&label=coverage&labelColor=%230E1721&color=%234279B6)
+![Version](https://img.shields.io/github/package-json/version/instructure/instructure.ai?labelColor=%230E1721&color=%234279B6) ![NPM Builds](https://img.shields.io/github/actions/workflow/status/instructure/instructure.ai/release-package.yml?logo=npm&logoColor=%23CB3837&label=package%20builds&labelColor=%230E1721) ![Web Builds](https://img.shields.io/github/actions/workflow/status/instructure/instructure.ai/deploy-apps.yml?logo=javascript&logoColor=%23F7DF1E&label=web%20builds&labelColor=%230E1721) ![Code Coverage](https://img.shields.io/badge/dynamic/yaml?url=https%3A%2F%2Fraw.githubusercontent.com%2Finstructure%2Finstructure.ai%2Frefs%2Fheads%2Fmain%2Fcoverage%2Fcoverage.yml&query=coverage.totals.total&logo=vitest&logoColor=%236E9F18&label=coverage&labelColor=%230E1721&color=%234279B6)
 
 `@instructure.ai/shared-configs` is the root package of this monorepo and provides package templates, workspace utilities, and base configurations.
 

README.md

@@ -1,7 +1,9 @@
 import { describe, it, expect } from 'vitest';
+import { name as workspaceName } from "../../../package.json" with { type: "json" };
+import { name } from "../package.json" with { type: "json" };
 
-describe('Package exists', () => {
-  it('should return true', () => {
-    expect(true).toBe(true);
+describe('package.json', () => {
+  it('Package name should start with workspace prefix', () => {
+    expect(workspaceName.split('/')[0]).toBe(name.split('/')[0]);
   });
 });

apps/nutritionfacts/tests/package.test.ts

@@ -1,6 +1,16 @@
-import baseConfig from "@instructure.ai/shared-configs/vitest";
 import { mergeConfig } from "vitest/config";
+import { fileURLToPath } from "node:url";
+import path from "node:path";
+import baseConfig from "@instructure.ai/shared-configs/vitest";
+
+const __dir = path.dirname(fileURLToPath(import.meta.url));
+const __cdir = path.resolve(__dir, "coverage");
 
-export default mergeConfig(baseConfig,{
-  
-});
+export default mergeConfig(baseConfig, {
+  root: __dirname,
+  test: {
+    coverage: {
+      reportsDirectory: __cdir,
+    }
+  }
+});

apps/nutritionfacts/vitest.config.mts

@@ -1,7 +1,9 @@
 import { describe, it, expect } from 'vitest';
+import { name as workspaceName } from "../../../package.json" with { type: "json" };
+import { name } from "../package.json" with { type: "json" };
 
-describe('Package exists', () => {
-  it('should return true', () => {
-    expect(true).toBe(true);
+describe('package.json', () => {
+  it('Package name should start with workspace prefix', () => {
+    expect(workspaceName.split('/')[0]).toBe(name.split('/')[0]);
   });
 });