Skip to content

Commit

Permalink
Created simple grunt task to lint php
Browse files Browse the repository at this point in the history
  • Loading branch information
soonick committed Sep 24, 2013
1 parent 00177c0 commit 21ee3d2
Show file tree
Hide file tree
Showing 6 changed files with 50 additions and 3 deletions.
6 changes: 4 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
config.php
cache/pommo/*
cache/pommo/
node_modules/

cache/ERROR_LOG
cache/maintenance.php
config.php
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,5 @@ Some of the things that makes **poMMo** so cool is the lack of bloatware needed

**poMMo** can handle very large email lists upward of 20k addresses and can be installed alongside your existing website in a matter of minutes. Just make sure you create a new database for it and away you go.

[User Documentation](docs/user/index.md)
- [User Documentation](docs/user/index.md)
- [Developer Documentation](docs/developer/index.md)
17 changes: 17 additions & 0 deletions docs/developer/environment_setup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
In an effort to improve poMMo's quality I am trying to automate some development tasks that will hopefully make the codebase better. In order to run these automated tasks there is some setup necessary.

### Node.js

Node.js is a platform that is needed by our task runner; Grunt. It allows you to run applications written in JavaScript in the Desktop. You can get it from [Node's website](http://nodejs.org/).

### Grunt

Grunt is a task runner like make, ant or rake but a litte easier to user and understand. To get it you only need to run **npm install** (after installing node.js) in the root of your poMMo folder.

### Running our tasks

Currently we only have one simple task that lints our php files, you can run it using this command from poMMo's root:

```
grunt
```
1 change: 1 addition & 0 deletions docs/developer/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
- [Environment set-up](environment_setup.md)
15 changes: 15 additions & 0 deletions gruntfile.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
module.exports = function(grunt) {
grunt.initConfig({
phplint: {
all: [
'*.php',
'ajax/*.php',
'classes/*.php',
]
}
});

grunt.loadNpmTasks('grunt-phplint');

grunt.registerTask('default', ['phplint:all']);
};
11 changes: 11 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"name": "poMMo",
"version": "0.0.1",
"description": "poMMo mass mailer",
"author": "Adrian Ancona <soonick5@yahoo.com.mx>",
"devDependencies": {
"grunt": "~0.4.0",
"grunt-cli": "*",
"grunt-phplint": "0.0.5"
}
}

0 comments on commit 21ee3d2

Please sign in to comment.