get-view

    2.0.0 • Public • Published

    get-view NPM version NPM monthly downloads NPM total downloads Linux Build Status

    Utility for getting an assemble view from a collection object.

    Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your ❤️ and support.

    Install

    Install with npm:

    $ npm install --save get-view

    Usage

    Should work with any collection of vinyl files.

    const getView = require('get-view');

    templates example

    Given the following setup code, all of the below examples would return a view from the app.views.pages collection:

    const templates = require('templates');
    app = templates();
    app.create('page');
     
    app.page('foo', {content: 'this is foo'});
    app.page('bar.md', {content: 'this is bar'});
    app.page('a/b/c/baz.md', {content: 'this is baz', base: 'a'});
    app.page('test/fixtures/templates/a.tmpl');

    Get a view by customizing the lookup key with a function:

    const view = getView(app.views.pages, function(view) {
      return view.stem === 'foo.md';
    });
     
    //=> <View "foo" <Buffer 74 68 69 73 20 69>>

    Get a view by view.path

    const view = getView(app.views.pages, 'a/b/c/baz.md');
    //=> <View "b/c/baz.md" <Buffer 74 68 69 73>>

    Get a view by view.basename

    const view = getView(app.views.pages, 'baz.md');
    //=> <View "b/c/baz.md" <Buffer 74 68 69 73>>

    Get a view by view.filename

    const view = getView(app.views.pages, 'baz');
    //=> <View "b/c/baz.md" <Buffer 74 68 69 73>>

    Get a view by view.relative

    const view = getView(app.views.pages, 'b/c/baz.md');
    //=> <View "b/c/baz.md" <Buffer 74 68 69 73>>

    Release history

    v2.0

    Breaking changes

    • The order of arguments has been reversed, so that the collection of views is passed first, and the lookup value is second.
    • No longer matches with globs. This can be done by passing a glob matcher as the second argument.

    About

    Contributing

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

    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
    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

    Related projects

    You might also be interested in these projects:

    • assemble: Get the rocks out of your socks! Assemble makes you fast at creating web projects… more | homepage
    • gulp: The streaming build system | homepage
    • match-file: Returns true when the given name matches any of the path properties on a vinyl… more | homepage
    • templates: System for creating and managing template collections, and rendering templates with any node.js template engine… more | homepage
    • verb: Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used… more | homepage
    • vinyl: Virtual file format. | homepage

    Author

    Jon Schlinkert

    License

    Copyright © 2018, Jon Schlinkert. Released under the MIT License.


    This file was generated by verb-generate-readme, v0.6.0, on March 18, 2018.

    Install

    npm i get-view

    DownloadsWeekly Downloads

    24,348

    Version

    2.0.0

    License

    MIT

    Unpacked Size

    9.69 kB

    Total Files

    4

    Last publish

    Collaborators

    • avatar