Skip to content

Commit

Permalink
v1.4.0 updated base files
Browse files Browse the repository at this point in the history
  • Loading branch information
balupton committed Jan 25, 2018
1 parent 9efcab2 commit 8877427
Show file tree
Hide file tree
Showing 15 changed files with 1,203 additions and 217 deletions.
1 change: 1 addition & 0 deletions .babelrc
@@ -0,0 +1 @@
{ "presets": ["es2015"] }
19 changes: 11 additions & 8 deletions .editorconfig
@@ -1,23 +1,26 @@
# 2016 March 8
# 2018 January 24
# https://github.com/bevry/base

root = true

[*]
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = false
trim_trailing_whitespace = true
insert_final_newline = false
indent_style = tab

[*.json]
indent_style = space
indent_size = 2
[{*.mk,*.py}]
indent_style = tab
indent_size = 4

[*.yml]
[*.md]
indent_style = space
indent_size = 2
indent_size = 4

[*.md]
[{*.json,*.yml,*.bowerrc,*.babelrc}]
indent_style = space
indent_size = 2

[*.json]
insert_final_newline = true
8 changes: 7 additions & 1 deletion .gitignore
@@ -1,7 +1,11 @@
# 2016 March 21
# 2017 April 12
# https://github.com/bevry/base

# System Files
**/.DS_Store

# Temp Files
yarn.lock
**/.docpad.db
**/out.*
**/*.log
Expand All @@ -20,9 +24,11 @@ coffee/
es5/
es2015/
esnext/
docs/

# Editor Caches
.c9/
.vscode/

# Private Files
.env
Expand Down
33 changes: 24 additions & 9 deletions .npmignore
@@ -1,9 +1,17 @@
# v1.3.23 October 11, 2014
# 2017 April 3
# https://github.com/bevry/base

# Temp Files
**/*.log
yarn.lock
**/.docpad.db
**/out.*
**/*.log
**/*.cpuprofile
**/*.heapsnapshot

# Editor Files
.c9/
.vscode/

# Build Files
build/
Expand All @@ -14,19 +22,26 @@ node_modules/
# Private Files
.env

# Documentation Files
docs/
guides/
BACKERS.md
CONTRIBUTING.md
HISTORY.md

# Development Files
web/
**/example*
**/test*
.editorconfig
.eslintrc
.eslintrc*
.jshintrc
coffeelint.json
.jscrc
coffeelint*
.travis*
nakefile*
Cakefile
Makefile
BACKERS.md
CONTRIBUTING.md
HISTORY.md
**/src/
**/test/

# Other Package Definitions
template.js
Expand Down
46 changes: 23 additions & 23 deletions .travis.yml
@@ -1,32 +1,32 @@
# 2016 April 27
# https://github.com/bevry/base

# Use the latest travis infrastructure
sudo: false

# We use node
language: node_js
node_js:
- "0.12"
- "4"
- "5"
- "6"
- '0.8'
- '0.10'
- '0.12'
- '4'
- '6'
- '8'
- '9'
matrix:
fast_finish: true
allow_failures:
- node_js: '0.8'
- node_js: '0.10'
- node_js: '9'
cache:
directories:
- node_modules

# Prepare our tests
# Ensure the project is setup correctly and compiled
install: "npm run-script setup"
before_script: "npm run-script compile"

# Run our tests
script: "npm test"

