Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tunnckoCoreLabs/update

Update a given repository with latest templates from `charlike`.
https://github.com/tunnckoCoreLabs/update

Last synced: 3 months ago
JSON representation

Update a given repository with latest templates from `charlike`.

Awesome Lists containing this project

README 

        
# @tunnckocore/update [![npm version][npmv-img]][npmv-url] [![github release][ghrelease-img]][ghrelease-url] [![License][license-img]][license-url]



> Update to latest project files and templates, based on `charlike` scaffolder



Please consider following this project's author, [Charlike Mike Reagent](https://github.com/tunnckoCore), and :star: the project to show your :heart: and support.






[![Code style][codestyle-img]][codestyle-url]

[![CircleCI linux build][linuxbuild-img]][linuxbuild-url]

[![CodeCov coverage status][codecoverage-img]][codecoverage-url]

[![DavidDM dependency status][dependencies-img]][dependencies-url]

[![Renovate App Status][renovateapp-img]][renovateapp-url]

[![Make A Pull Request][prs-welcome-img]][prs-welcome-url]

[![Semantically Released][new-release-img]][new-release-url]



If you have any _how-to_ kind of questions, please read the [Contributing Guide](./CONTRIBUTING.md) and [Code of Conduct](./CODE_OF_CONDUCT.md) documents.  

For bugs reports and feature requests, [please create an issue][open-issue-url] or ping

