Wondering what’s next for npm?Check out our public roadmap! »

gulp-paths-injector

0.2.0 • Public • Published

Build Status npm version

Gulp plugin for including paths to scripts, bower scripts and styles by passed glob into HTML automatically.
Inspired by gulp-include-source, but this module more extensible and asynchronous (except bower injecting - it's doing by main-bower-files plugin. Maybe you want do this asynchronous too? Create pull request for it)!

Install

Install with npm

npm install gulp-paths-injector --save-dev

Usage examples

API

injector(options)

Returns instance of injector.

options.cwd

Type: String
Default: gulp.src(file)

Base directory from where the plugin will search for source files.

options.removePlaceholder

Type: Boolean
Default: false

Remove <!-- inject:js:bower --><!-- endinject --> placeholders in result HTML or not.

options.host

Type: String
Default: ''

You can set host prefix for files by passing this option. For example you can you it for set CDN hosts.

options.templates

Type: Object
Default:

{
    js: '<script src="%path%"></script>',
    css: '<link rel="stylesheet" href="%path%">'
}

You can set own templates for each type, for including path use %path placeholder.

options.mainBowerFiles

Type: Object
Default: {}

If you want pass custom options to main-bower-files plugin you can use this option.

injector.inject()

Return type: Stream
Resolve all injections in passed template and return handled template.

injector.src(templateType, name)

Return type: Stream
Returns stream of files matched to globs filtered by passed templateType and name params

injector.getGlobs(pathToTemplate, templateType, name)

Return type: Promise

Contributing

  • Code must follow .jscsrc and .jshintrc rules. Setup your code editor for use it code style rules.
  • You should test code: npm test or npm run dev for development mode (run tests with watchers). If you want add feature - you must add tests for it.

License

MIT © Pavel Grinchenko

Install

npm i gulp-paths-injector

DownloadsWeekly Downloads

2

Version

0.2.0

License

MIT

Last publish

Collaborators

  • avatar