Merge pull request #287 from rajasegar/disable-telemetry

Author: Robert Jackson

.travis.yml

@@ -9,6 +9,7 @@ script:
   - yarn lint
   - yarn test
   - yarn test:integration
+  - yarn test:notelemetry
 
 after_success:
 - yarn coveralls

README.md

@@ -28,7 +28,18 @@ running this tool.
 
 ```sh
 $ cd my-ember-app-or-addon
-$ npx ember-angle-brackets-codemod http://localhost:4200 ./path/of/files/ or ./some**/*glob.hbs
+$ npx ember-angle-brackets-codemod --telemetry=http://localhost:4200 ./path/of/files/ or ./some**/*glob.hbs
+```
+
+Telemetry helpers runs the app, grabs basic info about all of the modules at runtime. This allows the codemod to know the names of every helper, component, route, controller, etc. in the app without guessing / relying on static analysis. They basically help you to create "runtime assisted codemods".
+
+See "Gathering runtime data" section of [ember-native-class-codemod](https://github.com/ember-codemods/ember-native-class-codemod#gathering-runtime-data) for some additonal information.
+
+### Running the codemod without Telemetry
+
+```sh
+$ cd my-ember-app-or-addon
+$ npx ember-angle-brackets-codemod ./path/of/files/ or ./some**/*glob.hbs
 ```
 
 ## From

bin/cli.js

@@ -2,8 +2,18 @@
 'use strict';
 const { gatherTelemetryForUrl, analyzeEmberObject } = require('ember-codemods-telemetry-helpers');
 
+const argv = require('yargs')
+  .usage('Usage: $0 --telemetry=http://localhost:4200 [path or glob]')
+  .alias('t', 'telemetry')
+  .nargs('t', 1)
+  .describe('t', 'Address of the development server')
+  .help('h')
+  .alias('h', 'help').argv;
+
 (async () => {
-  await gatherTelemetryForUrl(process.argv[2], analyzeEmberObject);
+  if (argv.telemetry) {
+    await gatherTelemetryForUrl(argv.telemetry, analyzeEmberObject);
+  }
 
   require('codemod-cli').runTransform(
     __dirname,

package.json

@@ -26,6 +26,7 @@
     "lint": "eslint . --cache",
     "release": "release-it",
     "test:integration": "node ./test/run-test.js",
+    "test:notelemetry": " node ./test/run-test-without-telemetry.js",
     "test": "codemod-cli test --coverage"
   },
   "jest": {

test/fixtures/without-telemetry/input/.editorconfig

@@ -0,0 +1,20 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+
+[*]
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+
+[*.hbs]
+insert_final_newline = false
+
+[*.{diff,md}]
+trim_trailing_whitespace = false

test/fixtures/without-telemetry/input/.ember-cli

@@ -0,0 +1,9 @@
+{
+  /**
+    Ember CLI sends analytics information by default. The data is completely
+    anonymous, but there are times when you might want to disable this behavior.
+
+    Setting `disableAnalytics` to true will prevent any data from being sent.
+  */
+  "disableAnalytics": false
+}

test/fixtures/without-telemetry/input/.eslintignore

@@ -0,0 +1,16 @@
+# unconventional js
+/blueprints/*/files/
+/vendor/
+
+# compiled output
+/dist/
+/tmp/
+
+# dependencies
+/bower_components/
+
+# misc
+/coverage/
+
+# ember-try
+/.node_modules.ember-try/

test/fixtures/without-telemetry/input/.eslintrc.js

@@ -0,0 +1,39 @@
+module.exports = {
+  root: true,
+  parserOptions: {
+    ecmaVersion: 2017,
+    sourceType: 'module'
+  },
+  plugins: [
+    'ember'
+  ],
+  extends: [
+    'eslint:recommended',
+    'plugin:ember/recommended'
+  ],
+  env: {
+    browser: true
+  },
+  rules: {
+  },
+  overrides: [
+    // node files
+    {
+      files: [
+        'ember-cli-build.js',
+        'testem.js',
+        'blueprints/*/index.js',
+        'config/**/*.js',
+        'lib/*/index.js'
+      ],
+      parserOptions: {
+        sourceType: 'script',
+        ecmaVersion: 2015
+      },
+      env: {
+        browser: false,
+        node: true
+      }
+    }
+  ]
+};

test/fixtures/without-telemetry/input/.gitignore

@@ -0,0 +1,23 @@
+# See https://help.github.com/ignore-files/ for more about ignoring files.
+
+# compiled output
+/dist/
+/tmp/
+
+# dependencies
+/bower_components/
+/node_modules/
+
+# misc
+/.sass-cache
+/connect.lock
+/coverage/
+/libpeerconnection.log
+/npm-debug.log*
+/testem.log
+/yarn-error.log
+
+# ember-try
+/.node_modules.ember-try/
+/bower.json.ember-try
+/package.json.ember-try

test/fixtures/without-telemetry/input/.travis.yml

@@ -0,0 +1,26 @@
+---
+language: node_js
+node_js:
+  - "6"
+
+sudo: false
+dist: trusty
+
+addons:
+  chrome: stable
+
+cache:
+  directories:
+    - $HOME/.npm
+
+env:
+  global:
+    # See https://git.io/vdao3 for details.
+    - JOBS=1
+
+before_install:
+  - npm config set spin false
+
+script:
+  - npm run lint:js
+  - npm test