feat: typescript rewrite (#74)

Author: ricardogobbosouza

.eslintrc

@@ -0,0 +1,5 @@
+{
+  "extends": [
+    "@nuxtjs/eslint-config-typescript"
+  ]
+}

.eslintrc.js

@@ -3,10 +3,10 @@ name: ci
 on:
   push:
     branches:
-      - master
+      - main
   pull_request:
     branches:
-      - master
+      - main
 
 jobs:
   ci:
@@ -16,15 +16,15 @@ jobs:
       matrix:
         # os: [ubuntu-latest, macos-latest, windows-latest]
         os: [ubuntu-latest]
-        node: [10, 12, 14, 15]
+        node: [12]
 
     steps:
       - uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node }}
 
       - name: checkout
-        uses: actions/checkout@master
+        uses: actions/checkout@v3
 
       - name: cache node_modules
         uses: actions/cache@v3

.github/workflows/ci.yml

@@ -7,3 +7,5 @@ node_modules
 .DS_Store
 coverage
 dist
+sw.*
+.env

.gitignore

@@ -1,5 +1,4 @@
 module.exports = {
-  collectCoverage: true,
-  collectCoverageFrom: ['lib/**/*.js'],
-  testEnvironment: 'node'
+  preset: '@nuxt/test-utils',
+  collectCoverageFrom: ['src/**']
 }

commitlint.config.js

@@ -7,29 +7,35 @@
   "contributors": [
     "Ricardo Gobbo de Souza <ricardogobbosouza@yahoo.com.br>"
   ],
