Code Monkey home page Code Monkey logo

update-banner's Introduction

update-banner NPM version NPM monthly downloads NPM total downloads Linux Build Status

Update the banner comment in a string of javascript.

Install

Install with npm:

$ npm install --save update-banner

Usage

In existing banners, copyright statements are updated using update-copyright. If the string does not have a banner one will be added using a template.

var banner = require('update-banner');
var str = fs.readFileSync('index.js', 'utf8');
banner(str);

Pass a custom template and/or data:

var copyright = 'Copyright (c) 2015, Jon Schlinkert.';

console.log(banner('/* <%= copyright %> */\n', {
  copyright: copyright 
}));
//=> '/* Copyright (c) 2015, Jon Schlinkert. */\n'

Options

options.template

Customize the template to use for creating a banner.

Example

This is the default template

/*!
 * <%= name %> <<%= repository %>>
 *
 * <%= copyright %>
 * Released under the <%= license %> License.
 */

About

Related projects

Contributing

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

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Author

Jon Schlinkert

License

Copyright © 2017, Jon Schlinkert. MIT


This file was generated by verb-generate-readme, v0.4.2, on February 01, 2017.

update-banner's People

Contributors

jonschlinkert avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

update-banner's Issues

don't overwrite acknowlegements

not sure how to best fix this. banners are stripped all the time. this basically rips out the banner and generates a new updated banner based on project info. but if the banner has other important info that will be lost...

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.