Skip to content

Commit

Permalink
Merge branch 'release/0.13.0'
Browse files Browse the repository at this point in the history
  • Loading branch information
pascalberger committed Mar 9, 2018
2 parents 2f06579 + cb1d724 commit 52c718f
Show file tree
Hide file tree
Showing 24 changed files with 769 additions and 57 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Project specific

BuildArtifacts/
config.wyam.*
docs/input/tasks/

# Created by https://www.gitignore.io/api/cake,visualstudio

Expand Down
35 changes: 35 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Contribution Guidelines

This repository uses [GitFlow] with default configuration.
Development is happening on `develop` branch.

To contribute:

* Fork this repository.
* Create a feature branch from `develop`.
* Implement your changes.
* Push your feature branch.
* Create a pull request.

## Build

To build this package we are using Cake.

On Windows PowerShell run:

```powershell
./build
```

On OSX/Linux run:

```bash
./build.sh
```

## Release

See [Cake.Recipe documentation] how to create a new release of this addin.

[GitFlow]: (http://nvie.com/posts/a-successful-git-branching-model/)
[Cake.Recipe documentation]: https://cake-contrib.github.io/Cake.Recipe/docs/usage/creating-release
2 changes: 1 addition & 1 deletion GitReleaseManager.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ issue-labels-exclude:
issue-labels-alias:
- name: Documentation
header: Documentation
plural: Documentation
plural: Documentation
61 changes: 23 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,54 +1,39 @@
# cake-npm
# Cake.Npm Addin

## Usage
This Addin for the Cake Build Automation System allows you to run [npm](https://www.npmjs.com/).
More about Cake at http://cakebuild.net

```c#
#addin "Cake.Npm"
[![License](http://img.shields.io/:license-mit-blue.svg)](http://cake-contrib.mit-license.org)

var target = Argument("target", "Default");
## Information

Task("Example").Does(() => {
var settings = new NpmInstallSettings();
| |Stable|Pre-release|
|:--:|:--:|:--:|
|GitHub Release|-|[![GitHub release](https://img.shields.io/github/release/cake-contrib/Cake.Npm.svg)](https://github.com/cake-contrib/Cake.Npm/releases/latest)|
|NuGet|[![NuGet](https://img.shields.io/nuget/v/Cake.Npm.svg)](https://www.nuget.org/packages/Cake.Npm)|[![NuGet](https://img.shields.io/nuget/vpre/Cake.Npm.svg)](https://www.nuget.org/packages/Cake.Npm)|

settings.Global = true;
settings.Production = false;
settings.LogLevel = NpmLogLevel.Verbose;
## Build Status

settings.AddPackage("gulp");
settings.AddPackage("left-pad");
|Develop|Master|
|:--:|:--:|
|[![Build status](https://ci.appveyor.com/api/projects/status/5fbkekpb5roh39m8/branch/develop?svg=true)](https://ci.appveyor.com/project/cakecontrib/cake-npm/branch/develop)|[![Build status](https://ci.appveyor.com/api/projects/status/5fbkekpb5roh39m8/branch/develop?svg=true)](https://ci.appveyor.com/project/cakecontrib/cake-npm/branch/master)|

NpmInstall(settings);
});
## Code Coverage

Task("PackageJsonFromDirectory").Does(() => {
var settings = new NpmInstallSettings();
[![Coverage Status](https://coveralls.io/repos/github/cake-contrib/Cake.Npm/badge.svg?branch=develop)](https://coveralls.io/github/cake-contrib/Cake.Npm?branch=develop)

settings.LogLevel = NpmLogLevel.Info;
settings.WorkingDirectory = "usage/";
settings.Production = true;
## Quick Links

NpmInstall(settings);
});
- [Documentation](https://cake-contrib.github.io/Cake.Npm)

Task("Default")
.IsDependentOn("Example")
.IsDependentOn("PackageJsonFromDirectory");
## Chat Room

//////////////////////////////////////////////////////////////////////
// EXECUTION
//////////////////////////////////////////////////////////////////////
Come join in the conversation about Cake.Yeoman in our Gitter Chat Room

RunTarget(target);
```
[![Join the chat at https://gitter.im/cake-contrib/Lobby](https://badges.gitter.im/cake-contrib/Lobby.svg)](https://gitter.im/cake-contrib/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

## Documentation
## Contributing

Thanks to the cakebuild.net site, documentation can be found [here](http://cakebuild.net/api/cake.npm/)
Contributions are welcome. See [Contribution Guidelines].

## Tests

Cake.Npm is covered by a set of unit tests contributed by @nengberg

## I cant do _insert-command-here_

If you have feature requests please submit them as issues, or better yet as pull requests :)
[Contribution Guidelines]: CONTRIBUTING.md
1 change: 1 addition & 0 deletions config.wyam
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
System.Globalization.CultureInfo.DefaultThreadCurrentCulture = System.Globalization.CultureInfo.CreateSpecificCulture("en-GB");
56 changes: 56 additions & 0 deletions docs/input/_Bottom.cshtml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
<div class="github-button">
<a href="https://github.com/cake-contrib/Cake.Npm" target="_blank"><i class="fa fa-github"></i> GitHub</a>
</div>
<script>
((window.gitter = {}).chat = {}).options = {
room: 'cake-contrib/Lobby'
};
</script>
<script src="https://sidecar.gitter.im/dist/sidecar.v1.js" async defer></script>

<script type="text/javascript" src="@Context.GetLink("/assets/js/anchor.min.js")"></script>
<script type="text/javascript" src="@Context.GetLink("/assets/js/clipboard.min.js")"></script>
<script type="text/javascript">
anchors.options.placement = 'left';
anchors.add('#content > h1,h2,h3,h4');
var snippets = document.querySelectorAll("pre > code");
[].forEach.call(snippets, function(snippet) {
snippet.insertAdjacentHTML("beforebegin", "<button class='btn-copy' data-clipboard-snippet><img class='clippy' width=13 src='@Context.GetLink("/assets/images/clippy.svg")' alt='Copy to clipboard'></button>");
});
var clipboardSnippets = new Clipboard('[data-clipboard-snippet]', {
target: function(trigger) {
return trigger.nextElementSibling;
}
});
clipboardSnippets.on('success', function(e) {
e.clearSelection();
showTooltip(e.trigger, "Copied!");
});
clipboardSnippets.on('error', function(e) {
showTooltip(e.trigger, fallbackMessage(e.action));
});
var btns = document.querySelectorAll('.btn-copy');
for (var i = 0; i < btns.length; i++) {
btns[i].addEventListener('mouseleave', function(e) {
e.currentTarget.setAttribute('class', 'btn-copy');
e.currentTarget.removeAttribute('aria-label');
});
}
function showTooltip(elem, msg) {
elem.setAttribute('class', 'btn-copy tooltipped tooltipped-s');
elem.setAttribute('aria-label', msg);
}
function fallbackMessage(action) {
var actionMsg = '';
var actionKey = (action === 'cut' ? 'X' : 'C');
if (/iPhone|iPad/i.test(navigator.userAgent)) {
actionMsg = 'No support :(';
} else if (/Mac/i.test(navigator.userAgent)) {
actionMsg = 'Press ⌘-' + actionKey + ' to ' + action;
} else {
actionMsg = 'Press Ctrl-' + actionKey + ' to ' + action;
}
return actionMsg;
}
</script>
5 changes: 5 additions & 0 deletions docs/input/_Footer.cshtml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<p class="text-muted">
Copyright &copy; <a href="https://github.com/cake-contrib/Cake.Npm/graphs/contributors" target="_blank">contributors</a>.
<br/>
Website generated by <a href="http://wyam.io" target="_blank">Wyam</a>
</p>
122 changes: 122 additions & 0 deletions docs/input/assets/css/override.less
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
/* Control the margin for bootstrap alert boxes */
.alert > p {
margin-top: 0px;
}

/* Control the look and feel of the copy box applied to code sections */
.btn-copy[disabled] .clippy {
opacity: .3;
}
pre .btn-copy {
-webkit-transition: opacity 0.3s ease-in-out;
-o-transition: opacity 0.3s ease-in-out;
transition: opacity 0.3s ease-in-out;
opacity: 0;
padding: 2px 6px;
float: right;
}
pre:hover .btn-copy {
opacity: 1;
}
.tooltipped {
position: relative
}
.tooltipped:after {
position: absolute;
z-index: 1000000;
display: none;
padding: 5px 8px;
font: normal normal 11px/1.5 Helvetica, arial, nimbussansl, liberationsans, freesans, clean, sans-serif, "Segoe UI Emoji", "Segoe UI Symbol";
color: #fff;
text-align: center;
text-decoration: none;
text-shadow: none;
text-transform: none;
letter-spacing: normal;
word-wrap: break-word;
white-space: pre;
pointer-events: none;
content: attr(aria-label);
background: rgba(0, 0, 0, 0.8);
border-radius: 3px;
-webkit-font-smoothing: subpixel-antialiased
}
.tooltipped:before {
position: absolute;
z-index: 1000001;
display: none;
width: 0;
height: 0;
color: rgba(0, 0, 0, 0.8);
pointer-events: none;
content: "";
border: 5px solid transparent
}
.tooltipped:hover:before, .tooltipped:hover:after, .tooltipped:active:before, .tooltipped:active:after, .tooltipped:focus:before, .tooltipped:focus:after {
display: inline-block;
text-decoration: none
}
.tooltipped-s:after, .tooltipped-se:after, .tooltipped-sw:after {
top: 100%;
right: 50%;
margin-top: 5px
}
.tooltipped-s:before, .tooltipped-se:before, .tooltipped-sw:before {
top: auto;
right: 50%;
bottom: -5px;
margin-right: -5px;
border-bottom-color: rgba(0, 0, 0, 0.8)
}

@font-family-sans-serif: "Roboto", Helvetica, Arial, sans-serif;

/* For Gitter and GitHub */
.bottom-footer {
margin-bottom: 40px !important; // Make room for Gitter and GitHub buttons
}

.gitter-open-chat-button {
background-color: #3c8dbc;
font-family: @font-family-sans-serif;
letter-spacing: normal;
right: 90px;
}

.gitter-open-chat-button:focus, .gitter-open-chat-button:hover,
.github-button:focus, .github-button:hover,
{
background-color: #4EABDD;
color: #fff;
}

.gitter-chat-embed {
top: 49px;
border-top: 1px solid #000;
z-index: 10000;
}

.github-button {
z-index: 100;
position: fixed;
bottom: 0px;
right: 240px;
padding: 1em 3em;
background-color: #367fa9;
border: 0;
border-top-left-radius: 0.5em;
border-top-right-radius: 0.5em;
font-family: sans-serif;
font-size: 9pt;
text-transform: uppercase;
text-align: center;
text-decoration: none;
cursor: pointer;
cursor: hand;
-webkit-transition: all .3s ease;
transition: all .3s ease;
color: #fff;
a, a:active, a:hover, a:focus {
color: #fff;
}
}
3 changes: 3 additions & 0 deletions docs/input/assets/images/clippy.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions docs/input/assets/js/anchor.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 52c718f

Please sign in to comment.