feat: typescript rewrite (#23)

Author: ricardogobbosouza

.eslintignore

@@ -3,6 +3,3 @@ node_modules
 dist
 .nuxt
 coverage
-
-# Plugin
-lib/plugin.js

.eslintrc

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

.eslintrc.js

@@ -15,7 +15,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        node: [10, 12]
+        node: [12]
 
     steps:
       - uses: actions/setup-node@v2

.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

@@ -5,33 +5,38 @@
   "repository": "nuxt-community/netlify-files-module",
   "license": "MIT",
   "contributors": [
-    {
-      "name": "Alexander Lichter <[email protected]>"
-    }
+    "Alexander Lichter <[email protected]>",
+    "Ricardo Gobbo de Souza <[email protected]>"
   ],
-  "main": "lib/module.js",
+  "main": "./dist/module.js",
+  "types": "./dist/module.d.ts",
   "files": [
-    "lib"
+    "dist"
   ],
   "scripts": {
-    "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",
+    "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": {
     "@iarna/toml": "^2.2.5",
     "consola": "^2.15.0",
+    "defu": "^3.2.2",
     "node-html-parser": "^3.0.3"
   },
   "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"
   },
   "publishConfig": {

husky.config.js

@@ -1,53 +1,68 @@
-const { resolve } = require('path')
-const { copyFileSync, existsSync, writeFileSync } = require('fs')
-const { parse } = require('node-html-parser')
-const tomlStringify = require('@iarna/toml/stringify')
-const logger = require('./logger')
+import { resolve } from 'path'
+import { copyFileSync, existsSync, writeFileSync } from 'fs'
+import type { Module } from '@nuxt/types'
+import { parse, HTMLElement } from 'node-html-parser'
+import { stringify as tomlStringify } from '@iarna/toml'
+import consola from 'consola'
+import defu from 'defu'
+import { name, version } from '../package.json'
+
+const logger = consola.withTag('nuxt:netlify-files')
+
+export type NetlifyToml = object
+
+export interface ModuleOptions {
+  copyExistingFiles?: boolean,
+  detectForms?: boolean,
+  existingFilesDirectory?: string,
+  netlifyToml?: NetlifyToml | (() => NetlifyToml)
+}
 
+const CONFIG_KEY = 'netlifyFiles'
 const HEADERS_FILE_NAME = '_headers'
 const REDIRECTS_FILE_NAME = '_redirects'
 const TOML_FILE_NAME = 'netlify.toml'
 const FILE_NAMES = [HEADERS_FILE_NAME, REDIRECTS_FILE_NAME, TOML_FILE_NAME]
 
-module.exports = function (moduleOptions) {
-  const { srcDir } = this.options
-  const DEFAULT_OPTIONS = {
+const nuxtModule: Module<ModuleOptions> = function (moduleOptions) {
+  const DEFAULTS: ModuleOptions = {
     copyExistingFiles: true,
     detectForms: false,
-    existingFilesDirectory: srcDir,
+    existingFilesDirectory: this.options.srcDir,
     netlifyToml: undefined
   }
-  const options = {
-    ...DEFAULT_OPTIONS,
-    ...this.options['netlify-files'],
-    ...this.options.netlifyFiles,
-    ...moduleOptions
-  }
 
-  const forms = []
+  const options: ModuleOptions = defu(
+    this.options['netlify-files'],
+    this.options[CONFIG_KEY],
+    moduleOptions,
+    DEFAULTS
+  )
 
-  if (options.detectForms) {
-    const isNetlifyForm = (form) => {
-      return form.getAttribute('netlify') === '' || form.getAttribute('netlify') === 'true' ||
-      form.getAttribute('data-netlify') === '' || form.getAttribute('data-netlify') === 'true'
-    }
+  const forms: HTMLElement[] = []
 
+  if (options.detectForms) {
     this.nuxt.hook('generate:page', function ({ html }) {
-      forms.push(...parse(html).querySelectorAll('form').filter(el => isNetlifyForm(el)))
+      forms.push(...parse(html).querySelectorAll('form').filter((form) => {
+        return form.getAttribute('netlify') === '' ||
+          form.getAttribute('netlify') === 'true' ||
+          form.getAttribute('data-netlify') === '' ||
+          form.getAttribute('data-netlify') === 'true'
+      }))
     })
   }
 
-  this.nuxt.hook('generate:done', () => {
+  this.nuxt.hook('generate:done', async () => {
     // prevent netlify.toml from being copied when it has been generated programmatically
     const filesToCopy = options.netlifyToml ? FILE_NAMES.filter(file => file !== TOML_FILE_NAME) : FILE_NAMES
 
-    programmaticallyCreateToml.bind(this)(options)
+    await programmaticallyCreateToml.bind(this)(options)
     copyExistingNetlifyFiles.bind(this)(options, filesToCopy)
     generatePageWithForms.bind(this)(options, forms)
   })
 }
 
-async function programmaticallyCreateToml ({ netlifyToml }) {
+async function programmaticallyCreateToml ({ netlifyToml }: ModuleOptions) {
   if (!netlifyToml) {
     return
   }
@@ -63,7 +78,7 @@ async function programmaticallyCreateToml ({ netlifyToml }) {
   writeFileSync(destination, toml)
 }
 
-function copyExistingNetlifyFiles ({ existingFilesDirectory, copyExistingFiles }, filesToCopy) {
+function copyExistingNetlifyFiles ({ existingFilesDirectory, copyExistingFiles }: ModuleOptions, filesToCopy: string[]) {
   if (!copyExistingFiles) {
     return
   }
@@ -82,7 +97,7 @@ function copyExistingNetlifyFiles ({ existingFilesDirectory, copyExistingFiles }
   })
 }
 
-function generatePageWithForms ({ detectForms }, forms) {
+function generatePageWithForms ({ detectForms }: ModuleOptions, forms: HTMLElement[]) {
   if (!detectForms) {
     return
   }
@@ -95,4 +110,11 @@ function generatePageWithForms ({ detectForms }, forms) {
   }
 }
 
-module.exports.meta = require('../package.json')
+;(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,18 @@
+import { existsSync } from 'fs'
+import { getNuxt, setupTest } from '@nuxt/test-utils'
+import { resolvePaths } from './utils'
+
+describe('basic', () => {
+  setupTest({
+    generate: true,
+    fixture: 'fixture/basic'
+  })
+
+  test('it copies netlify files', () => {
+    const { headersPath, redirectsPath, tomlPath } = resolvePaths(getNuxt())
+
+    expect(existsSync(headersPath)).toBe(true)
+    expect(existsSync(redirectsPath)).toBe(true)
+    expect(existsSync(tomlPath)).toBe(true)
+  })
+})

lib/logger.js

@@ -0,0 +1,18 @@
+import { existsSync } from 'fs'
+import { getNuxt, setupTest } from '@nuxt/test-utils'
+import { resolvePaths } from './utils'
+
+describe('disable', () => {
+  setupTest({
+    generate: true,
+    fixture: 'fixture/disable'
+  })
+
+  test('should not copies netlify files', () => {
+    const { headersPath, redirectsPath, tomlPath } = resolvePaths(getNuxt())
+
+    expect(existsSync(headersPath)).toBe(false)
+    expect(existsSync(redirectsPath)).toBe(false)
+    expect(existsSync(tomlPath)).toBe(false)
+  })
+})

package.json

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

lib/module.js renamed to src/module.ts

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

test/basic.test.js

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

test/basic.test.ts

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

test/disable.test.js

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

test/disable.test.ts

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

test/fixture/basic/nuxt.config.js

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