-  "main": "lib/module.js",
+  "main": "./dist/module.js",
+  "types": "./dist/module.d.ts",
   "files": [
-    "lib"
+    "dist"
   ],
   "scripts": {
-    "dev": "nuxt test/fixture",
-    "lint": "eslint --ext .js,.vue .",
-    "release": "yarn test && standard-version && git push --follow-tags && npm publish",
-    "test": "yarn lint && jest"
+    "build": "siroc build",
+    "prepublishOnly": "yarn build",
+    "dev": "nuxt dev test/fixture/basic",
+    "lint": "eslint --ext .js,.ts,.vue .",
+    "release": "yarn test && yarn build && standard-version && git push --follow-tags && npm publish",
+    "test": "yarn lint && yarn jest"
   },
   "dependencies": {
     "consola": "^2.15.3",
+    "defu": "^6.0.0",
     "eslint-webpack-plugin": "^2.6.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "latest",
-    "@commitlint/config-conventional": "latest",
-    "@nuxtjs/eslint-config": "latest",
-    "@nuxtjs/module-test-utils": "latest",
+    "@babel/preset-typescript": "latest",
+    "@nuxt/test-utils": "latest",
+    "@nuxt/types": "latest",
+    "@nuxtjs/eslint-config-typescript": "latest",
+    "@types/jest": "latest",
+    "@types/node": "latest",
     "eslint": "latest",
-    "husky": "latest",
     "jest": "latest",
-    "nuxt-edge": "latest",
+    "nuxt": "latest",
+    "siroc": "latest",
     "standard-version": "latest"
   },
   "peerDependencies": {

husky.config.js

@@ -0,0 +1,65 @@
+import { resolve } from 'path'
+import consola from 'consola'
+import { defu } from 'defu'
+import type { Module } from '@nuxt/types'
+import type { Options } from 'eslint-webpack-plugin'
+import { name, version } from '../package.json'
+import { moduleExists } from './utils'
+
+const logger = consola.withTag('nuxt:eslint')
+
+export interface ModuleOptions extends Partial<Options>{}
+
+const CONFIG_KEY = 'eslint'
+
+const nuxtModule: Module<ModuleOptions> = function (moduleOptions) {
+  const DEFAULTS: ModuleOptions = {
+    context: this.options.srcDir,
+    eslintPath: 'eslint',
+    extensions: ['js', 'ts', 'vue'],
+    cache: true,
+    lintDirtyModulesOnly: true
+  }
+
+  const options: ModuleOptions = defu(
+    this.options[CONFIG_KEY],
+    moduleOptions,
+    DEFAULTS
+  )
+
+  if (!moduleExists(options.eslintPath)) {
+    logger.warn(
+      `The dependency \`${options.eslintPath}\` not found.`,
+      'Please run `yarn add eslint --dev` or `npm install eslint --save-dev`'
+    )
+    return
+  }
+
+  const filesToWatch = [
+    '.eslintrc',
+    '.eslintrc.json',
+    '.eslintrc.yaml',
+    '.eslintrc.yml',
+    '.eslintrc.js'
+  ]
+
+  this.options.watch = this.options.watch || []
+  this.options.watch.push(...filesToWatch.map(file => resolve(this.options.rootDir, file)))
+
+  this.extendBuild((config, { isDev, isClient }) => {
+    if (isDev && isClient) {
+      const EslintPlugin = require('eslint-webpack-plugin')
+
+      config.plugins.push(new EslintPlugin(options))
+    }
+  })
+}
+
+;(nuxtModule as any).meta = { name, version }
+
+declare module '@nuxt/types' {
+  interface NuxtConfig { [CONFIG_KEY]?: ModuleOptions } // Nuxt 2.14+
+  interface Configuration { [CONFIG_KEY]?: ModuleOptions } // Nuxt 2.9 - 2.13
+}
+
+export default nuxtModule

jest.config.js

@@ -0,0 +1,7 @@
+export function moduleExists (name) {
+  try {
+    return require.resolve(name)
+  } catch (e) {
+    return false
+  }
+}

lib/logger.js

@@ -0,0 +1,16 @@
+import { setupTest, get } from '@nuxt/test-utils'
+
+describe('dev', () => {
+  setupTest({
+    fixture: 'fixture',
+    server: true,
+    config: {
+      dev: true
+    }
+  })
+
+  test('render', async () => {
+    const { body } = await get('/')
+    expect(body).toContain('Works!')
+  })
+})

lib/module.js

@@ -1,6 +1,6 @@
-module.exports = {
+export default {
   rootDir: __dirname,
-  buildModules: [
-    { handler: require('../../') }
+  modules: [
+    '../../src/module.ts'
   ]
 }

lib/utils.js

@@ -6,6 +6,6 @@
 
 <script>
 export default {
-
+  name: 'PageIndex'
 }
 </script>

package.json

@@ -0,0 +1,16 @@
+import { setupTest, get } from '@nuxt/test-utils'
+
+describe('prod', () => {
+  setupTest({
+    fixture: 'fixture',
+    server: true,
+    config: {
+      dev: false
+    }
+  })
+
+  test('render', async () => {
+    const { body } = await get('/')
+    expect(body).toContain('Works!')
+  })
+})

src/module.ts

@@ -0,0 +1,33 @@
+import { setupTest } from '@nuxt/test-utils'
+
+const mockReporter = {
+  warn: jest.fn()
+}
+
+jest.mock('consola', () => ({
+  info: jest.fn(),
+  success: jest.fn(),
+  debug: jest.fn(),
+  warn: jest.fn(),
+  withTag: jest.fn().mockImplementation(() => mockReporter)
+}))
+
+describe('warn', () => {
+  setupTest({
+    fixture: 'fixture',
+    server: true,
+    config: {
+      dev: true,
+      eslint: {
+        eslintPath: 'foo'
+      }
+    }
+  })
+
+  test('should warn if not found the `eslint` dependency', () => {
+    expect(mockReporter.warn).toHaveBeenCalledWith(
+      'The dependency `foo` not found.',
+      'Please run `yarn add eslint --dev` or `npm install eslint --save-dev`'
+    )
+  })
+})

src/utils.ts

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "module": "ESNext",
+    "moduleResolution": "Node",
+    "resolveJsonModule": true,
+    "strict": false,
+    "types": [
+      "node",
+      "jest"
+    ]
+  },
+  "exclude": [
+    "node_modules",
+    "dist"
+  ]
+}