[@tunnckoCore](https://twitter.com/tunnckoCore) at Twitter.



[![Become a Patron][patreon-img]][patreon-url]

[![Conventional Commits][ccommits-img]][ccommits-url]

[![NPM Downloads Weekly][downloads-weekly-img]][npmv-url]

[![NPM Downloads Monthly][downloads-monthly-img]][npmv-url]

[![NPM Downloads Total][downloads-total-img]][npmv-url]

[![Share Love Tweet][shareb]][shareu]



Project is [semantically](https://semver.org) & automatically released on [CircleCI](https://circleci.com) with [new-release][] and its [New Release](https://github.com/apps/new-release) GitHub App.



## Table of Contents



- [Install](#install)

- [CLI](#cli)

- [API](#api)

- [See Also](#see-also)

- [Contributing](#contributing)

  * [Follow the Guidelines](#follow-the-guidelines)

  * [Support the project](#support-the-project)

  * [OPEN Open Source](#open-open-source)

  * [Wonderful Contributors](#wonderful-contributors)

- [License](#license)



_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_



## Install



This project requires [**Node.js**](https://nodejs.org) **^8.11.0 || >=10.13.0**. Install it using

[**yarn**](https://yarnpkg.com) or [**npm**](https://npmjs.com).  

_We highly recommend to use Yarn when you think to contribute to this project._



```bash

$ yarn add --dev @tunnckocore/update

# or globally

$ yarn global add @tunnckocore/update

```



## CLI



Just run `update` or `tunnckocore-update`. It will use latest [charlike][] templates or otherwise templates given through the `--templates / -t` to update your project. Basically all the options and flags from `charlike` are available here too.



Run `update --help` to view this help.



```

  Usage: update [dirName] [flags]



  Common Flags:

    -h, --help                Display this help.

    -v, --version             Display current version.



  Flags:

    -d, --desc                Project description, short for "--project.description".

    -o, --owner               Usually your GitHub username or organization.

    -t, --templates           Source templates directory.

    --engine                  Engine to be used in the template files.

    --locals                  Locals for the template files. Support dot notation.

    --locals.author.name      Project's author name.

    --locals.author.email     Project's author email. And so on.

    --project                 Project metadata like name, description

    --project.name            Project name.

    --project.description     Project description.

    --cwd                     Folder to be used as current working dir.

    --ly                      Shortcut for --locals.license.year (license start year).

    --ln                      Set --locals.license.name.



  Examples:

    update foobar --locals.author.name 'John Snow'

    update foobar --locals.license 'Apache-2.0' --locals.foo bar



  Useful when transferring to another org or user:

    update foobar --owner tunnckoCoreLabs



  Useful when switching license:

    update my-project-dir --ly 2015 --ln MIT

```



## API



_Generated using [docks](http://npm.im/docks)._



**[back to top](#thetop)**



## See Also



Some of these projects are used here or were inspiration for this one, others are just related. So, thanks for your existance!



- [@tunnckocore/config](https://www.npmjs.com/package/@tunnckocore/config): All the configs for all the tools, in one place | [homepage](https://github.com/tunnckoCoreLabs/config "All the configs for all the tools, in one place")

- [@tunnckocore/create-project](https://www.npmjs.com/package/@tunnckocore/create-project): Create and scaffold a new project, its GitHub repository and… [more](https://github.com/tunnckoCoreLabs/create-project) | [homepage](https://github.com/tunnckoCoreLabs/create-project "Create and scaffold a new project, its GitHub repository and contents")

- [@tunnckocore/package-json](https://www.npmjs.com/package/@tunnckocore/package-json): Simple and fast getting of latest package.json metadata for a… [more](https://github.com/tunnckoCoreLabs/package-json) | [homepage](https://github.com/tunnckoCoreLabs/package-json "Simple and fast getting of latest package.json metadata for a npm module, using axios and unpkg as a source, because npm registry is basically slow")

- [asia](https://www.npmjs.com/package/asia): Blazingly fast, magical and minimalist testing framework, for Today and… [more](https://github.com/olstenlarck/asia#readme) | [homepage](https://github.com/olstenlarck/asia#readme "Blazingly fast, magical and minimalist testing framework, for Today and Tomorrow")

- [docks](https://www.npmjs.com/package/docks): Extensible system for parsing and generating documentation. It just freaking… [more](https://github.com/tunnckoCore/docks) | [homepage](https://github.com/tunnckoCore/docks "Extensible system for parsing and generating documentation. It just freaking works!")

- [git-commits-since](https://www.npmjs.com/package/git-commits-since): Get all commits since given period of time or by… [more](https://github.com/tunnckoCoreLabs/git-commits-since) | [homepage](https://github.com/tunnckoCoreLabs/git-commits-since "Get all commits since given period of time or by default from latest git semver tag. Understands and follows both SemVer and the Conventional Commits specification.")

- [gitcommit](https://www.npmjs.com/package/gitcommit): Lightweight and joyful `git commit` replacement. Conventional Commits compliant. | [homepage](https://github.com/tunnckoCore/gitcommit "Lightweight and joyful `git commit` replacement. Conventional Commits compliant.")



**[back to top](#thetop)**



## Contributing



### Follow the Guidelines



Please read the [Contributing Guide](./CONTRIBUTING.md) and [Code of Conduct](./CODE_OF_CONDUCT.md) documents for advices.  

For bugs reports and feature requests, [please create an issue][open-issue-url] or ping

[@tunnckoCore](https://twitter.com/tunnckoCore) at Twitter.



### Support the project



[Become a Partner or Sponsor?][patreon-url] :dollar: Check the **Partner**, **Sponsor** or **Omega-level** tiers! :tada: You can get your company logo, link & name on this file. It's also rendered on package page in [npmjs.com][npmv-url] and [yarnpkg.com](https://yarnpkg.com/en/package/@tunnckocore/update) sites too! :rocket:



Not financial support? Okey! [Pull requests](https://github.com/tunnckoCoreLabs/contributing#opening-a-pull-request), stars and all kind of [contributions](https://opensource.guide/how-to-contribute/#what-it-means-to-contribute) are always

welcome. :sparkles:



### OPEN Open Source



This project is following [OPEN Open Source](http://openopensource.org) model



> Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit. This project is built on collective efforts and it's not strongly guarded by its founders.



There are a few basic ground-rules for its contributors



1. Any **significant modifications** must be subject to a pull request to get feedback from other contributors.

2. [Pull requests](https://github.com/tunnckoCoreLabs/contributing#opening-a-pull-request) to get feedback are _encouraged_ for any other trivial contributions, but are not required.

3. Contributors should attempt to adhere to the prevailing code-style and development workflow.



### Wonderful Contributors



Thanks to the hard work of these wonderful people this project is alive! It follows the

[all-contributors](https://github.com/kentcdodds/all-contributors) specification.  

Don't hesitate to add yourself to that list if you have made any contribution! ;) [See how,

here](https://github.com/jfmengels/all-contributors-cli#usage).



| [
Charlike Mike Reagent](https://tunnckocore.com)
[💻](https://github.com/tunnckoCoreLabs/update/commits?author=tunnckoCore "Code") [📖](https://github.com/tunnckoCoreLabs/update/commits?author=tunnckoCore "Documentation") [💬](#question-tunnckoCore "Answering Questions") [👀](#review-tunnckoCore "Reviewed Pull Requests") [🔍](#fundingFinding-tunnckoCore "Funding Finding") |

| :---: |



Consider showing your [support](#support-the-project) to them. :sparkling_heart:



## License



Copyright (c) 2018-present, [Charlike Mike Reagent](https://tunnckocore.com) `` & [contributors](#wonderful-contributors).  

Released under the [Apache-2.0 License][license-url].



[npmv-url]: https://www.npmjs.com/package/@tunnckocore/update

[npmv-img]: https://badgen.net/npm/v/@tunnckocore/update?icon=npm



[ghrelease-url]: https://github.com/tunnckoCoreLabs/update/releases/latest

[ghrelease-img]: https://badgen.net/github/release/tunnckoCoreLabs/update?icon=github



[license-url]: https://github.com/tunnckoCoreLabs/update/blob/master/LICENSE

[license-img]: https://badgen.net/npm/license/@tunnckocore/update



[codestyle-url]: https://github.com/airbnb/javascript

[codestyle-img]: https://badgen.net/badge/code%20style/airbnb/ff5a5f?icon=airbnb



[linuxbuild-url]: https://circleci.com/gh/tunnckoCoreLabs/update/tree/master

[linuxbuild-img]: https://badgen.net/circleci/github/tunnckoCoreLabs/update/master?label=build&icon=circleci



[codecoverage-url]: https://codecov.io/gh/tunnckoCoreLabs/update

[codecoverage-img]: https://badgen.net/codecov/c/github/tunnckoCoreLabs/update?icon=codecov



[dependencies-url]: https://david-dm.org/tunnckoCoreLabs/update

[dependencies-img]: https://badgen.net/david/dep/tunnckoCoreLabs/update?label=deps



[ccommits-url]: https://conventionalcommits.org/

[ccommits-img]: https://badgen.net/badge/conventional%20commits/v1.0.0/dfb317

[new-release-url]: https://ghub.io/new-release

[new-release-img]: https://badgen.net/badge/semantically/released/05c5ff



[downloads-weekly-img]: https://badgen.net/npm/dw/@tunnckocore/update

[downloads-monthly-img]: https://badgen.net/npm/dm/@tunnckocore/update

[downloads-total-img]: https://badgen.net/npm/dt/@tunnckocore/update



[renovateapp-url]: https://renovatebot.com

[renovateapp-img]: https://badgen.net/badge/renovate/enabled/green

[prs-welcome-img]: https://badgen.net/badge/PRs/welcome/green

[prs-welcome-url]: http://makeapullrequest.com

[paypal-donate-url]: https://paypal.me/tunnckoCore/10

[paypal-donate-img]: https://badgen.net/badge/$/support/purple

[patreon-url]: https://www.patreon.com/bePatron?u=5579781

[patreon-img]: https://badgen.net/badge/patreon/tunnckoCore/F96854?icon=patreon

[patreon-sponsor-img]: https://badgen.net/badge/become/a%20sponsor/F96854?icon=patreon



[shareu]: https://twitter.com/intent/tweet?text=https://github.com/tunnckoCoreLabs/update&via=tunnckoCore

[shareb]: https://badgen.net/badge/twitter/share/1da1f2?icon=twitter

[open-issue-url]: https://github.com/tunnckoCoreLabs/update/issues/new



[charlike]: https://github.com/tunnckoCoreLabs/charlike

[new-release]: https://github.com/tunnckoCore/new-release

[semantic-release]: https://github.com/semantic-release/semantic-release