-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 0d6a818
Showing
10 changed files
with
436 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# http://editorconfig.org | ||
root = true | ||
|
||
[*] | ||
indent_style = space | ||
end_of_line = lf | ||
charset = utf-8 | ||
indent_size = 2 | ||
trim_trailing_whitespace = true | ||
insert_final_newline = true | ||
|
||
[*.md] | ||
trim_trailing_whitespace = false | ||
insert_final_newline = false | ||
|
||
[{,test/}{actual,fixtures}/**] | ||
trim_trailing_whitespace = false | ||
insert_final_newline = false | ||
|
||
[templates/**] | ||
trim_trailing_whitespace = false | ||
insert_final_newline = false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,122 @@ | ||
{ | ||
"ecmaFeatures": { | ||
"modules": true, | ||
"experimentalObjectRestSpread": true | ||
}, | ||
|
||
"env": { | ||
"browser": false, | ||
"es6": true, | ||
"node": true, | ||
"mocha": true | ||
}, | ||
|
||
"globals": { | ||
"document": false, | ||
"navigator": false, | ||
"window": false | ||
}, | ||
|
||
"rules": { | ||
"accessor-pairs": 2, | ||
"arrow-spacing": [2, { "before": true, "after": true }], | ||
"block-spacing": [2, "always"], | ||
"brace-style": [2, "1tbs", { "allowSingleLine": true }], | ||
"comma-dangle": [2, "never"], | ||
"comma-spacing": [2, { "before": false, "after": true }], | ||
"comma-style": [2, "last"], | ||
"constructor-super": 2, | ||
"curly": [2, "multi-line"], | ||
"dot-location": [2, "property"], | ||
"eol-last": 2, | ||
"eqeqeq": [2, "allow-null"], | ||
"generator-star-spacing": [2, { "before": true, "after": true }], | ||
"handle-callback-err": [2, "^(err|error)$" ], | ||
"indent": [2, 2, { "SwitchCase": 1 }], | ||
"key-spacing": [2, { "beforeColon": false, "afterColon": true }], | ||
"keyword-spacing": [2, { "before": true, "after": true }], | ||
"new-cap": [2, { "newIsCap": true, "capIsNew": false }], | ||
"new-parens": 2, | ||
"no-array-constructor": 2, | ||
"no-caller": 2, | ||
"no-class-assign": 2, | ||
"no-cond-assign": 2, | ||
"no-const-assign": 2, | ||
"no-control-regex": 2, | ||
"no-debugger": 2, | ||
"no-delete-var": 2, | ||
"no-dupe-args": 2, | ||
"no-dupe-class-members": 2, | ||
"no-dupe-keys": 2, | ||
"no-duplicate-case": 2, | ||
"no-empty-character-class": 2, | ||
"no-eval": 2, | ||
"no-ex-assign": 2, | ||
"no-extend-native": 2, | ||
"no-extra-bind": 2, | ||
"no-extra-boolean-cast": 2, | ||
"no-extra-parens": [2, "functions"], | ||
"no-fallthrough": 2, | ||
"no-floating-decimal": 2, | ||
"no-func-assign": 2, | ||
"no-implied-eval": 2, | ||
"no-inner-declarations": [2, "functions"], | ||
"no-invalid-regexp": 2, | ||
"no-irregular-whitespace": 2, | ||
"no-iterator": 2, | ||
"no-label-var": 2, | ||
"no-labels": 2, | ||
"no-lone-blocks": 2, | ||
"no-mixed-spaces-and-tabs": 2, | ||
"no-multi-spaces": 2, | ||
"no-multi-str": 2, | ||
"no-multiple-empty-lines": [2, { "max": 1 }], | ||
"no-native-reassign": 0, | ||
"no-negated-in-lhs": 2, | ||
"no-new": 2, | ||
"no-new-func": 2, | ||
"no-new-object": 2, | ||
"no-new-require": 2, | ||
"no-new-wrappers": 2, | ||
"no-obj-calls": 2, | ||
"no-octal": 2, | ||
"no-octal-escape": 2, | ||
"no-proto": 0, | ||
"no-redeclare": 2, | ||
"no-regex-spaces": 2, | ||
"no-return-assign": 2, | ||
"no-self-compare": 2, | ||
"no-sequences": 2, | ||
"no-shadow-restricted-names": 2, | ||
"no-spaced-func": 2, | ||
"no-sparse-arrays": 2, | ||
"no-this-before-super": 2, | ||
"no-throw-literal": 2, | ||
"no-trailing-spaces": 0, | ||
"no-undef": 2, | ||
"no-undef-init": 2, | ||
"no-unexpected-multiline": 2, | ||
"no-unneeded-ternary": [2, { "defaultAssignment": false }], | ||
"no-unreachable": 2, | ||
"no-unused-vars": [2, { "vars": "all", "args": "none" }], | ||
"no-useless-call": 0, | ||
"no-with": 2, | ||
"one-var": [0, { "initialized": "never" }], | ||
"operator-linebreak": [0, "after", { "overrides": { "?": "before", ":": "before" } }], | ||
"padded-blocks": [0, "never"], | ||
"quotes": [2, "single", "avoid-escape"], | ||
"radix": 2, | ||
"semi": [2, "always"], | ||
"semi-spacing": [2, { "before": false, "after": true }], | ||
"space-before-blocks": [2, "always"], | ||
"space-before-function-paren": [2, "never"], | ||
"space-in-parens": [2, "never"], | ||
"space-infix-ops": 2, | ||
"space-unary-ops": [2, { "words": true, "nonwords": false }], | ||
"spaced-comment": [0, "always", { "markers": ["global", "globals", "eslint", "eslint-disable", "*package", "!", ","] }], | ||
"use-isnan": 2, | ||
"valid-typeof": 2, | ||
"wrap-iife": [2, "any"], | ||
"yoda": [2, "never"] | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# Enforce Unix newlines | ||
* text eol=lf | ||
|
||
# binaries | ||
*.ai binary | ||
*.psd binary | ||
*.jpg binary | ||
*.gif binary | ||
*.png binary | ||
*.jpeg binary |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
*.DS_Store | ||
*.sublime-* | ||
_gh_pages | ||
bower_components | ||
node_modules | ||
npm-debug.log | ||
actual | ||
test/actual | ||
temp | ||
tmp | ||
TODO.md | ||
vendor | ||
.idea | ||
benchmark | ||
coverage |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
--- | ||
toc: false | ||
--- | ||
## What is "Update"? | ||
|
||
Update is a new, open-source developer framework for automating updates of any kind to code projects. For more information: | ||
|
||
- Visit the [update project](https://github.com/update/update) | ||
- Visit the [update documentation](https://github.com/update/update) | ||
- Find [updaters on npm](https://www.npmjs.com/browse/keyword/update-updater) (help us [author updaters](https://github.com/update/update/blob/master/docs/updaters.md)) | ||
|
||
## Install | ||
|
||
**Install update** | ||
|
||
If you haven't already installed [update][] globally, you can do that now with the following command: | ||
|
||
```sh | ||
$ npm i -g update | ||
``` | ||
|
||
**Install updater-example** | ||
|
||
Then install this module: | ||
|
||
```sh | ||
$ npm i -g update-example | ||
``` | ||
|
||
## Usage | ||
|
||
Add a file named `example.txt` to the current working directory, then run the updater with the following command: | ||
|
||
```sh | ||
$ update example | ||
``` | ||
|
||
**What will happen?** | ||
|
||
This updater will only modify a file named `example.txt` in the current working directory. By default it just adds the string `foo`. | ||
|
||
Try the following steps to get familiarized with how update works: | ||
|
||
- [ ] run `update example` to execute the default task, which will append the string `foo` to the file's contents. | ||
- [ ] run `update example:foo` to execute the `foo` task, appending the string `foo` to the file's contents | ||
- [ ] run `update example:bar` to execute the `bar` task, appending the string `bar` to the file's contents | ||
- [ ] run `update example.abc` to execute the default task on the `abc` (sub-)updater, appending the string `abc:one` to the file's contents | ||
- [ ] run `update example.abc:one` to execute the `one` task on the `abc` (sub-)updater, appending the string `abc:one` to the file's contents | ||
|
||
See [the code](updatefile.js) for more details. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
The MIT License (MIT) | ||
|
||
Copyright (c) 2015-2016, Jon Schlinkert | ||
|
||
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: | ||
|
||
The above copyright notice and this permission notice shall be included in | ||
all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
THE SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,87 @@ | ||
# updater-example [![NPM version](https://img.shields.io/npm/v/updater-example.svg?style=flat)](https://www.npmjs.com/package/updater-example) [![NPM downloads](https://img.shields.io/npm/dm/updater-example.svg?style=flat)](https://npmjs.org/package/updater-example) | ||
|
||
Example updater. Very basic demonstration of how updaters work. | ||
|
||
## What is "Update"? | ||
|
||
Update is a new, open-source developer framework for automating updates of any kind to code projects. For more information: | ||
|
||
* Visit the [update project](https://github.com/update/update) | ||
* Visit the [update documentation](https://github.com/update/update) | ||
* Find [updaters on npm](https://www.npmjs.com/browse/keyword/update-updater) (help us [author updaters](https://github.com/update/update/blob/master/docs/updaters.md)) | ||
|
||
## Install | ||
|
||
**Install update** | ||
|
||
If you haven't already installed [update](https://github.com/update/update) globally, you can do that now with the following command: | ||
|
||
```sh | ||
$ npm i -g update | ||
``` | ||
|
||
**Install updater-example** | ||
|
||
Then install this module: | ||
|
||
```sh | ||
$ npm i -g update-example | ||
``` | ||
|
||
## Usage | ||
|
||
Add a file named `example.txt` to the current working directory, then run the updater with the following command: | ||
|
||
```sh | ||
$ update example | ||
``` | ||
|
||
**What will happen?** | ||
|
||
This updater will only modify a file named `example.txt` in the current working directory. By default it just adds the string `foo`. | ||
|
||
Try the following steps to get familiarized with how update works: | ||
|
||
* [ ] run `update example` to execute the default task, which will append the string `foo` to the file's contents. | ||
* [ ] run `update example:foo` to execute the `foo` task, appending the string `foo` to the file's contents | ||
* [ ] run `update example:bar` to execute the `bar` task, appending the string `bar` to the file's contents | ||
* [ ] run `update example.abc` to execute the default task on the `abc` (sub-)updater, appending the string `abc:one` to the file's contents | ||
* [ ] run `update example.abc:one` to execute the `one` task on the `abc` (sub-)updater, appending the string `abc:one` to the file's contents | ||
|
||
See [the code](updatefile.js) for more details. | ||
|
||
## Related projects | ||
|
||
You might also be interested in these projects: | ||
|
||
* [generate](https://www.npmjs.com/package/generate): The Santa Claus machine for GitHub projects. Scaffolds out new projects, or creates any kind… [more](https://github.com/generate/generate) | [homepage](https://github.com/generate/generate "The Santa Claus machine for GitHub projects. Scaffolds out new projects, or creates any kind of required file or document from any given templates or source materials.") | ||
* [update](https://www.npmjs.com/package/update): Easily keep anything in your project up-to-date by installing the updaters you want to use… [more](https://github.com/update/update) | [homepage](https://github.com/update/update "Easily keep anything in your project up-to-date by installing the updaters you want to use and running `update` in the command line! Update the copyright date, licence type, ensure that a project uses your latest eslint or jshint configuration, remove dep") | ||
* [verb](https://www.npmjs.com/package/verb): Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used… [more](https://github.com/verbose/verb) | [homepage](https://github.com/verbose/verb "Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used on hundreds of projects of all sizes to generate everything from API docs to readmes.") | ||
|
||
## Contributing | ||
|
||
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new). | ||
|
||
## Running tests | ||
|
||
Install dev dependencies: | ||
|
||
```sh | ||
$ npm install -d && npm test | ||
``` | ||
|
||
## Author | ||
|
||
**Jon Schlinkert** | ||
|
||
* [github/jonschlinkert](https://github.com/jonschlinkert) | ||
* [twitter/jonschlinkert](http://twitter.com/jonschlinkert) | ||
|
||
## License | ||
|
||
Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert). | ||
Released under the [MIT license](https://github.com/update/updater-example/blob/master/LICENSE). | ||
|
||
*** | ||
|
||
_This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on June 28, 2016._ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
module.exports = require('./updatefile'); |
Oops, something went wrong.