add support for shebangs, update readme

This commit adds support for #!/usr/ shebangs at the top of files,
and will instead add the copyright header below the shebang if it exists

Additionally, this commit updates the readme files to better reflect
the current functionality of the --fix flag and lint mode

Author: Cdok

copyright/README.md

@@ -32,13 +32,13 @@ npm run copyright:lint
 
 This will add copyright headers to _all_ `.js` files in the `src` directory in the root of your project.
 
-## Lint Mode
+## Fix Mode
 
-Passing the `--fix` flag to this tool will disable lint mode.
+Passing the `--fix` flag to this tool will enable fix mode.
 
-With lint mode enabled, the process will exit if any of the target directories contain files which do not have copyright headers.
+With fix mode enabled, the copyright headers will be added to each file that matches the glob and does not contain the headers.
 
-In fix mode, the tool will add the copyright headers to any targetted files.
+Without this flag, the tool is run in lint mode, which will exit the process if any of the target files do not contain the header.
 
 ### Developing
 

copyright/copyright.js

@@ -21,10 +21,16 @@ let langs = {}
 let lintMode = true
 let error = false
 
+// we don't want to pass node and copyright.js directories to the glob
 const args = process.argv.filter((arg) => {
     return !/node|copyright/.test(arg)
 })
 
+/**
+ * getHeaderText - retrieve appropriate header file context from langs{} object
+ * @param  {String} ext file extension of desired header file
+ * @return {String}     content of appropriate header file
+ */
 const getHeaderText = (ext) => {
     if (!langs[ext]) {
         console.log(`${red}${blackBG}ERROR${defaultBG} - ${ext} is not supported (yet)`)
@@ -34,6 +40,11 @@ const getHeaderText = (ext) => {
     }
 }
 
+/**
+ * buildSupportedExtensions - initializes the langs{} object with the supported
+ * extensions, as well as their respective (c) header content
+ * @return {undefined} - populates the langs{} object
+ */
 const buildSupportedExtensions = () => {
     const headerDir = path.join(__dirname, './headers')
     fs
@@ -46,6 +57,7 @@ const buildSupportedExtensions = () => {
         })
 }
 
+
 if (args.length === 0 || args.indexOf('--help') >= 0) {
 
     console.log(`
@@ -76,9 +88,10 @@ buildSupportedExtensions()
 
 args
     .map((folder) => glob.sync(folder))
-    .reduce((a, b) => a.concat(b))
+    .reduce((a, b) => a.concat(b)) // flatten array of arrays
     .forEach((file) => {
-        const content = fs.readFileSync(file)
+        let content = fs.readFileSync(file)
+
         const hasCopyrightHeader = content.includes('Copyright (c)')
         const ext = file.match(/\.[0-9a-z]+$/i)[0]
 
@@ -87,7 +100,20 @@ args
                 console.log(`${yellow}${file} ${red}missing copyright header`)
                 error = true
             } else {
-                const newData = getHeaderText(ext) + content
+                const contentStr = content.toString().split('\n')
+                let shebang = ''
+                let newData = ''
+
+                // accomodate for shebang and insert before header
+                if (contentStr[0].indexOf('#!') >= 0) {
+                    shebang = contentStr.shift()
+                    content = contentStr.join('\n')
+
+                    newData = shebang + '\n\n' + getHeaderText(ext) + '\n' + content
+                } else {
+                    newData = getHeaderText(ext) + '\n' + content
+                }
+
                 fs.writeFileSync(file, newData)
                 console.log(`${green}Copyright header succesfully written into ${magenta}${file}`)
             }