Noosphere Possibilities Maximized

    updater-editorconfig

    0.2.0 • Public • Published

    updater-editorconfig NPM version NPM downloads Build Status

    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

    (TOC generated by verb using markdown-toc)

    Brass tacks

    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.

    Updaters can be run from the command line when Update's CLI is installed globally, or they can be used as building blocks for creating other updaters.

    For more information:

    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.

    Getting started

    Install

    Install update

    If you haven't already installed update globally, you can do that now with the following command:

    $ npm install --global update

    This adds update to your system path, allowing it to be run from any directory.

    Install updater-editorconfig

    Install this module with the following command:

    $ npm install --global updater-editorconfig

    Usage

    Make sure your work is committed, then run the updater's default task with the following command:

    $ update editorconfig

    What will happen?

    Upon running $ 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)

    Tasks

    Visit the documentation for tasks.

    About

    Related projects

    update: Be scalable! Update is a new, open source developer framework and CLI for automating updates… more | homepage

    Contributing

    Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

    Running tests

    Install dev dependencies:

    $ npm install -d && npm test

    Author

    Jon Schlinkert

    License

    Copyright © 2016, Jon Schlinkert. Released under the MIT license.


    This file was generated by verb, v0.9.0, on July 21, 2016.

    Install

    npm i updater-editorconfig

    DownloadsWeekly Downloads

    2

    Version

    0.2.0

    License

    MIT

    Last publish

    Collaborators

    • avatar