@tunnckocore/update
Update to latest project files and templates, based on
charlike
scaffolder
Please consider following this project's author, Charlike Mike Reagent, and
If you have any how-to kind of questions, please read the Contributing Guide and Code of Conduct documents.
For bugs reports and feature requests, please create an issue or ping
@tunnckoCore at Twitter.
Project is semantically & automatically released on CircleCI with new-release and its New Release GitHub App.
Table of Contents
(TOC generated by verb using markdown-toc)
Install
This project requires Node.js ^8.11.0 || >=10.13.0. Install it using
yarn or npm.
We highly recommend to use Yarn when you think to contribute to this project.
$ 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.
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: All the configs for all the tools, in one place | homepage
- @tunnckocore/create-project: Create and scaffold a new project, its GitHub repository and… more | homepage
- @tunnckocore/package-json: Simple and fast getting of latest package.json metadata for a… more | homepage
- asia: Blazingly fast, magical and minimalist testing framework, for Today and… more | homepage
- docks: Extensible system for parsing and generating documentation. It just freaking… more | homepage
- git-commits-since: Get all commits since given period of time or by… more | homepage
-
gitcommit: Lightweight and joyful
git commit
replacement. Conventional Commits compliant. | homepage
Contributing
Follow the Guidelines
Please read the Contributing Guide and Code of Conduct documents for advices.
For bugs reports and feature requests, please create an issue or ping
@tunnckoCore at Twitter.
Support the project
Become a Partner or Sponsor?
Not financial support? Okey! Pull requests, stars and all kind of contributions are always
welcome.
OPEN Open Source
This project is following OPEN Open Source 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
- Any significant modifications must be subject to a pull request to get feedback from other contributors.
- Pull requests to get feedback are encouraged for any other trivial contributions, but are not required.
- 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 specification.
Don't hesitate to add yourself to that list if you have made any contribution! ;) See how,
here.
Charlike Mike Reagent |
---|
Consider showing your support to them.
License
Copyright (c) 2018-present, Charlike Mike Reagent <mameto2011@gmail.com>
& contributors.
Released under the Apache-2.0 License.