Skip to content

Commit

Permalink
Merge pull request #3 from carrot/roots-update
Browse files Browse the repository at this point in the history
update to node 6 and boost deps to latest roots
  • Loading branch information
Jeff Escalante committed May 10, 2016
2 parents 272fba2 + 186419d commit 598a521
Show file tree
Hide file tree
Showing 10 changed files with 50 additions and 67 deletions.
3 changes: 0 additions & 3 deletions .babelrc

This file was deleted.

3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
node_modules
.DS_Store
.DS_Store
.nyc_output
4 changes: 3 additions & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
language: node_js
sudo: false
node_js:
- 5.2
- 6
after_script:
- npm run coveralls
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
License (MIT)
-------------

Copyright (c) 2015 carrot
Copyright (c) 2015 Jeff Escalante, Carrot Creative

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:

Expand Down
12 changes: 0 additions & 12 deletions Makefile

This file was deleted.

9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# roots-mini-records
# Roots Mini Records

[![npm](http://img.shields.io/npm/v/roots-mini-records.svg?style=flat)](https://badge.fury.io/js/roots-mini-records) [![tests](http://img.shields.io/travis/carrot/roots-mini-records/master.svg?style=flat)](https://travis-ci.org/carrot/roots-mini-records) [![dependencies](http://img.shields.io/gemnasium/carrot/roots-mini-records.svg?style=flat)](https://david-dm.org/carrot/roots-mini-records)
[![npm](http://img.shields.io/npm/v/roots-mini-records.svg?style=flat)](https://badge.fury.io/js/roots-mini-records) [![tests](http://img.shields.io/travis/carrot/roots-mini-records/master.svg?style=flat)](https://travis-ci.org/carrot/roots-mini-records) [![dependencies](http://img.shields.io/david/carrot/roots-mini-records.svg?style=flat)](https://david-dm.org/carrot/roots-mini-records)
[![coverage](http://img.shields.io/coveralls/carrot/roots-mini-records.svg?style=flat)](https://coveralls.io/github/carrot/roots-mini-records?branch=master)

remote data -> static templates

Expand All @@ -17,9 +18,9 @@ Install into your project with `npm i roots-mini-records -S`.
Then load it up as a plugin in `app.js` like this:

```js
import RecordsPlugin from 'roots-mini-records'
const RecordsPlugin = require('roots-mini-records')

export default {
module.exports = {
plugins: [new RecordsPlugin({ test: { file: 'data.json' } })]
}
```
Expand Down
8 changes: 3 additions & 5 deletions contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,17 @@ If you are opening an issue about a bug, make sure that you include clear steps
### Getting Set Up

- Clone the project down
- Make sure [nodejs](http://nodejs.org) has been installed and is above version `5.2.x`
- Make sure [nodejs](http://nodejs.org) has been installed and is above version `6.0.0`
- Run `npm install`
- Put in work

### Testing

This project is constantly evolving, and to ensure that things are secure and working for everyone, we need to have tests. If you are adding a new feature, please make sure to add a test for it. The test suite for this project uses [mocha](http://visionmedia.github.io/mocha/) and [should](https://github.com/visionmedia/should.js/)/

To run the test suite, make sure you have installed mocha (`npm install mocha -g`), then you can use the `npm test` or simply `mocha` command to run the tests.
You can run the tests with `npm test`. They are written using [ava](https://github.com/sindresorhus/ava).

### Code Style

This project uses ES6, transpiled by babel for tests and on deploy. To keep a consistent coding style in the project, we are using [standard js](http://standardjs.com/). In order for tests to pass, all code must pass standard js linting. This project also uses an [editorconfig](http://editorconfig.org/). It will make life much easier if you have the [editorconfig plugin](http://editorconfig.org/#download) for your text editor. For any inline documentation in the code, we're using [JSDoc](http://usejsdoc.org/).
This project uses ES6 directly through node >= v6. To keep a consistent coding style in the project, we are using [standard js](http://standardjs.com/). In order for tests to pass, all code must pass standard js linting. This project also uses an [editorconfig](http://editorconfig.org/). It will make life much easier if you have the [editorconfig plugin](http://editorconfig.org/#download) for your text editor. For any inline documentation in the code, we're using [JSDoc](http://usejsdoc.org/).

### Commit Cleanliness

Expand Down
20 changes: 10 additions & 10 deletions lib/index.js
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
import W from 'when'
import keys from 'when/keys'
import node from 'when/node'
import rest from 'rest'
import fs from 'fs'
import path from 'path'
import R from 'ramda'
import jade from 'jade'
import mkdirp from 'mkdirp'
const W = require('when')
const keys = require('when/keys')
const node = require('when/node')
const rest = require('rest')
const fs = require('fs')
const path = require('path')
const R = require('ramda')
const jade = require('jade')
const mkdirp = require('mkdirp')

// this needs to be a function that returns a function
export default class Records {
module.exports = class Records {
constructor (opts) {
this.opts = opts
}
Expand Down
44 changes: 20 additions & 24 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,39 +1,35 @@
{
"name": "roots-mini-records",
"description": "remote data > static templates",
"version": "0.0.4",
"description": "remote data > static templates",
"main": "lib",
"scripts": {
"test": "ava"
},
"author": "carrot",
"license": "MIT",
"babel": {
"presets": [
"es2015-node5"
]
},
"devDependencies": {
"ava": "0.13.x",
"babel-cli": "6.x",
"babel-core": "6.x",
"babel-preset-es2015": "6.x",
"rimraf": "^2.5.2",
"roots-mini": "0.0.13",
"standard": "5.x"
},
"ava": {
"require": [
"babel-core/register"
],
"verbose": "true",
"serial": "true"
},
"dependencies": {
"jade": "^1.11.0",
"mkdirp": "^0.5.1",
"ramda": "^0.20.1",
"ramda": "^0.21.0",
"rest": "^1.3.2",
"when": "^3.7.7"
},
"devDependencies": {
"ava": "^0.14.0",
"coveralls": "^2.11.9",
"nyc": "^6.4.4",
"rimraf": "^2.5.2",
"roots-mini": "0.0.23",
"standard": "^7.0.1"
},
"engines": {
"node": ">= 6.0.0"
},
"license": "MIT",
"main": "lib",
"scripts": {
"test": "ava",
"coverage": "nyc ava",
"coveralls": "nyc --reporter=lcov ava && cat ./coverage/lcov.info | coveralls"
}
}
12 changes: 6 additions & 6 deletions test/index.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import test from 'ava'
import Roots from 'roots-mini'
import path from 'path'
import fs from 'fs'
import Records from '..'
import rimraf from 'rimraf'
const test = require('ava')
const Roots = require('roots-mini')
const path = require('path')
const fs = require('fs')
const Records = require('..')
const rimraf = require('rimraf')

const fixturesPath = path.join(__dirname, 'fixtures')

Expand Down

0 comments on commit 598a521

Please sign in to comment.