@penskemediacorp/wordpress-scripts NPM

PMC WordPress Scripts

This repository hosts a collection of scripts designed to enhance your experience and efficiency when working with the PMC WordPress site. This package builds upon and extends the capabilities of the official @wordpress/scripts package, providing additional tools and functionalities tailored specifically for the PMC WordPress environment.

Features

Streamlined Workflows: Simplify the process of theme and plugin development with workflows tailored for efficiency.
Automation Scripts: Utilize custom scripts to automate repetitive tasks, saving time and reducing errors.
Enhanced WordPress Scripts: Benefit from enhancements to standard WordPress scripts that offer increased functionality and improved productivity.
TypeScript Support: Incorporate TypeScript into your development with enforced coding standards and type-checking, ensuring cleaner and more robust code.

Installation

Follow these steps to seamlessly incorporate the scripts into your WordPress project:

Install npm: Ensure that npm is installed on your system. If it is not installed, download and install it from the official npm website.
Install the PMC WordPress Scripts Package: Open your terminal, navigate to the root of your project, and execute the following commands:
```
nvm install 20
npm install @penskemediacorp/wordpress-scripts --save-dev
```
Commit Necessary Files: After installation, commit the tsconfig.json, package.json, and package-lock.json files to your project repository.

By following these steps, the scripts will be added to the devDependencies section of your project, enabling their use within your development workflow.

Project Folder Structure

The project main entries files should be placed under src folder.
The generated files will be placed under build folder.

build/ (generated by the build script)
- main-entry1.js
- main-entry1.asset.php
- main-entryX.js
- main-entryX.asset.php
- ...
src/ (individual entry file under this folder will be generated in build folder)
- __tests__/
  - main-entry1.test.ts
  - main-entryX.test.ts
  - ...
- modules/
  - __tests__/
    - module1.test.ts
    - ...
  - module1.ts
  - ...
- folderX/
  - ...
- main-entry1.ts
- main-entryX.ts
- ...