np_wordpress-helper-01

np_wordpress-helper-01 is a utility package designed to automate the process of creating new components in your WordPress theme. It generates a new component with essential files like index.php, style.css, style.scss, and script.js. It also updates the components.php file to include a reference to the newly created component.

Installation

You can install the package via npm:

npm install np_wordpress-helper-01

After installation, the postinstall script will automatically add a new script np_nc to your package.json.

Usage

To create a new component, use the np_nc command followed by the name of the component:

np_nc new-component-name

This will create a new folder inside the components directory with the name of the component and generate necessary files with pre-filled content.

The index.php will contain the necessary enqueuing of the CSS and JS files of the component.

If the components directory does not exist, the script will create it. Also, it will create an components.php file in the components directory.

Updating the functions.php

After creating a new component, it's necessary to add a reference to the components.php file in your functions.php file in your WordPress theme.

You can do this by adding the following line of code to your functions.php:

require_once get_template_directory() . '/components/components.php';

This line of code will import all the component-specific styles and scripts into your WordPress theme.

Please remember, this package works with a specific directory structure and it expects your theme to have a functions.php file at the root level of your theme. If your directory structure is different, you might need to adjust the paths accordingly.

Contribute

You are welcome to contribute to this project. The source code is hosted on GitHub:

https://github.com/npyoni/np_wordpress-component-helper

License

This project is licensed under the ISC license.