refact: Update ReadMe, add env vars and change module namespace

Author: gaelreyrol

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,21 @@
+# The MIT License (MIT)
+
+Copyright (c) Dans Ma Culotte <contact@dansmaculotte.fr>
+
+> Permission is hereby granted, free of charge, to any person obtaining a copy
+> of this software and associated documentation files (the "Software"), to deal
+> in the Software without restriction, including without limitation the rights
+> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+> copies of the Software, and to permit persons to whom the Software is
+> furnished to do so, subject to the following conditions:
+>
+> The above copyright notice and this permission notice shall be included in
+> all copies or substantial portions of the Software.
+>
+> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+> THE SOFTWARE.

.github/ISSUE_TEMPLATE/testing.md

@@ -1,75 +1,77 @@
-# nuxt-segment-analytics
+# nuxt-segment
 
 [![David-DM][david-dm-src]][david-dm-href]
 [![Standard JS][standard-js-src]][standard-js-href]
-[![Circle CI][circle-ci-src]][circle-ci-href]
-[![Codecov][codecov-src]][codecov-href]
 [![npm version][npm-version-src]][npm-version-href]
 [![npm downloads][npm-downloads-src]][npm-downloads-href]
 
-> NuxtJS module for Stripe.js
-
-[📖 **Release Notes**](./CHANGELOG.md)
+> NuxtJS module for Segment Analytics
 
 This module uses [vue-segment-analytics](https://github.com/Kapiche/vue-segment-analytics) to add Segment Analytics to a Nuxt.js app.
-You can make called with this.$analytics.track()
+You can make called with `this.$segment.track()`.
 
 ## Setup
 
-- Add `nuxt-segment-analytics` dependency using yarn or npm to your project
-- Add `nuxt-segment-analytics` to `modules` section of `nuxt.config.js`
+- Add `nuxt-segment` dependency using yarn or npm to your project
+- Add `nuxt-segment` to `modules` section of `nuxt.config.js`
 
 ## Usage
 ### nuxt.config.js
 ```js
 {
   modules: [
-    // Simple usage
-    'nuxt-segment-analytics',
+    'nuxt-segment'
+  ],
 
-    // With options
-    ['nuxt-segment-analytics', { id: "SEGMENT_KEY", useRouter: true }],
- ]
+  segment: {
+    sourceId: '',
+    useRouter: true
+  }
 }
 ```
 
+## Options
+
+### sourceId
+
+- Type: `String`
+  - Default: `process.env.SEGMENT_SOURCE_ID || ''`
+
+### useRouter
+
+- Type: `Boolean`
+  - Default: `process.env.SEGMENT_USE_ROUTER || true`
+
 ### YourComponent.vue
 ```js
 export default {
   mounted () {
-    this.$analytics.identify('f4ca124298', {
+    this.$segment.identify('f4ca124298', {
       name: 'Michael Bolton',
       email: 'mbolton@initech.com'
-    })
-    this.$analytics.track('Signed Up', { plan: 'Enterprise' })
-    this.$analytics.page('Pricing');
+    });
+    this.$segment.track('Signed Up', { plan: 'Enterprise' });
+    this.$segment.page('Pricing');
   }
 }
 ```
 
-
 ## Development
 
 - Clone this repository
-- Install dependencies using `yarn install` or `npm install`
+- Install dependencies using `yarn install`
 - Start development server using `npm run dev`
 
 ## License
 
-[MIT License](./LICENSE)
-
-Copyright (c) Dylan Wight <dylan@otechie.com>
+[MIT License](./LICENSE.md)
 
 <!-- Badges -->
-[david-dm-src]: https://david-dm.org/https://github.com/dgwight/nuxt-segment-analytics/status.svg?style=flat-square
-[david-dm-href]: https://david-dm.org/https://github.com/dgwight/nuxt-segment-analytics
+[david-dm-src]: https://david-dm.org/dansmaculotte/nuxt-segment/status.svg?style=flat-square
+[david-dm-href]: https://david-dm.org/dansmaculotte/nuxt-segment
 [standard-js-src]: https://img.shields.io/badge/code_style-standard-brightgreen.svg?style=flat-square
 [standard-js-href]: https://standardjs.com
-[circle-ci-src]: https://img.shields.io/circleci/project/github/https://github.com/dgwight/nuxt-segment-analytics.svg?style=flat-square
-[circle-ci-href]: https://circleci.com/gh/https://github.com/dgwight/nuxt-segment-analytics
-[codecov-src]: https://img.shields.io/codecov/c/github/https://github.com/dgwight/nuxt-segment-analytics.svg?style=flat-square
-[codecov-href]: https://codecov.io/gh/https://github.com/dgwight/nuxt-segment-analytics
-[npm-version-src]: https://img.shields.io/npm/dt/nuxt-segment-analytics.svg?style=flat-square
-[npm-version-href]: https://npmjs.com/package/nuxt-segment-analytics
-[npm-downloads-src]: https://img.shields.io/npm/v/nuxt-segment-analytics/latest.svg?style=flat-square
-[npm-downloads-href]: https://npmjs.com/package/nuxt-segment-analytics
+[npm-version-src]: https://img.shields.io/npm/dt/nuxt-segment.svg?style=flat-square
+[npm-version-href]: https://npmjs.com/package/nuxt-segment
+[npm-downloads-src]: https://img.shields.io/npm/v/nuxt-segment/latest.svg?style=flat-square
+[npm-downloads-href]: https://npmjs.com/package/nuxt-segment

CHANGELOG.md

@@ -1,13 +1,21 @@
 const { resolve } = require('path')
 
 export default function (moduleOptions) {
-  const options = Object.assign({ id: '', useRouter: true }, this.options.analytics, moduleOptions)
-  this.addPlugin({
+  const options = Object.assign(
+    {
+      sourceId: process.env.SEGMENT_SOURCE_ID || '',
+      useRouter: process.env.SEGMENT_USE_ROUTER || true
+    },
+    this.options.segment,
+    moduleOptions
+  )
+
+  const pluginOpts = {
     src: resolve(__dirname, 'plugin.js'),
-    fileName: 'module.js',
+    fileName: 'segment/plugin.js',
     ssr: false,
-    options: options
-  })
-}
+    options
+  }
 
-module.exports.meta = require('../package.json')
+  this.addPlugin(pluginOpts)
+}

