Giter VIP home page Giter VIP logo

multiline-string's Introduction

Build Status Coverage Status

multiline-string

Remove leading space characters to let you nicely indent your multiline strings in your code.

Prerequisite

  • Node v4+

Usage

By default, multiline detects indentation by looking at the first non-empty line. Notice that the first empty line is dropped from the output to let you to start the first line with the indentation level you like.

const multiline = require('multiline-string')()

const s = multiline(`
            1. xxx
              a. yyy
            2. zzz
            `)

console.log(s)
// => "1. xxx\n  a. yyy\n2. zzz"

If you want to start your string with an empty line, you can do:

const s = multiline(`

            Line 1
            Line 2
            `)
// => "\nLine 1\nLine 2\n"

You can also give marginMark to identify the start of each line to include indentation in the resulting text.

const multiline = require('multiline-string')({ marginMark: '|' })

const s = multiline(`
            |  Usage: my-command file
            |
            |    -v, --version    Show version
            |    -h, --help       Show help information
            |`)

console.log(s)
// => "  Usage: ...\n\n    -v, --version ..."

multiline-string's People

Contributors

dependabot[bot] avatar fersilva16 avatar ryu1kn avatar

Stargazers

 avatar

Watchers

 avatar

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.