npmpackage.info

Gathering detailed insights and metrics for gulp-require-index

gulp-require-index - 0.1.1 | npmpackage.info

gulp-require-index

Generate a index.js file that is exporting all the specified files

0.1.1

JavaScript

8.10 kB

1.3

Installations

npm install gulp-require-index

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

10.15.3

NPM Version

6.9.0 Score

68.6

Supply Chain

81.4

Quality

72.9

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

11

Total

12

Closed

1

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Languages

JavaScript

JavaScript (100%)

Developer

kevthunder

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

8 Commits

12 Branches

1 Contributors

Updated on Aug 28, 2019

Maintainers

View All 1 Contributors

Package Meta Information

Latest Version

0.1.1

Package Id

gulp-require-index@0.1.1

Unpacked Size

8.10 kB

Size

2.83 kB

File Count

NPM Version

6.9.0

Node Version

10.15.3

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

slash through2 vinyl

Dev Dependencies

chai chai-fs eslint eslint-config-standard eslint-plugin-import eslint-plugin-mocha eslint-plugin-node eslint-plugin-promise eslint-plugin-standard gulp mocha rimraf

gulp-require-index

Installation

Install package with NPM and add it to your development dependencies:

1npm install gulp-require-index --save-dev

You can install it directly from github:

1npm install kevthunder/gulp-require-index --save-dev

Usage

1var requireIndex = require('gulp-require-index');
2
3gulp.task('html:buildIndex', function() {
4  return gulp.src('./lib/**/*.js')
5    .pipe(requireIndex())
6    .pipe(gulp.dest('./'));
7});

This will generate a index.js from the files found in ./lib and output something similar to :

1module.exports = {
2  "Bar": require("./lib/Bar").Bar,
3  "Foo": require("./lib/Foo"),
4  "folder": {
5    "Baz": require("./lib/folder/Baz").Baz,
6    "Hi": require("./lib/folder/Hi").Hi,
7    "sub": {
8      "Hey": require("./lib/folder/sub/Hey").Hey,
9    },
10  },
11}

options

Some options can be specified, the default are:

1  // the name of the file generated
2  name: 'index.js',
3  // the destination for the generated file (used for the relative path)
4  dest: null,
5  // set to true to have the definitions on the root level instead of nested
6  flat: false

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

0

SAST

Determines if the project uses static code analysis.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

License

Determines if the project has defined a license.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

1.3

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More