Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/orienteerbap/jnpm
Native Java API to work with JavaScript Node Package Manager (NPM): query, retrieve, pack into jar (webjars), CDN
https://github.com/orienteerbap/jnpm
artifact frontend java npm resources
Last synced: about 2 months ago
JSON representation
Native Java API to work with JavaScript Node Package Manager (NPM): query, retrieve, pack into jar (webjars), CDN
- Host: GitHub
- URL: https://github.com/orienteerbap/jnpm
- Owner: OrienteerBAP
- License: apache-2.0
- Created: 2020-05-10T04:49:05.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-07-15T08:34:41.000Z (6 months ago)
- Last Synced: 2024-12-01T01:48:23.634Z (about 2 months ago)
- Topics: artifact, frontend, java, npm, resources
- Language: Java
- Homepage:
- Size: 173 KB
- Stars: 20
- Watchers: 3
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/OrienteerBAP/JNPM) [](https://javadoc.io/doc/org.orienteer.jnpm/jnpm)
# JNPM
Native Java API to work with JavaScript Node Package Manager (NPM): query, retrieve, pack into jar (webjars), CDN
1. [Java API](#java-api)
2. [Command Line Interface](#command-line-interface)
3. [Maven Plugin](#maven-plugin) (lightweight and fast replacement for [frontend-maven-plugin](https://github.com/eirslett/frontend-maven-plugin), [npm-maven-plugin](https://github.com/jy4618272/npm-maven-plugin) and even [WebJars](https://www.webjars.org/))
4. [Make your CDN](#cdn)
* [Servlet](#servlet)
* [Apache Wicket](#apache-wicket)
## Java API
Include JNPM Jar into pom.xml:
```xml
org.orienteer.jnpm
jnpm
LATEST JNPM VERSION
```
Initialize JNPM API prior to use.
```java
JNPMService.configure(JNPMSettings.builder()
.homeDirectory(Paths.get("/home/myuser/.jnpm")) //Optional
.downloadDirectory(Paths.get("/tmp")) //Optional
//Other optional configurations: see JavaDoc for more info
.build());
```
JNPM API has 2 options: **Synchronous API** and **RXJava API**. Please use required one per your needs:
```java
JNPMService jnpmService = JNPMService.instance(); //Synchronous Java API
RxJNPMService rxJnpmService = JNPMService.instance().getRxService() //RXJava API
```
Examples of API use:
```java
//Print NPM Registry Information
System.out.println(JNPMService.instance().getRegistryInfo());
//Retrieve and print VUE package latest version
System.out.println(JNPMService.instance().getPackageInfo("vue").getLatest());
//Print package description for [email protected]
System.out.println(JNPMService.instance().getVersionInfo("vue", "2.6.11").getDescription());
//Print latest version prior to vue version 2 official release
System.out.println(JNPMService.instance().bestMatch("vue@<2").getVersionAsString());
//Download tarball for [email protected] and print localpath
VersionInfo vueVersion = JNPMService.instance().getVersionInfo("vue", "2.6.11");
vueVersion.downloadTarball().blockingAwait();
System.out.println(vueVersion.getLocalTarball().getAbsolutePath());
//Search for "vue" and print description for first result
System.out.println(JNPMService.instance().search("vue").getObjects().get(0).getSearchPackage().getDescription());
//Traverse through all dev dependencies of latest vue package, print information
// and install as NPM do (node_modules/vue and etc)
JNPMService.instance().getRxService()
.traverse(TraverseDirection.WIDER, TraversalRule.DEV_DEPENDENCIES, "vue")
.subscribe(t -> {System.out.println(t); t.install(Paths.get("target", "readme"), InstallationStrategy.NPM);});
```
Read [](https://javadoc.io/doc/org.orienteer.jnpm/jnpm) for more information.
## Command Line Interface
```
Usage: jnpm [-hV] [--download-dir=]
[--home-dir=] [--install-dir=]
[-P=] [--registry=] [-U=] [COMMAND]
Java implementation of Node Package Manager
--download-dir=
Cache directory for JNPM to download packages to (default:
/cache/)
-f, --force Force to fetch remote resources even if a local copy exists on disk
-h, --help Show this help message and exit.
--home-dir=
Home directory for JNPM (default: C:\Users\naryzhny\.jnpm)
--install-dir=
Global install directory for JNPM (default:
/node_modules/)
-L, --http-logger-level
HTTP Logger Level for debugging
Valid values: NONE, BASIC, HEADERS, BODY
-P, --password=
Password for authentication (optional)
--registry=
NPM registry URL to be used for package lookup and retrieval
(default: http://registry.npmjs.org/)
-U, --username=
Username for authentication (optional)
-V, --version Print version information and exit.
Commands:
download, d Download packages into local cache
extract, e Extract packages: very similiar to 'npm install', but without
changing package.json modification
```
```
Usage: jnpm download [-h] [--[no-]dev] [--[no-]download] [--[no-]optional] [--
[no-]peer] [--[no-]prod] ...
Download packages into local cache
...
Packages to be retrieved
--[no-]dev Download dev dependencies
--[no-]download Download by default. Negate if just attempt to lookup
is needed
-h, --help
--[no-]optional Download optional dependencies
--[no-]peer Download peer dependencies
--[no-]prod Download dependencies (default)
```
```
Usage: jnpm extract [-gh] [--[no-]dev] [--[no-]download] [--[no-]optional] [--
[no-]peer] [--[no-]prod] [-o=] [-s=]
...
Extract packages: very similiar to 'npm install', but without changing package.
json modification
...
Packages to be retrieved
--[no-]dev Download dev dependencies
--[no-]download Download by default. Negate if just attempt to
lookup is needed
-g Extract package(s) globally
-h, --help
-o, --output= Output folder to extract to
--[no-]optional Download optional dependencies
--[no-]peer Download peer dependencies
--[no-]prod Download dependencies (default)
-s, --strategy=
Strategy for extraction: FLAT, NPM, SIMPLE,
SIMPLE_VERSIONED, WEBJARS, ONE_DUMP, DIST
```
## Maven Plugin
JNPM maven plugin allows you natively integrate NPM resources into your build process.
For example, you can download and pack JS packages inside your WAR to use later through WebJars extensions.
To include `vue` and into your WAR please add the following into build>plugins section of your `pom.xml`
```xml
org.orienteer.jnpm
jnpm-maven-plugin
${LATEST_JNPM_VERSION}
install
[email protected]
vuex@~3.4.0
```
More details about the plugin:
```
jnpm:install
Goal to download, extract and attach npm resources
Available parameters:
attachResources (Default: true)
Attach downloaded resources to the build process
excludes
What has to be excluded from resources to be attached
getDev (Default: false)
Download development dependencies
getOptional (Default: false)
Download optional dependencies
getPeer (Default: false)
Download peer dependencies
getProd (Default: false)
Download direct dependencies
httpLoggerLevel (Default: NONE)
HTTP Logger Level for debugging
includes
What should be included as resources (Default: empty - means everything)
outputDirectory (Default: ${project.build.directory}/jnpm/)
Location of the output directory
Required: Yes
packages
NPM packages to be downloaded and extracted (For example: [email protected])
Required: Yes
password
Password for authentication (optional)
pathPrefix
Prefix for the directory under outputDirectory to which files will be
placed
registryUrl (Default: http://registry.npmjs.org/)
NPM registry URL to be used for package lookup and retrieval
serverId
Server id from settings to get username and password from
strategy (Default: WEBJARS)
Installation strategy to be used
useCache (Default: true)
Use local cache. Useful if the same package version can be re-uploaded to a registry
username
Username for authentication (optional)
```
## CDN
### Servlet
Add the following mapping to your `web.xml`. Adjust as needed:
```xml
CDNServlet
org.orienteer.jnpm.cdn.CDNServlet
CDNServlet
/cdn/*
```
Files from NPM packages will be available through URLs with the following pattern: `http(s)://://cdn//`.
For example: `http://localhost:8080/cdn/[email protected]/dist/vue.js`
You can user `init-param` to specify extra JNPM parameters, for example, `registryUrl`, `username`, `password` and etc.
### Apache Wicket
Add the following code to your [Apache Wicket](https://wicket.apache.org/) WebApplication:
```java
if(!JNPMService.isConfigured())
JNPMService.configure(JNPMSettings.builder().build()); //Configure as you wish
CDNWicketResource.mount(this, "/cdn");
```
Files from NPM packages will be available through URLs with the following pattern: `http(s)://://cdn//`.
For example: `http://localhost:8080/cdn/[email protected]/dist/vue.js`