npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

wp-get-file-data

v1.0.0

Published

Get WordPress file information from NodeJS.

Downloads

3

Readme

wp-get-file-data

Get WordPress file information from NodeJS.

Port of WordPress get_file_data.

Installation

> npm install https://github.com/dkfiresky-wp/wp-get-file-data.git

Usage

Plugin data


const fileData = require( 'wp-get-file-data' );

fileData( '/wordpress/wp-content/plugins/akismet/akismet.php', {
	'Name': 'Plugin Name',
	'PluginURI': 'Plugin URI',
	'Version': 'Version',
	'Description': 'Description',
	'Author': 'Author',
	'AuthorURI': 'Author URI',
	'TextDomain': 'Text Domain',
	'DomainPath': 'Domain Path',
	'Network': 'Network'
}, ( error, result ) => {
	if ( null !== error) throw error;
	console.log( result );
} );
// The above will provide information like:
{
	Name: 'Akismet',
	PluginURI: 'https://akismet.com/',
	Version: '3.1.11',
	Description: 'Used by millions, Akismet is quite possibly the best way in the world to <strong>protect your blog from spam</strong>. It keeps your site protected even while you sleep. To get started: 1) Click the "Activate" link to the left of this description, 2) <a href="https://akismet.com/get/">Sign up for an Akismet plan</a> to get an API key, and 3) Go to your Akismet configuration page, and save your API key.',
	Author: 'Automattic',
	AuthorURI: 'https://automattic.com/wordpress-plugins/',
	TextDomain: 'akismet',
	DomainPath: '',
	Network: ''
}

Theme data


const fileData = require( 'wp-get-file-data' );

fileData( '/wordpress/wp-content/themes/twentysixteen/style.css', {
	'Name': 'Theme Name',
	'ThemeURI': 'Theme URI',
	'Description': 'Description',
	'Author': 'Author',
	'AuthorURI': 'Author URI',
	'Version': 'Version',
	'Template': 'Template',
	'Status': 'Status',
	'Tags': 'Tags',
	'TextDomain': 'Text Domain',
	'DomainPath': 'Domain Path',
}, ( error, result ) => {
	if ( null !== error) throw error;
	console.log( result );
} );
// The above will provide information like:
{
	Name: 'Twenty Sixteen',
	ThemeURI: 'https://wordpress.org/themes/twentysixteen/',
	Description: 'Twenty Sixteen is a modernized take on an ever-popular WordPress layout — the horizontal masthead with an optional right sidebar that works perfectly for blogs and websites. It has custom color options with beautiful default color schemes, a harmonious fluid grid using a mobile-first approach, and impeccable polish in every detail. Twenty Sixteen will make your WordPress look beautiful everywhere.',
	Author: 'the WordPress team',
	AuthorURI: 'https://wordpress.org/',
	Version: '1.3',
	Template: '',
	Status: '',
	Tags: 'one-column, two-columns, right-sidebar, accessibility-ready, custom-background, custom-colors, custom-header, custom-menu, editor-style, featured-images, flexible-header, microformats, post-formats, rtl-language-support, sticky-post, threaded-comments, translation-ready, blog',
	TextDomain: 'twentysixteen',
	DomainPath: ''
}