feat: add types for Nuxt options (#164)

lib/module.js

@@ -2,6 +2,7 @@ const glob = require('glob-all')
 const consola = require('consola')
 const logger = consola.withScope('nuxt-style-resources')
 
+/** @type {import('@nuxt/types').Module<import('../types').Options>} */
 export default function nuxtStyledResources(moduleOptions) {
   const resolver = (this.nuxt.resolver || this.nuxt)
 

package.json

@@ -27,11 +27,13 @@
     "commitlint": "commitlint -e $GIT_PARAMS",
     "coverage": "codecov"
   },
+  "types": "types/index.d.ts",
   "eslintIgnore": [
     "lib/templates/*.*"
   ],
   "files": [
-    "lib"
+    "lib",
+    "types"
   ],
   "keywords": [
     "nuxtjs",
@@ -64,7 +66,9 @@
   "devDependencies": {
     "@commitlint/cli": "^7.5.0",
     "@commitlint/config-conventional": "^7.5.0",
+    "@nuxt/types": "^2.15.6",
     "@nuxtjs/eslint-config": "^0.0.1",
+    "@types/jest": "^26.0.23",
     "babel-eslint": "^10.0.1",
     "codecov": "^3.1.0",
     "eslint": "^5.13.0",
@@ -87,7 +91,8 @@
     "sass-loader": "^7.1.0",
     "standard-version": "^4.4.0",
     "stylus": "^0.54.5",
-    "stylus-loader": "^3.0.2"
+    "stylus-loader": "^3.0.2",
+    "typescript": "^4.3.2"
   },
   "husky": {
     "hooks": {

test/fixture/less/nuxt.config.js

@@ -1,6 +1,7 @@
 const { resolve } = require('path')
 
-module.exports = {
+/** @type {import('@nuxt/types').NuxtConfig} */
+const config = {
   rootDir: resolve(__dirname, '../../../'),
   srcDir: resolve(__dirname),
   css: ['~assets/a.less'],
@@ -20,3 +21,5 @@ module.exports = {
     }
   }
 }
+
+module.exports = config

test/fixture/sass/nuxt.config.js

@@ -1,6 +1,7 @@
 const { resolve } = require('path')
 
-module.exports = {
+/** @type {import('@nuxt/types').NuxtConfig} */
+const config = {
   rootDir: resolve(__dirname, '../../../'),
   srcDir: resolve(__dirname),
   css: ['@/assets/a.scss', '@/assets/a.sass'],
@@ -22,3 +23,5 @@ module.exports = {
     }
   }
 }
+
+module.exports = config

test/fixture/stylus/nuxt.config.js

@@ -1,6 +1,7 @@
 const { resolve } = require('path')
 
-module.exports = {
+/** @type {import('@nuxt/types').NuxtConfig} */
+const config = {
   rootDir: resolve(__dirname, '../../../'),
   srcDir: resolve(__dirname),
   css: ['~assets/a.styl'],
@@ -20,3 +21,5 @@ module.exports = {
     }
   }
 }
+
+module.exports = config

tsconfig.json

@@ -0,0 +1,30 @@
+{
+  "compilerOptions": {
+    "baseUrl": ".",
+    "noEmit": true,
+    "target": "esnext",
+    "module": "esnext",
+    "moduleResolution": "node",
+    "lib": [
+      "esnext",
+      "esnext.asynciterable",
+      "dom",
+    ],
+    "esModuleInterop": true,
+    "allowJs": true,
+    // "checkJs": true,
+    "strict": true,
+    "paths": {
+      "~/*": [
+        "./*",
+      ],
+      "@/*": [
+        "./*",
+      ],
+    },
+    "resolveJsonModule": true,
+    "types": [
+      "@nuxt/types",
+    ],
+  },
+}

types/index.d.ts

@@ -0,0 +1,15 @@
+import '@nuxt/types'
+
+interface Options  {
+  sass?: string[] | string
+  scss?: string[] | string
+  less?: string[] | string
+  stylus?: string[] | string
+  hoistUseStatements?: boolean
+}
+
+declare module '@nuxt/types' {
+  interface NuxtConfig {
+    styleResources?: Options
+  }
+}