Skip to content

Commit

Permalink
Added build workflow for continuous integration.
Browse files Browse the repository at this point in the history
Added JSHint, JS CodeStyle configuration files
Added a robust gitignore setting.
Added readme, contributing and changelog.
  • Loading branch information
Igor Lino committed May 29, 2015
1 parent 916b351 commit 3b2c410
Show file tree
Hide file tree
Showing 8 changed files with 268 additions and 3 deletions.
5 changes: 3 additions & 2 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
# http://editorconfig.org
# top-most EditorConfig file
root = true

# Unix-style newlines with a newline ending every file
[*]
indent_style = space
indent_size = 2
indent_size = 4
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
Expand Down
69 changes: 68 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,68 @@
.tmp/
# Ignore Visual Studio Project #
###################
*.user
*.gpState
*.suo
bin
obj
/packages

# Ignore Node & Bower
###################
node_modules
bower_components
build
.tmp

# Ignore Test reporters
###################
**/test/coverage
report

# Ignore Web Storm #
.idea

# Compiled source #
###################
*.com
*.class
*.dll
*.exe
*.o
*.so

# Packages #
############
# it's better to unpack these files and commit the raw source
# git has its own built in compression methods
*.7z
*.dmg
*.gz
*.iso
*.jar
*.rar
*.tar
*.xap
*.zip

# Logs and databases #
######################
*.log
*.sql
*.sqlite
# *.sdf
*.mdf
*.ldf

# OS generated files #
######################
.DS_Store*
ehthumbs.db
Icon?
Thumbs.db

# Custom #
######################
.build
dist
*.mo
73 changes: 73 additions & 0 deletions .jscsrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
{
"excludeFiles": ["node_modules/**", "bower_components/**"],

"requireCurlyBraces": [
"if",
"else",
"for",
"while",
"do",
"try",
"catch"
],
"requireOperatorBeforeLineBreak": true,
"requireCamelCaseOrUpperCaseIdentifiers": true,
"maximumLineLength": {
"value": 150,
"allowComments": true,
"allowRegex": true
},
"validateIndentation": 4,
"validateQuoteMarks": "'",

"disallowMultipleLineStrings": true,
"disallowMixedSpacesAndTabs": true,
"disallowSpaceAfterPrefixUnaryOperators": true,
"disallowMultipleVarDecl": null,
"disallowTrailingWhitespace": true,


"requireSpaceAfterKeywords": [
"if",
"else",
"for",
"while",
"do",
"switch",
"return",
"try",
"catch"
],
"requireSpaceBeforeBinaryOperators": [
"=", "+=", "-=", "*=", "/=", "%=", "<<=", ">>=", ">>>=",
"&=", "|=", "^=", "+=",

"+", "-", "*", "/", "%", "<<", ">>", ">>>", "&",
"|", "^", "&&", "||", "===", "==", ">=",
"<=", "<", ">", "!=", "!=="
],
"requireSpaceAfterBinaryOperators": true,
"requireSpacesInConditionalExpression": true,
"requireSpaceBeforeBlockStatements": true,
"requireLineFeedAtFileEnd": true,
"disallowSpacesInsideObjectBrackets": "all",
"disallowSpacesInsideArrayBrackets": "all",
"disallowSpacesInsideParentheses": true,

"validateJSDoc": {
"checkParamNames": true,
"requireParamTypes": true
},

"disallowMultipleLineBreaks": true,

"disallowCommaBeforeLineBreak": null,
"disallowDanglingUnderscores": null,
"disallowEmptyBlocks": null,
"disallowMultipleLineStrings": null,
"disallowTrailingComma": null,
"requireCommaBeforeLineBreak": null,
"requireDotNotation": null,
"requireMultipleVarDecl": null,
"requireParenthesesAroundIIFE": true
}
60 changes: 60 additions & 0 deletions .jshintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
{
"bitwise": true,
"camelcase": true,
"curly": true,
"eqeqeq": true,
"es3": false,
"forin": true,
"freeze": true,
"immed": true,
"indent": 4,
"latedef": "nofunc",
"newcap": true,
"noarg": true,
"noempty": true,
"nonbsp": true,
"nonew": true,
"plusplus": false,
"quotmark": "single",
"undef": true,
"unused": false,
"strict": false,
"maxparams": 10,
"maxdepth": 5,
"maxstatements": 40,
"maxcomplexity": 8,
"maxlen": 150,

"asi": false,
"boss": false,
"debug": false,
"eqnull": true,
"esnext": false,
"evil": false,
"expr": false,
"funcscope": false,
"globalstrict": false,
"iterator": false,
"lastsemic": false,
"laxbreak": false,
"laxcomma": false,
"loopfunc": true,
"maxerr": false,
"moz": false,
"multistr": false,
"notypeof": false,
"proto": false,
"scripturl": false,
"shadow": false,
"sub": true,
"supernew": false,
"validthis": false,
"noyield": false,

"browser": true,
"node": true,

"globals": {
"angular": false
}
}
2 changes: 2 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.DS_Store
node_modules
6 changes: 6 additions & 0 deletions CHANGELOG.md.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<a name="1.0.0"></a>

# 1.0.0 (2015-28-05)
- build v1.0.1
- Initial commit, it includes bower repository settings.
- Refactor naming.
13 changes: 13 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Contributing

Before sending a pull request remember to follow [jQuery Core Style Guide](http://contribute.jquery.org/style-guide/js/).

1. Fork it!
2. Use an editor that has EditorConfig support
3. Create your feature branch: `git checkout -b my-new-feature`
4. Make your changes on the `src` folder, never on the `dist` folder.
5. ENSURE to follow the EditorConfig format style (found in this project), in order to have a consistent format style. (Webstorm supports/detects EditorConfig can auto-format JavScript files by pressing Ctrl-Alt-L )
6. ENSURE to follow [John's Angular Style Guide](https://github.com/johnpapa/angular-styleguide)
7. Commit your changes: `git commit -m 'Add some feature'`
8. Push to the branch: `git push origin my-new-feature`
9. Submit a pull request :D
43 changes: 43 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
[Angular Directive](http://igorlino.github.io/angular-elevatezoom-plus/)
================================

[Angular EZ Plus](http://igorlino.github.io/angular-elevatezoom-plus/) is directive for [ElevateZoom Plus](http://igorlino.github.io/elevatezoom-plus/)

## Features

- Image Zooming
- Easing
- Angular directive

## Installation

Via [npm](https://www.npmjs.com/):

```bash
npm install angular-ez-plus
```

Via [Bower](http://bower.io/):

```bash
bower install angular-ez-plus
```

In a browser:

```html
<script src="widget-ezplus-directive.js"></script>
```

## Getting Started

Include jQuery and the plug-in on a page. Include your images and initialise the plug-in.

```html
<img ez-plus id="zoom_01" src='images/large/image1.png' />
```

For more information on how to setup and customise, [check the examples](http://igorlino.github.io/angular-elevatezoom-plus/).

## License
Licensed under MIT license.

0 comments on commit 3b2c410

Please sign in to comment.