LICENSE

@@ -1,12 +1,20 @@
 import Vue from 'vue'
 import VueSegmentAnalytics from 'vue-segment-analytics'
 
-export default function (context) {
-  const options = <%= JSON.stringify(options) %>
-  const router = options.useRouter && context.app ? context.app.router : undefined
-  Vue.use(VueSegmentAnalytics, {
-    id: options.id,
-    router: router
-  })
-  Vue.prototype.$analytics = window.analytics
+const SEGMENT_SOURCE_ID = '<%= options.sourceId %>'
+const SEGMENT_USE_ROUTER = <%= options.useRouter %>
+
+export default function ({ app }) {
+
+  const options = {
+    id: SEGMENT_SOURCE_ID
+  }
+
+  if (SEGMENT_USE_ROUTER) {
+    options.router = app.router;
+  }
+
+  Vue.use(VueSegmentAnalytics, options)
+
+  Vue.prototype.$segment = window.analytics
 }

LICENSE.md

@@ -1,20 +1,25 @@
 {
-  "name": "nuxt-segment-analytics",
-  "version": "0.0.1",
+  "name": "nuxt-segment",
+  "version": "0.0.0",
   "description": "NuxtJS module for Segment Analytics.js",
   "license": "MIT",
   "contributors": [
     {
-      "name": "Dylan Wight <dylan@otechie.com>"
+      "name": "Dylan Wight",
+      "email": "dylan@otechie.com"
+    },
+    {
+      "name": "Gaël Reyrol",
+      "email": "gael@dansmaculotte.fr"
     }
   ],
   "main": "lib/module.js",
-  "repository": "https://github.com/https://github.com/dgwight/nuxt-segment-analytics",
+  "repository": "https://github.com/dansmaculotte/nuxt-segment",
   "publishConfig": {
     "access": "public"
   },
   "scripts": {
-    "dev": "nuxt example",
+    "dev": "nuxt test/fixture",
     "lint": "eslint lib test",
     "test": "yarn run lint && jest",
     "release": "standard-version && git push --follow-tags && npm publish"
@@ -33,20 +38,20 @@
     "vue-segment-analytics": "^0.3.1"
   },
   "devDependencies": {
-    "babel-eslint": "latest",
-    "codecov": "latest",
+    "babel-eslint": "^10.0.1",
+    "codecov": "^3.3.0",
     "dotenv": "^6.1.0",
-    "eslint": "latest",
-    "eslint-config-standard": "latest",
-    "eslint-plugin-import": "latest",
-    "eslint-plugin-jest": "latest",
-    "eslint-plugin-node": "latest",
-    "eslint-plugin-promise": "latest",
-    "eslint-plugin-standard": "latest",
-    "eslint-plugin-vue": "latest",
-    "jest": "latest",
-    "jsdom": "latest",
-    "nuxt-edge": "latest",
-    "standard-version": "latest"
+    "eslint": "^5.16.0",
+    "eslint-config-standard": "^12.0.0",
+    "eslint-plugin-import": "^2.16.0",
+    "eslint-plugin-jest": "^22.4.1",
+    "eslint-plugin-node": "^8.0.1",
+    "eslint-plugin-promise": "^4.1.1",
+    "eslint-plugin-standard": "^4.0.0",
+    "eslint-plugin-vue": "^5.2.2",
+    "jest": "^24.7.1",
+    "jsdom": "^14.0.0",
+    "nuxt-edge": "^2.6.0-25905610.75e8a893",
+    "standard-version": "^5.0.2"
   }
 }

README.md

@@ -2,17 +2,11 @@ require('dotenv').config()
 const { resolve } = require('path')
 
 module.exports = {
-  rootDir: resolve(__dirname, '..'),
+  rootDir: resolve(__dirname, '../..'),
   buildDIr: resolve(__dirname, '.nuxt'),
   srcDir: __dirname,
   render: {
     resourceHints: false
   },
-  modules: [
-    '@@'
-  ],
-  analytics: {
-    id: process.env.SEGMENT_KEY,
-    useRouter: false
-  }
+  modules: ['@@']
 }

lib/module.js

@@ -1,18 +1,18 @@
 <template>
   <div>
-    Test
+    Works!
   </div>
 </template>
 
 <script>
   export default {
     mounted () {
-      this.$analytics.identify('f4ca124298', {
+      this.$segment.identify('f4ca124298', {
         name: 'Michael Bolton',
         email: 'mbolton@initech.com'
       })
-      this.$analytics.track('Signed Up', { plan: 'Enterprise' })
-      this.$analytics.page()
+      this.$segment.track('Signed Up', { plan: 'Enterprise' })
+      this.$segment.page()
     }
   }
 </script>

lib/plugin.js

@@ -1,7 +1,7 @@
 const { Nuxt, Builder } = require('nuxt-edge')
 const request = require('request-promise-native')
 
-const config = require('../example/nuxt.config')
+const config = require('./fixture/nuxt.config')
 
 const url = path => `http://localhost:3000${path}`
 const get = path => request(url(path))
@@ -10,7 +10,6 @@ describe('basic', () => {
   let nuxt
 
   beforeAll(async () => {
-    config.dev = false
     nuxt = new Nuxt(config)
     await new Builder(nuxt).build()
     await nuxt.listen(3000)
@@ -22,6 +21,6 @@ describe('basic', () => {
 
   test('render', async () => {
     let html = await get('/')
-    expect(html).toContain('Test')
+    expect(html).toContain('Works!')
   })
 })