# Custom notifications
- "$HOME/.npm"
- "$HOME/.yarn-cache"
install:
- eval "$(curl -s https://raw.githubusercontent.com/bevry/awesome-travis/ef794235b7094de5e49fb64e226da032ce135ecd/scripts/node-install.bash)"
before_script:
- eval "$(curl -s https://raw.githubusercontent.com/bevry/awesome-travis/ef794235b7094de5e49fb64e226da032ce135ecd/scripts/node-verify.bash)"
after_success:
- eval "$(curl -s https://raw.githubusercontent.com/bevry/awesome-travis/ef794235b7094de5e49fb64e226da032ce135ecd/scripts/node-publish.bash)"
notifications:
slack:
secure: i/1Dtyb9ZAxBk2tBpw/0+D+1aV/s/7mIDQEc/7AIJRAFJS38opkfVzhAkHYxlMQzvGpsxKKglJIkelkjLT/sQ+RlZUlOqw5GofZBkg0KWOoIeQ3sTweecp7dS/DkrjUwKbR+4WAxGI5sNUkwTcb3ThHzLNK8pzIUaQQ1D6qQXnI=
secure: DwQnTqfrLrjAxJsn9DrxwrAbvINA5x7Bc1hq8kXlX39tqX26ljlHrM0dpQyd2ys84zOJAPG+8TKZJbBcbp1tOskaHiJ9pv8qOoq+HpiYjajDJ5oxzgMl7Q6A9HHhJ2zhs0O5KrVIkeeaoo5cWo2PHnj3OrAsXUvpAyhqMlPqHKM=
email:
recipients:
secure: K6xSdVr++8MPuzBUO79tPSKJ++0V/MxZ3/ySnV0ShTUBwlA/Mwbws2N+GCh/TzjrSefuCkioVCLmRn/Jfn3lgAfUA1DkmwEm2ocx1FNzOpfgia4fxZlWwZ61BXPmmUMyOHYYCw07LIyTOXZaRTQse0zzzPIzpCvYXhWDBo4pfBU=
secure: JRa+7sHk7DOYr/tRX8Y6uaMYMnCr8bPSw2yhTt3aleBGtzyHhRH+Q8DxH0fVWPlZfXbIWFo7DR6eNIDI27V4rOeMsouefS5HYvqngxAfde2nw08rxpr/Hdh6GNBcrLRyfaUKpN9NclAkOC2jBNpbyGLD3THTzyVzQZQvvdT9pvQ=
52 changes: 20 additions & 32 deletions CONTRIBUTING.md
@@ -1,5 +1,5 @@
<!--
2016 March 8
2017 August 25
https://github.com/bevry/base
-->

