find-package-json

WebJar for find-package-json

License

License

MIT
Categories

Categories

JSON Data
GroupId

GroupId

org.webjars.npm
ArtifactId

ArtifactId

find-package-json
Last Version

Last Version

1.0.0
Release Date

Release Date

Type

Type

jar
Description

Description

find-package-json
WebJar for find-package-json
Project URL

Project URL

http://webjars.org
Source Code Management

Source Code Management

https://github.com/3rd-Eden/find-package-json

Download find-package-json

How to add to project

<!-- https://jarcasting.com/artifacts/org.webjars.npm/find-package-json/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>find-package-json</artifactId>
    <version>1.0.0</version>
</dependency>
// https://jarcasting.com/artifacts/org.webjars.npm/find-package-json/
implementation 'org.webjars.npm:find-package-json:1.0.0'
// https://jarcasting.com/artifacts/org.webjars.npm/find-package-json/
implementation ("org.webjars.npm:find-package-json:1.0.0")
'org.webjars.npm:find-package-json:jar:1.0.0'
<dependency org="org.webjars.npm" name="find-package-json" rev="1.0.0">
  <artifact name="find-package-json" type="jar" />
</dependency>
@Grapes(
@Grab(group='org.webjars.npm', module='find-package-json', version='1.0.0')
)
libraryDependencies += "org.webjars.npm" % "find-package-json" % "1.0.0"
[org.webjars.npm/find-package-json "1.0.0"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

There are no modules declared in this project.

find-package-json

Easily find package.json files that you're searching for. It spiders parent directories for package.json files and correctly reads the results. It follows an ES6 iterator design so it should be easy to implement.

Installation

The module is released in the public npm registry and can be installed by running:

npm install --save find-package-json

Usage

We expose a single function as module interface. So in all examples we assume that you've already required the code as illustrated in the example below:

'use strict';

var finder = require('find-package-json');

The function accepts 1 optional argument which is the directory it should start searching in or a module object with a filename key. If nothing is provided it will default to process.cwd() as entry point.

As we're build upon the iterator interface you can simply call the .next() function of the returned result to find the first package.json. If you don't like the result, call .next() again to find the next file. Please do note that these methods do synchronous API calls in Node.js so they are blocking.

var f = finder(__dirname);

console.log(f.next().value); // the package.json object
console.log(f.next().filename); // the path to the package.json file

You can also search for the global module object:

var f = finder(module);

console.log(f.next().value); // the package.json object
console.log(f.next().filename); // the path to the package.json file

If there is no more package.json's to be found, the method will set the returned done key as true;

var f = finder(__dirname);

f.next().done // false
f.next().done // true

License

MIT

Versions

Version
1.0.0