tether-shepherd - npm Package Compare versions

Comparing version 0.7.2 to 1.0.0

bower.json

 {
   "name": "tether-shepherd",
-  "version": "0.7.2",
+  "version": "1.0.0",
   "homepage": "https://github.com/HubSpot/shepherd",
@@ -9,2 +9,5 @@ "authors": [
   ],
+  "maintainers": [
+    "Nicholas Hwang <[e-mail]>"
+  ],
   "description": "Guide your users through a tour of your app.",
@@ -18,2 +21,3 @@ "keywords": [
   "license": "MIT",
+  "main": "dist/js/shepherd.js",
   "ignore": [
@@ -26,3 +30,2 @@ "**/.*",
   ],
-  "main": "shepherd.js",
   "dependencies": {
@@ -29,0 +32,0 @@ "tether": "~0.7.2"

gulpfile.js

@@ -1,2 +0,101 @@
-require('coffee-script')
-require('./gulpfile.coffee')
+var del         = require('del');
+var gulp        = require('gulp');
+var babel       = require('gulp-babel');
+var bump        = require('gulp-bump');
+var coffee      = require('gulp-coffee');
+var filter      = require('gulp-filter');
+var header      = require('gulp-header');
+var prefixer    = require('gulp-autoprefixer');
+var rename      = require('gulp-rename');
+var uglify      = require('gulp-uglify');
+var sass        = require('gulp-sass');
+var tagVersion  = require('gulp-tag-version');
+var umd         = require('gulp-wrap-umd');
+
+// Variables
+var distDir = './dist';
+var pkg = require('./package.json');
+var banner = ['/*!', pkg.name, pkg.version, '*/\n'].join(' ');
+var umdOptions = {
+  exports: 'Shepherd',
+  namespace: 'Shepherd',
+  deps: [{
+    name: 'Tether',
+    globalName: 'Tether',
+    paramName: 'Tether',
+    amdName: 'tether',
+    cjsName: 'tether'
+  }]
+};
+
+
+// Clean
+gulp.task('clean', function() {
+  del.sync([distDir]);
+});
+
+
+// Javascript
+gulp.task('js', function() {
+  gulp.src('./src/js/**/*.js')
+    .pipe(babel())
+    .pipe(umd(umdOptions))
+    .pipe(header(banner))
+
+    // Original
+    .pipe(gulp.dest(distDir + '/js'))
+
+    // Minified
+    .pipe(uglify())
+    .pipe(rename({suffix: '.min'}))
+    .pipe(gulp.dest(distDir + '/js'));
+});
+
+
+// CSS
+gulp.task('css', function() {
+  gulp.src('./src/css/**/*.sass')
+    .pipe(sass({
+      includePaths: ['./bower_components']
+    }))
+    .pipe(prefixer())
+    .pipe(gulp.dest(distDir + '/css'));
+});
+
+
+// Eager
+gulp.task('eager', function() {
+  gulp.src('./src/eager/**/*.coffee')
+    .pipe(coffee())
+    .pipe(gulp.dest(distDir + '/eager'))
+});
+
+
+// Version bump
+var VERSIONS = ['patch', 'minor', 'major'];
+for (var i = 0; i < VERSIONS.length; ++i){
+  (function(version) {
+    var pkgFilter = filter('package.json');
+    gulp.task('version:' + version, function() {
+      gulp.src(['package.json', 'bower.json'])
+        .pipe(bump({type: version}))
+        .pipe(pkgFilter)
+        .pipe(tagVersion())
+        .pipe(pkgFilter.restore())
+        .pipe(gulp.dest('.'))
+    });
+  })(VERSIONS[i]);
+}
+
+
+// Watch
+gulp.task('watch', ['js', 'css'], function() {
+  gulp.watch('./src/js/**/*', ['js']);
+  gulp.watch('./src/css/**/*', ['css']);
+});
+
+
+// Defaults
+gulp.task('build', ['js', 'css', 'eager'])
+gulp.task('default', ['build'])
+

install.json

@@ -6,11 +6,11 @@ {
         "type": "style",
-        "src": "./css/shepherd-theme-{{ options.theme }}.css"
+        "src": "./dist/css/shepherd-theme-{{ options.theme }}.css"
       },
       {
         "type": "script",
-        "src": "./shepherd.js"
+        "src": "./dist/js/shepherd.js"
       },
       {
         "type": "script",
-        "src": "./js/installHelper.js"
+        "src": "./dist/eager/installHelper.js"
       },
@@ -17,0 +17,0 @@ {

package.json

 {
   "name": "tether-shepherd",
-  "version": "0.7.2",
+  "version": "1.0.0",
   "description": "Guide your users through a tour of your app.",
@@ -9,4 +9,10 @@ "authors": [
   ],
+  "maintainers": [
+    "Nicholas Hwang <[e-mail]>"
+  ],
+  "scripts": {
+    "build": "gulp build"
+  },
   "license": "MIT",
-  "main": "shepherd.js",
+  "main": "dist/js/shepherd.js",
   "spm": {
@@ -16,15 +22,19 @@ "main": "shepherd.js"
   "devDependencies": {
-    "coffee-script": "~1.6.3",
-    "gulp": "~3.4.0",
+    "del": "^1.2.0",
+    "gulp": "^3.8.11",
     "gulp-autoprefixer": "^2.2.0",
-    "gulp-bower": "0.0.1",
-    "gulp-coffee": "~1.2.5",
-    "gulp-concat": "~2.1.7",
-    "gulp-header": "~1.0.2",
-    "gulp-rename": "~0.2.1",
+    "gulp-babel": "^5.1.0",
+    "gulp-bump": "^0.3.1",
+    "gulp-coffee": "^2.3.1",
+    "gulp-filter": "^2.0.2",
+    "gulp-header": "^1.2.2",
+    "gulp-rename": "^1.2.2",
     "gulp-sass": "^2.0.0",
-    "gulp-uglify": "~0.1.0",
-    "gulp-util": "~2.2.9",
-    "gulp-wrap-umd": "*"
+    "gulp-tag-version": "^1.2.1",
+    "gulp-uglify": "^1.2.0",
+    "gulp-wrap-umd": "^0.2.1"
+  },
+  "dependencies": {
+    "tether": "^0.7.2"
   }
 }

README.md

@@ -0,8 +1,27 @@
+## Shepherd
+
 [![Guide your users through a tour of your app](http://i.imgur.com/LDhfBvd.png)](http://github.hubspot.com/shepherd/docs/welcome)
 
-### [Demo](http://github.hubspot.com/shepherd/docs/welcome/)    [Documentation](http://github.hubspot.com/shepherd/)
 
-Install with Eager
-------------------
+## Install
 
+__Dependencies__
+
+* __[Tether](https://github.com/HubSpot/tether)__
+
+Installing via `npm` and `bower` will bring in the above dependencies as well.
+
+
+__npm__
+```sh
+$ npm install tether-shepherd
+```
+
+__bower__
+```sh
+$ bower install tether-shepherd
+```
+
+__Eager__
+
 The easiest way to add a Shepherd tour to your site is with [Eager](http://eager.io).
@@ -14,1 +33,34 @@ Click Install to create a tour right on your site with no coding required.
 </a>
+
+
+## Usage
+
+```javascript
+let tour = new Shepherd.Tour({
+  defaults: {
+    classes: 'shepherd-theme-arrows'
+  }
+});
+
+tour.addStep('example', {
+  title: 'Example Shepherd',
+  text: 'Creating a Shepherd is easy too! Just create ...',
+  attachTo: '.hero-example bottom',
+  advanceOn: '.docs-link click'
+});
+
+tour.start();
+```
+
+[API documentation](http://github.hubspot.com/shepherd/)
+
+[Demo](http://github.hubspot.com/shepherd/docs/welcome/)
+
+
+## Contributing
+
+We encourage contributions of all kinds. If you would like to contribute in some way, please review our [guidelines for contributing](CONTRIBUTING.md).
+
+
+## License
+Copyright &copy; 2015 HubSpot - [MIT License](LICENSE)

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Number of package files

40

increased by8.11%

Number of low quality alerts

2

decreased by-33.33%

Number of lines in readme file

66

increased by371.43%

Worsened metrics

Total package byte prevSize

330876

decreased by-10.54%

Dependency count

1

increased byInfinity%

Dev dependency count

13

increased by8.33%

Lines of code

4172

decreased by-10.99%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Addedtether@^0.7.2

• + Addedtether@0.7.2(transitive)