Expand All @@ -12,43 +12,37 @@ We offer support through our [Official Support Channels](https://bevry.me/suppor

## Contribute

Our [Contributing Guide](https://learn.bevry.me/community/contribute) contains useful tips and suggestions for how to contribute to this project, it's worth the read.
Our [Contributing Guide](https://bevry.me/contribute) contains useful tips and suggestions for how to contribute to this project, it's worth the read.


## Development

### Setup

1. Install [Node.js](/node/install)
1. Install [Node.js](https://learn.bevry.me/node/install)

1. Fork the project and clone your fork - [guide](https://help.github.com/articles/fork-a-repo/)

1. Install local dependencies
1. Setup the project for development

``` bash
npm install
```

1. Perform any other setup operations

``` bash
npm run-script setup
npm run our:setup
```


### Developing

1. Compile changes

``` bash
npm run-script compile
```
``` bash
npm run our:compile
```

1. Run tests

``` bash
npm run-script verify
```
``` bash
npm test
```


### Publishing
Expand All @@ -65,17 +59,15 @@ Follow these steps in order to implement your changes/improvements into your des
1. Ensure all tests pass:

``` bash
npm run-script verify
npm test
```

> If possible, add tests for your change, if you don't know how, mention this in your pull request
1. Ensure the project is ready for publishing:

```
git status
git diff
npm run-script prepare
npm run our:release:prepare
```


Expand Down Expand Up @@ -108,11 +100,11 @@ To publish your changes as the project owner:
1. Add an entry to the changelog following the format of the previous entries, an example of this is:

``` markdown
- v6.29.0 April 1, 2013
- Progress on [issue #474](https://github.com/bevry/docpad/issues/474)
- DocPad will now set permissions based on the process's ability
- Thanks to [Avi Deitcher](https://github.com/deitch), [Stephan Lough](https://github.com/stephanlough) for [issue #165](https://github.com/bevry/docpad/issues/165)
- Updated dependencies
## v6.29.0 2013 April 1
- Progress on [issue #474](https://github.com/bevry/docpad/issues/474)
- DocPad will now set permissions based on the process's ability
- Thanks to [Avi Deitcher](https://github.com/deitch), [Stephan Lough](https://github.com/stephanlough) for [issue #165](https://github.com/bevry/docpad/issues/165)
- Updated dependencies
```


Expand All @@ -122,15 +114,11 @@ To publish your changes as the project owner:
1. Ensure the project is ready for publishing:

```
git status
git diff
npm run-script prepare
npm run our:release:prepare
```

1. Prepare the release and publish it to npm and git:

``` bash
npm run-script release
npm run our:release
```

> A prompt will occur asking you for a git tag annotation, enter the changelog entry that we created earlier, save and exit the prompt.
5 changes: 5 additions & 0 deletions HISTORY.md
@@ -1,5 +1,10 @@
# History

## v1.4.0 2018 January 25
- Now compiled with CoffeeScript v2
- Now uses [editions](https://github.com/bevry/editions) to use the ESNext compiled edition for environments that support it, otherwise use the ES2015 compiled edition
- Updated base files

## v1.3.0 2018 January 25
- Fetch the mac address of a specific interface using the `iface` option
- Thanks to [caasi Huang](https://github.com/caasi) for [pull request #22](https://github.com/bevry/getmac/pull/22)
Expand Down
14 changes: 10 additions & 4 deletions README.md
Expand Up @@ -13,13 +13,15 @@
<span class="badge-daviddm"><a href="https://david-dm.org/bevry/getmac" title="View the status of this project's dependencies on DavidDM"><img src="https://img.shields.io/david/bevry/getmac.svg" alt="Dependency Status" /></a></span>
<span class="badge-daviddmdev"><a href="https://david-dm.org/bevry/getmac#info=devDependencies" title="View the status of this project's development dependencies on DavidDM"><img src="https://img.shields.io/david/dev/bevry/getmac.svg" alt="Dev Dependency Status" /></a></span>
<br class="badge-separator" />
<span class="badge-slackin"><a href="https://slack.bevry.me" title="Join this project's slack community"><img src="https://slack.bevry.me/badge.svg" alt="Slack community badge" /></a></span>
<span class="badge-patreon"><a href="https://patreon.com/bevry" title="Donate to this project using Patreon"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Patreon donate button" /></a></span>
<span class="badge-opencollective"><a href="https://opencollective.com/bevry" title="Donate to this project using Open Collective"><img src="https://img.shields.io/badge/open%20collective-donate-yellow.svg" alt="Open Collective donate button" /></a></span>
<span class="badge-gratipay"><a href="https://www.gratipay.com/bevry" title="Donate weekly to this project using Gratipay"><img src="https://img.shields.io/badge/gratipay-donate-yellow.svg" alt="Gratipay donate button" /></a></span>
<span class="badge-flattr"><a href="https://flattr.com/profile/balupton" title="Donate to this project using Flattr"><img src="https://img.shields.io/badge/flattr-donate-yellow.svg" alt="Flattr donate button" /></a></span>
<span class="badge-paypal"><a href="https://bevry.me/paypal" title="Donate to this project using Paypal"><img src="https://img.shields.io/badge/paypal-donate-yellow.svg" alt="PayPal donate button" /></a></span>
<span class="badge-bitcoin"><a href="https://bevry.me/bitcoin" title="Donate once-off to this project using Bitcoin"><img src="https://img.shields.io/badge/bitcoin-donate-yellow.svg" alt="Bitcoin donate button" /></a></span>
<span class="badge-wishlist"><a href="https://bevry.me/wishlist" title="Buy an item on our wishlist for us"><img src="https://img.shields.io/badge/wishlist-donate-yellow.svg" alt="Wishlist browse button" /></a></span>
<br class="badge-separator" />
<span class="badge-slackin"><a href="https://slack.bevry.me" title="Join this project's slack community"><img src="https://slack.bevry.me/badge.svg" alt="Slack community badge" /></a></span>

<!-- /BADGES -->

Expand Down Expand Up @@ -51,9 +53,12 @@ Will run anywhere that the underlying commands are present:

<p>This package is published with the following editions:</p>

<ul><li><code>getmac/src/lib/getmac.coffee</code> is Source + CoffeeScript + <a href="https://nodejs.org/dist/latest-v5.x/docs/api/modules.html" title="Node/CJS Modules">Require</a></li>
<li><code>getmac</code> aliases <code>getmac/es5/lib/getmac.js</code></li>
<li><code>getmac/es5/lib/getmac.js</code> is CoffeeScript Compiled JavaScript + ES5 + <a href="https://nodejs.org/dist/latest-v5.x/docs/api/modules.html" title="Node/CJS Modules">Require</a></li></ul>
<ul><li><code>getmac</code> aliases <code>getmac/index.js</code> which uses <a href="https://github.com/bevry/editions" title="Editions are the best way to produce and consume packages you care about.">Editions</a> to automatically select the correct edition for the consumers environment</li>
<li><code>getmac/source/index.coffee</code> is Source + CoffeeScript + <a href="https://nodejs.org/dist/latest-v5.x/docs/api/modules.html" title="Node/CJS Modules">Require</a></li>
<li><code>getmac/esnext/index.js</code> is CoffeeScript Compiled + <a href="https://babeljs.io/docs/learn-es2015/" title="ECMAScript Next">ESNext</a> + <a href="https://nodejs.org/dist/latest-v5.x/docs/api/modules.html" title="Node/CJS Modules">Require</a></li>
<li><code>getmac/es2015/index.js</code> is CoffeeScript Compiled + <a href="http://babeljs.io/docs/plugins/preset-es2015/" title="ECMAScript 2015">ES2015</a> + <a href="https://nodejs.org/dist/latest-v5.x/docs/api/modules.html" title="Node/CJS Modules">Require</a></li></ul>

<p>Older environments may need <a href="https://babeljs.io/docs/usage/polyfill/" title="A polyfill that emulates missing ECMAScript environment features">Babel's Polyfill</a> or something similar.</p>

<!-- /INSTALL -->

Expand Down Expand Up @@ -124,6 +129,7 @@ These amazing people are maintaining this project:
No sponsors yet! Will you be the first?

<span class="badge-patreon"><a href="https://patreon.com/bevry" title="Donate to this project using Patreon"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Patreon donate button" /></a></span>
<span class="badge-opencollective"><a href="https://opencollective.com/bevry" title="Donate to this project using Open Collective"><img src="https://img.shields.io/badge/open%20collective-donate-yellow.svg" alt="Open Collective donate button" /></a></span>
<span class="badge-gratipay"><a href="https://www.gratipay.com/bevry" title="Donate weekly to this project using Gratipay"><img src="https://img.shields.io/badge/gratipay-donate-yellow.svg" alt="Gratipay donate button" /></a></span>
<span class="badge-flattr"><a href="https://flattr.com/profile/balupton" title="Donate to this project using Flattr"><img src="https://img.shields.io/badge/flattr-donate-yellow.svg" alt="Flattr donate button" /></a></span>
<span class="badge-paypal"><a href="https://bevry.me/paypal" title="Donate to this project using Paypal"><img src="https://img.shields.io/badge/paypal-donate-yellow.svg" alt="PayPal donate button" /></a></span>
Expand Down
2 changes: 2 additions & 0 deletions bin/getmac-node → bin.js
@@ -1,2 +1,4 @@
#!/usr/bin/env node
'use strict'

require('../').getMac(console.log)
5 changes: 5 additions & 0 deletions index.js
@@ -0,0 +1,5 @@
// 2016 December 29
// https://github.com/bevry/editions
'use strict'

module.exports = require('editions').requirePackage(__dirname, require)

0 comments on commit 8877427

Please sign in to comment.