major: do not overwrite plugins file on every install, close #4

Author: bahmutov

README.md

@@ -14,7 +14,7 @@
 
 Which is too much hustle. With this module you just need to execute regular `npm install` command and you can write TypeScript spec files right away.
 
-**note** overwrites existing `cypress/plugins/index.js` file.
+**note** overwrites existing `cypress/plugins/index.js` file once. In other installs looks for file `cypress/plugins/cy-ts-preprocessor.js` to avoid overwriting.
 
 ## Install
 

package.json

@@ -85,17 +85,18 @@
     "mocha": "4.0.1",
     "nsp": "3.1.0",
     "pre-git": "3.16.0",
-    "prettier-standard": "7.0.3",
+    "prettier-standard": "8.0.0",
     "semantic-release": "8.2.0",
     "simple-commit-message": "3.3.2",
     "standard": "10.0.3"
   },
   "dependencies": {
-    "@cypress/webpack-preprocessor": "1.1.0",
+    "@cypress/webpack-preprocessor": "1.1.3",
     "am-i-a-dependency": "1.1.2",
     "chalk": "2.3.0",
     "debug": "3.1.0",
-    "shelljs": "0.7.8",
+    "shelljs": "0.8.0",
+    "terminal-banner": "1.1.0",
     "ts-loader": "3.2.0"
   },
   "peerDependencies": {

src/add-plugin.js

@@ -1,9 +1,10 @@
 const debug = require('debug')('add-typescript-to-cypress')
 const chalk = require('chalk')
+const terminalBanner = require('terminal-banner').terminalBanner
 const amDependency = require('am-i-a-dependency')()
+
 if (amDependency) {
-  console.log('adding TypeScript plugin to Cypress')
-  console.log('current folder', process.cwd())
+  debug('current folder', process.cwd())
 
   const fs = require('fs')
   const path = require('path')
@@ -17,6 +18,18 @@ if (amDependency) {
   // node_modules/@bahmutov/add-typescript-to-cypress
   const root = path.join(process.cwd(), '..', '..', '..')
   const cypressFolder = path.join(root, 'cypress')
+  const pluginsFolder = path.join(cypressFolder, 'plugins')
+  const ourPreprocessorFilename = path.join(
+    pluginsFolder,
+    'cy-ts-preprocessor.js'
+  )
+
+  if (fs.existsSync(ourPreprocessorFilename)) {
+    debug('found existing file', ourPreprocessorFilename)
+    debug('no need to overwrite again')
+    process.exit(0)
+  }
+
   if (!fs.existsSync(cypressFolder)) {
     console.error('⚠️ Cannot find "cypress" folder in %s', chalk.yellow(root))
     console.error('Please scaffold Cypress folder by opening Cypress once')
@@ -32,10 +45,14 @@ if (amDependency) {
   }
 
   const addPluginFile = () => {
-    const plugins = path.join(cypressFolder, 'plugins')
-    const pluginsIndex = path.join(plugins, 'index.js')
+    console.log('copying plugin file')
+    const pluginsIndex = path.join(pluginsFolder, 'index.js')
     const sourcePlugin = path.join(__dirname, 'plugin.js')
     shell.cp(sourcePlugin, pluginsIndex)
+
+    console.log('copying TS preprocessor file')
+    const sourcePreprocessor = path.join(__dirname, 'cy-ts-preprocessor.js')
+    shell.cp(sourcePreprocessor, ourPreprocessorFilename)
   }
 
   const addTSConfigFile = () => {
@@ -52,6 +69,7 @@ if (amDependency) {
     }
   }
 
+  terminalBanner('adding TypeScript plugin for Cypress')
   addPluginFile()
   addTSConfigFile()
 } else {

src/cy-ts-preprocessor.js

@@ -0,0 +1,26 @@
+const wp = require('@cypress/webpack-preprocessor')
+
+const webpackOptions = {
+  resolve: {
+    extensions: ['.ts', '.js']
+  },
+  module: {
+    rules: [
+      {
+        test: /\.ts$/,
+        exclude: [/node_modules/],
+        use: [
+          {
+            loader: 'ts-loader'
+          }
+        ]
+      }
+    ]
+  }
+}
+
+const options = {
+  webpackOptions
+}
+
+module.exports = wp(options)

src/plugin.js

@@ -1,27 +1,5 @@
-const wp = require('@cypress/webpack-preprocessor')
-
-const webpackOptions = {
-  resolve: {
-    extensions: ['.ts', '.js']
-  },
-  module: {
-    rules: [
-      {
-        test: /\.ts$/,
-        exclude: [/node_modules/],
-        use: [
-          {
-            loader: 'ts-loader'
-          }
-        ]
-      }
-    ]
-  }
-}
+const cypressTypeScriptPreprocessor = require('./cy-ts-preprocessor')
 
 module.exports = on => {
-  const options = {
-    webpackOptions
-  }
-  on('file:preprocessor', wp(options))
+  on('file:preprocessor', cypressTypeScriptPreprocessor)
 }