✨ improve: typings & tests (#2395)

- typings: enable strict mode for `@roots/bud-cache`
- typings: enable strict mode for `@roots/bud-compiler`

## Type of change

**PATCH: backwards compatible change**

Author: kellymears

config/eslint.config.cjs

@@ -28,7 +28,13 @@ module.exports = {
   ],
   overrides: [
     {
-      files: [`tests/**/*`, `**/*.spec.ts`, `**/*.test.ts`],
+      files: [
+        `**/tests/**`,
+        `**/*.test.ts`,
+        `**/*.test.tsx`,
+        `**/*.test.cts`,
+        `**/*.test.mts`,
+      ],
       rules: {
         [`n/no-extraneous-import`]: OFF,
         [`n/no-unpublished-import`]: OFF,

config/vitest/alias.ts

@@ -12,8 +12,10 @@ export default {
   ...packages.reduce((aliases, packageRoot) => {
     const signifier = relative(path(), packageRoot)
     aliases[signifier] = join(packageRoot, `src`)
+    aliases[join(signifier, `*`)] = join(packageRoot, `src`, `*`)
     return aliases
   }, {}),
+  '@roots/bud-cache': path(`sources/@roots/bud-cache/src`),
   '@roots/filesystem/src/vendor/sdk': path(
     `sources/@roots/filesystem/vendor/sdk`,
   ),

sources/@roots/blade-loader/src/asset-loader.cts

@@ -1,7 +1,7 @@
-import {join} from 'node:path'
-
 import type {LoaderDefinitionFunction} from 'webpack'
 
+import {join} from 'node:path'
+
 const loader: LoaderDefinitionFunction<{publicPath?: string}> =
   async function (source: string) {
     const options = this.getOptions()

sources/@roots/blade-loader/src/loaders/index.cts

@@ -8,8 +8,8 @@ import * as vue from './vue.cjs'
 
 export const repository = {
   css: {...css, loader: require.resolve(`./css.cjs`)},
-  scss: {...scss, loader: require.resolve(`./scss.cjs`)},
   js: {...js, loader: require.resolve(`./js.cjs`)},
+  scss: {...scss, loader: require.resolve(`./scss.cjs`)},
   ts: {...ts, loader: require.resolve(`./ts.cjs`)},
   vue: {...vue, loader: require.resolve(`./vue.cjs`)},
 }

sources/@roots/blade-loader/src/plugin.ts

@@ -16,7 +16,7 @@ export default class BladeWebpackPlugin implements WebpackPluginInstance {
   }
 
   /**
-   * Apply plugin
+   * {@link WebpackPluginInstance.apply}
    */
   public async apply(compiler: Compiler) {
     const use = [`@roots/blade-loader/asset-loader`]

sources/@roots/bud-cache/package.json

@@ -49,22 +49,8 @@
   ],
   "type": "module",
   "exports": {
-    ".": {
-      "import": "./lib/index.js",
-      "default": "./lib/index.js"
-    },
-    "./service": {
-      "import": "./lib/service.js",
-      "default": "./lib/service.js"
-    },
-    "./invalidate-cache": {
-      "import": "./lib/invalidate-cache/index.js",
-      "default": "./lib/invalidate-cache/index.js"
-    },
-    "./types": {
-      "import": "./lib/types.js",
-      "default": "./lib/types.js"
-    }
+    ".": "./lib/index.js",
+    "./service": "./lib/service.js"
   },
   "typesVersions": {
     "*": {
@@ -73,9 +59,6 @@
       ],
       "service": [
         "./lib/service.d.ts"
-      ],
-      "types": [
-        "./lib/types.d.ts"
       ]
     }
   },

sources/@roots/bud-cache/src/index.ts

@@ -8,4 +8,4 @@
  * @see {@link https://github.com/roots/bud}
  */
 
-export {default} from './service/index.js'
+export {default} from '@roots/bud-cache/service'

…es/@roots/bud-cache/src/service/index.ts sources/@roots/bud-cache/src/service.tssources/@roots/bud-cache/src/service/index.ts renamed to sources/@roots/bud-cache/src/service.ts sources/@roots/bud-cache/src/service/index.ts renamed to sources/@roots/bud-cache/src/service.ts

@@ -9,16 +9,16 @@ import {bind} from '@roots/bud-support/decorators/bind'
 import isString from '@roots/bud-support/lodash/isString'
 
 /**
- * Cache service class
+ * {@link Bud.cache}
  */
 export default class Cache extends Service implements BudCache {
   /**
    * {@link BudCache.enabled}
    */
-  public enabled: boolean
+  public declare enabled: boolean
 
   /**
-   * {@link Extension.boot}
+   * {@link Service.boot}
    */
   public override async boot?(bud: Bud) {
     if (bud.context.force === true) {

sources/@roots/bud-cache/test/service.test.ts

@@ -1,9 +1,74 @@
-import {describe, expect, it} from 'vitest'
-
-import Service from '../src/index.js'
+import {Bud, factory} from '@repo/test-kit'
+import Cache from '@roots/bud-cache/service'
+import {Service} from '@roots/bud-framework/service'
+import {beforeEach, describe, expect, it} from 'vitest'
 
 describe(`@roots/bud-cache`, () => {
-  it(`should be constructable`, () => {
-    expect(Service).toBeInstanceOf(Function)
+  let bud: Bud
+  let cache: Cache
+
+  beforeEach(async () => {
+    bud = await factory({cache: true})
+    cache = new Cache(() => bud)
+  })
+
+  it(`should be a Service`, async () => {
+    expect(cache).toBeInstanceOf(Service)
+  })
+
+  it(`should have a boot method`, async () => {
+    expect(cache.boot).toBeDefined()
+    expect(cache.boot).toBeInstanceOf(Function)
+  })
+
+  it(`should have a register method`, async () => {
+    expect(cache.register).toBeDefined()
+    expect(cache.register).toBeInstanceOf(Function)
+  })
+
+
+  it(`should have a buildDependencies accessor interface`, async () => {
+    expect(cache.buildDependencies).toBeDefined()
+    expect(cache.buildDependencies).toBeInstanceOf(Object)
+  })
+
+  it(`should have a cacheDirectory accessor interface`, async () => {
+    await cache.register?.(bud)
+    await cache.boot?.(bud)
+    expect(cache.cacheDirectory).toBeDefined()
+    expect(cache.cacheDirectory).toMatch(/@tests\/project\/cache$/)
+  })
+
+  it(`should have a configuration getter`, async () => {
+    await cache.register?.(bud)
+    await cache.boot?.(bud)
+    expect(cache.configuration).toBeDefined()
+    expect(cache.configuration).toMatchInlineSnapshot(`
+      {
+        "allowCollectingMemory": true,
+        "buildDependencies": {
+          "bud": [
+            "${bud.path()}/package.json",
+            "${bud.path()}/config/bud.config.js",
+          ],
+          "tailwind": [
+            "${bud.path()}/config/tailwind.config.js",
+          ],
+        },
+        "cacheDirectory": "${bud.context.paths?.[`os-cache`]}/@tests/project/cache",
+        "compression": "brotli",
+        "hashAlgorithm": "xxhash64",
+        "idleTimeout": 100,
+        "idleTimeoutForInitialStore": 0,
+        "managedPaths": [
+          "${bud.context.paths?.[`os-cache`]}/@tests/project/cache",
+          "${bud.path()}/node_modules",
+        ],
+        "name": "production",
+        "profile": false,
+        "store": "pack",
+        "type": "filesystem",
+      }
+    `)
   })
 })

sources/@roots/bud-cache/tsconfig.json

@@ -3,10 +3,9 @@
   "compilerOptions": {
     "rootDir": "src",
     "outDir": "lib",
-
+    "strict": true,
   },
   "include": ["src"],
-  "exclude": ["node_modules", "lib", "**/*.test.ts"],
   "references": [
     {"path": "./../bud-framework/tsconfig.json"},
     {"path": "./../bud-support/tsconfig.json"}