Update or add a
.editorconfig in the current working directory using a template defined by you in
~/templates, or generic one if a custom template is not defined. This is an Update
updater, which can be run from the command line when Update is installed globally, or used as a building block for creating other updaters.
Table of Contents
- Brass tacks
- Getting started
What is "Update"?
Update is a new, open-source developer framework for automating updates of any kind to code projects. All actual updating is done plugins called "updaters", like this one.
For more information:
- Visit the update project
- Visit the update documentation
- Find updaters on npm (help us author updaters)
What does updater-editorconfig do?
Most updaters do one specific thing. This updater replaces the
.editorconfig file in the current working directory with a template defined by you in
~/templates/_editorconfig (user home on your system).
Or, if you haven't defined a custom template, the file in this project's templates directory will be used.
If you haven't already installed update globally, you can do that now with the following command:
$ npm install --global update
update to your system path, allowing it to be run from any directory.
Install this module with the following command:
$ npm install --global updater-editorconfig
Make sure your work is committed, then run the updater's
default task with the following command:
$ update editorconfig
What will happen?
$ update editorconfig command, this updater's
default task will be executed, which replaces the
.editorconfig file in the cwd with the
~/templates/_editorconfig template defined by you, or the default templates found ing templates/_editorconfig in this repository.
(Note that all dotfile templates are prefixed with
_ to prevent programs from mistaking them as real files)
Visit the documentation for tasks.
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Install dev dependencies:
$ npm install -d && npm test
This file was generated by verb, v0.9.0, on July 21, 2016.